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 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 mesh file (default: "faces")
53 (
54  const Time& runTime,
55  const fileName& meshPath,
56  const word& meshFile = "faces",
57  const bool verbose = true
58 );
59 
60 
61 //- Remove procAddressing
62 void removeProcAddressing(const faMesh& mesh);
63 
64 //- Remove procAddressing
65 void removeProcAddressing(const polyMesh& mesh);
66 
67 //- Remove empty directory
68 void removeEmptyDir(const fileName& path);
69 
70 //- Remove empty directories from bottom up
71 void removeEmptyDirs(const fileName& path);
72 
73 }
74 
75 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
76 
77 #endif
78 
79 // ************************************************************************* //
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
void removeEmptyDirs(const fileName &path)
Remove empty directories from bottom up.
dynamicFvMesh & mesh
void removeEmptyDir(const fileName &path)
Remove empty directory.
fileName path(UMean.rootPath()/UMean.caseName()/"graphs"/UMean.instance())
void removeProcAddressing(const faMesh &mesh)
Remove procAddressing.
List< bool > boolList
A List of bools.
Definition: List.H:60
Namespace for OpenFOAM.