Upgrade case file headers
[foam-extend-3.2.git] / applications / utilities / parallelProcessing / reconstructPar / processorMeshes.H
blob40457ea802e62f178a6bb7921d411f17ee5730ba
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | foam-extend: Open Source CFD
4    \\    /   O peration     | Version:     3.2
5     \\  /    A nd           | Web:         http://www.foam-extend.org
6      \\/     M anipulation  | For copyright notice see file Copyright
7 -------------------------------------------------------------------------------
8 License
9     This file is part of foam-extend.
11     foam-extend is free software: you can redistribute it and/or modify it
12     under the terms of the GNU General Public License as published by the
13     Free Software Foundation, either version 3 of the License, or (at your
14     option) any later version.
16     foam-extend is distributed in the hope that it will be useful, but
17     WITHOUT ANY WARRANTY; without even the implied warranty of
18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
19     General Public License for more details.
21     You should have received a copy of the GNU General Public License
22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
24 Class
25     Foam::processorMeshes
27 Description
28     Container for processor mesh addressing.
30 SourceFiles
31     processorMeshes.C
33 \*---------------------------------------------------------------------------*/
35 #ifndef processorMeshes_H
36 #define processorMeshes_H
38 #include "PtrList.H"
39 #include "fvMesh.H"
40 #include "labelIOList.H"
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 namespace Foam
47 /*---------------------------------------------------------------------------*\
48                      Class processorMeshes Declaration
49 \*---------------------------------------------------------------------------*/
51 class processorMeshes
53     // Private data
55         //- Processor databases
56         PtrList<Time>& databases_;
58         const word meshName_;
60         //- List of processor meshes
61         PtrList<fvMesh> meshes_;
63         //- List of processor point addressing lists
64         PtrList<labelIOList> pointProcAddressing_;
66         //- List of processor face addressing lists
67         PtrList<labelIOList> faceProcAddressing_;
69         //- List of processor cell addressing lists
70         PtrList<labelIOList> cellProcAddressing_;
72         //- List of processor boundary addressing lists
73         PtrList<labelIOList> boundaryProcAddressing_;
76     // Private Member Functions
78         //- Disallow default bitwise copy construct
79         processorMeshes(const processorMeshes&);
81         //- Disallow default bitwise assignment
82         void operator=(const processorMeshes&);
85         //- Read all meshes
86         void readMeshes();
88         //- Read addressing
89         void readAddressing();
92 public:
94     // Constructors
96         //- Construct from components
97         processorMeshes(PtrList<Time>& databases, const word& meshName);
100     // Member Functions
102         //- Update the meshes based on the mesh files saved in
103         //  time directories
104         fvMesh::readUpdateState readUpdate();
106         //- Reconstruct point position after motion in parallel
107         void reconstructPoints(fvMesh& mesh);
109         PtrList<fvMesh>& meshes()
110         {
111             return meshes_;
112         }
114         //- Return point-processor addressing arrays
115         const PtrList<labelIOList>& pointProcAddressing() const
116         {
117             return pointProcAddressing_;
118         }
120         //- Return face-processor addressing arrays
121         const PtrList<labelIOList>& faceProcAddressing() const
122         {
123             return faceProcAddressing_;
124         }
126         //- Return cell-processor addressing arrays
127         const PtrList<labelIOList>& cellProcAddressing() const
128         {
129             return cellProcAddressing_;
130         }
132         //- Return boundary-processor addressing arrays
133         const PtrList<labelIOList>& boundaryProcAddressing() const
134         {
135             return boundaryProcAddressing_;
136         }
140 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
142 } // End namespace Foam
144 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
146 #endif
148 // ************************************************************************* //