loadOrCreateMesh.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2012 OpenFOAM Foundation
9  Copyright (C) 2022-2026 OpenCFD Ltd.
10 -------------------------------------------------------------------------------
11 License
12  This file is part of OpenFOAM.
13 
14  OpenFOAM is free software: you can redistribute it and/or modify it
15  under the terms of the GNU General Public License as published by
16  the Free Software Foundation, either version 3 of the License, or
17  (at your option) any later version.
18 
19  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
20  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
21  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22  for more details.
23 
24  You should have received a copy of the GNU General Public License
25  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
26 
27 InNamespace
28  Foam
29 
30 Description
31  Miscellaneous file handling for meshes.
32 
33 SourceFiles
34  loadOrCreateMesh.C
35 
36 \*---------------------------------------------------------------------------*/
37 
38 #ifndef Foam_loadOrCreateMesh_H
39 #define Foam_loadOrCreateMesh_H
40 
41 #include "fvMeshTools.H"
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 
48 // Forward Declarations
49 class faMesh;
50 
51 //- Check for availability of specified file (on all ranks)
52 bitSet haveProcessorFile
53 (
54  const word& name, // eg, "faces"
55  const fileName& instance, // eg, "constant"
56  const fileName& local, // eg, "polyMesh"
57  const Time& runTime,
58  const bool verbose = true
59 );
60 
61 //- Check for availability of specified file (on all ranks)
63 (
64  const word& name, // eg, "faces"
65  const fileName& instance, // eg, "constant"
66  const fileName& local, // eg, "polyMesh"
67  const Time& runTime,
68  const bool verbose = true
69 );
70 
71 //- Check for availability of specified mesh file
73 (
74  const Time& runTime,
75  const fileName& meshPath,
76  const word& meshFile,
77  const bool verbose = true
78 );
79 
80 
81 //- Remove procAddressing
82 void removeProcAddressing(const faMesh& mesh);
83 
84 //- Remove procAddressing
85 void removeProcAddressing(const polyMesh& mesh);
86 
87 //- Determine master faces instance
89 (
90  const IOobject& io,
91  fileName& facesInstance,
92  fileName& pointsInstance
93 );
94 
95 } // End namespace Foam
96 
97 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
98 
99 #endif
100 
101 // ************************************************************************* //
boolList haveMeshFile(const word &name, const fileName &instance, const fileName &local, const Time &runTime, const bool verbose=true)
Check for availability of specified file (on all ranks)
engineTime & runTime
dynamicFvMesh & mesh
word name(const expressions::valueTypeCode typeCode)
A word representation of a valueTypeCode. Empty for expressions::valueTypeCode::INVALID.
Definition: exprTraits.C:127
void masterMeshInstance(const IOobject &io, fileName &facesInstance, fileName &pointsInstance)
Determine master faces instance.
const auto & io
bool local
Definition: EEqn.H:20
bitSet haveProcessorFile(const word &name, const fileName &instance, const fileName &local, const Time &runTime, const bool verbose=true)
Check for availability of specified file (on all ranks)
void removeProcAddressing(const faMesh &mesh)
Remove procAddressing.
List< bool > boolList
A List of bools.
Definition: List.H:59
Namespace for OpenFOAM.