All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
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-2018 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 public:
69 
70  // Static Data
71 
72  //- The file extension corresponding to 'native' edge format
73  // Normally "eMesh" (edge-mesh)
74  static word nativeExt;
75 
76  // Static Member Functions
77 
78  static bool checkSupport
79  (
80  const wordHashSet& available,
81  const word& ext,
82  const bool verbose,
83  const word& functionName
84  );
85 
86  // //- Return the local file name (within time directory)
87  // // NEEDS FIXING
88  // static fileName localMeshFileName(const word& edgeName="");
89 
90  // //- Find instance with edgeName
91  // // NEEDS FIXING
92  // static fileName findMeshInstance
93  // (
94  // const Time&,
95  // const word& edgeName=""
96  // );
97 
98  // //- Find mesh file with edgeName
99  // // NEEDS FIXING
100  // static fileName findMeshFile(const Time&, const word& edgeName="");
101 
102 
103  // Constructors
104 
105  //- Construct null
107 
108 
109  //- Destructor
110  virtual ~edgeMeshFormatsCore();
111 
112 };
113 
114 
115 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
116 
117 } // End namespace fileFormats
118 } // End namespace Foam
119 
120 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
121 
122 #endif
123 
124 // ************************************************************************* //
A HashTable with keys but without contents.
Definition: HashSet.H:59
static word nativeExt
The file extension corresponding to &#39;native&#39; edge format.
static string getLineNoComment(IFstream &)
Read non-comment line.
A functionName is a word starting with &#39;#&#39;.
Definition: functionName.H:57
A class for handling words, derived from string.
Definition: word.H:59
Input from file stream.
Definition: IFstream.H:81
A collection of helper functions for reading/writing edge formats.
static bool checkSupport(const wordHashSet &available, const word &ext, const bool verbose, const word &functionName)
Namespace for OpenFOAM.