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-2023 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 given file
52 bool checkFileExistence(const fileName& fName);
53 
54 //- Check for availability of specified mesh file (default: "faces")
56 (
57  const Time& runTime,
58  const fileName& meshPath,
59  const word& meshFile = "faces",
60  const bool verbose = true
61 );
62 
63 
64 //- Remove procAddressing
65 void removeProcAddressing(const faMesh& mesh);
66 
67 //- Remove procAddressing
68 void removeProcAddressing(const polyMesh& mesh);
69 
70 //- Determine master faces instance
72 (
73  const IOobject& io,
74  fileName& facesInstance,
75  fileName& pointsInstance
76 );
77 
78 }
79 
80 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
81 
82 #endif
83 
84 // ************************************************************************* //
boolList haveMeshFile(const Time &runTime, const fileName &meshPath, const word &meshFile="faces", const bool verbose=true)
Check for availability of specified mesh file (default: "faces")
engineTime & runTime
dynamicFvMesh & mesh
void masterMeshInstance(const IOobject &io, fileName &facesInstance, fileName &pointsInstance)
Determine master faces instance.
bool checkFileExistence(const fileName &fName)
Check for availability of given file.
void removeProcAddressing(const faMesh &mesh)
Remove procAddressing.
IOobject io("surfaceFilmProperties", mesh.time().constant(), mesh, IOobject::READ_IF_PRESENT, IOobject::NO_WRITE, IOobject::NO_REGISTER)
List< bool > boolList
A List of bools.
Definition: List.H:60
Namespace for OpenFOAM.