edgeMeshFormatsCore.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2024 OpenFOAM Foundation
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8 License
9  This file is part of OpenFOAM.
10 
11  OpenFOAM is free software: you can redistribute it and/or modify it
12  under the terms of the GNU General Public License as published by
13  the Free Software Foundation, either version 3 of the License, or
14  (at your option) any later version.
15 
16  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19  for more details.
20 
21  You should have received a copy of the GNU General Public License
22  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
23 
24 Class
25  Foam::fileFormats::edgeMeshFormatsCore
26 
27 Description
28  A collection of helper functions for reading/writing edge formats.
29 
30 SourceFiles
31  edgeMeshFormatsCore.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef edgeMeshFormatsCore_H
36 #define edgeMeshFormatsCore_H
37 
38 #include "Map.H"
39 #include "HashSet.H"
40 #include "labelList.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 // Forward declaration of classes
48 
49 class IFstream;
50 class Time;
51 
52 namespace fileFormats
53 {
54 
55 /*---------------------------------------------------------------------------*\
56  Class edgeMeshFormatsCore Declaration
57 \*---------------------------------------------------------------------------*/
58 
60 {
61 protected:
62 
63  // Protected Member Functions
64 
65  //- Read non-comment line
66  static string getLineNoComment(IFstream&);
67 
68 
69 public:
70 
71  // Static Data
72 
73  //- The file extension corresponding to 'native' edge format
74  // Normally "eMesh" (edge-mesh)
75  static word nativeExt;
76 
77 
78  // Static Member Functions
79 
80  //- ...
81  static bool checkSupport
82  (
83  const wordHashSet& available,
84  const word& ext,
85  const bool verbose,
86  const word& functionName
87  );
88 };
89 
90 
91 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
92 
93 } // End namespace fileFormats
94 } // End namespace Foam
95 
96 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
97 
98 #endif
99 
100 // ************************************************************************* //
A HashTable with keys but without contents.
Definition: HashSet.H:62
Input from file stream.
Definition: IFstream.H:85
A collection of helper functions for reading/writing edge formats.
static string getLineNoComment(IFstream &)
Read non-comment line.
static word nativeExt
The file extension corresponding to 'native' edge format.
static bool checkSupport(const wordHashSet &available, const word &ext, const bool verbose, const word &functionName)
...
A functionName is a word starting with '#'.
Definition: functionName.H:60
A class for handling words, derived from string.
Definition: word.H:62
Namespace for OpenFOAM.