OpenFOAM
v2406
The open source CFD toolbox
edgeMeshFormatsCore.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) 2011-2017 OpenFOAM Foundation
9
Copyright (C) 2020 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
Class
28
Foam::fileFormats::edgeMeshFormatsCore
29
30
Description
31
A collection of helper functions for reading/writing edge formats.
32
33
SourceFiles
34
edgeMeshFormatsCore.C
35
36
\*---------------------------------------------------------------------------*/
37
38
#ifndef edgeMeshFormatsCore_H
39
#define edgeMeshFormatsCore_H
40
41
#include "
Map.H
"
42
#include "
HashSet.H
"
43
#include "
labelList.H
"
44
45
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
46
47
namespace
Foam
48
{
49
50
// Forward Declarations
51
class
ISstream;
52
class
Time;
53
54
namespace
fileFormats
55
{
56
57
/*---------------------------------------------------------------------------*\
58
Class edgeMeshFormatsCore Declaration
59
\*---------------------------------------------------------------------------*/
60
61
class
edgeMeshFormatsCore
62
{
63
protected
:
64
65
// Protected Member Functions
66
67
//- Read non-comment line
68
static
string
getLineNoComment
(
ISstream
& is,
const
char
comment=
'#'
);
69
70
public
:
71
72
// Static Data
73
74
//- The file extension corresponding to 'native' edge format
75
// Normally "eMesh" (edge-mesh)
76
static
word
nativeExt
;
77
78
79
// Static Member Functions
80
81
//- Verbose checking of fileType in the list of available types
82
static
bool
checkSupport
83
(
84
const
wordHashSet
& available,
85
const
word
& fileType,
86
const
bool
verbose =
false
,
87
const
char
* functionName =
nullptr
88
);
89
90
// //- Return the local file name (within time directory)
91
// // NEEDS FIXING
92
// static fileName localMeshFileName(const word& edgeName="");
93
94
// //- Find instance with edgeName
95
// // NEEDS FIXING
96
// static fileName findMeshInstance
97
// (
98
// const Time&,
99
// const word& edgeName=""
100
// );
101
102
// //- Find mesh file with edgeName
103
// // NEEDS FIXING
104
// static fileName findMeshFile(const Time&, const word& edgeName="");
105
106
107
// Generated Methods
108
109
//- Default construct
110
edgeMeshFormatsCore
() =
default
;
111
112
//- Destructor
113
virtual
~edgeMeshFormatsCore
() =
default
;
114
};
115
116
117
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
118
119
}
// End namespace fileFormats
120
}
// End namespace Foam
121
122
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
123
124
#endif
125
126
// ************************************************************************* //
Foam::HashSet< word, Hash< word > >
HashSet.H
Map.H
Foam::fileFormats::edgeMeshFormatsCore::checkSupport
static bool checkSupport(const wordHashSet &available, const word &fileType, const bool verbose=false, const char *functionName=nullptr)
Verbose checking of fileType in the list of available types.
Definition:
edgeMeshFormatsCore.C:152
Foam::fileFormats::edgeMeshFormatsCore::nativeExt
static word nativeExt
The file extension corresponding to 'native' edge format.
Definition:
edgeMeshFormatsCore.H:76
Foam::fileFormats::edgeMeshFormatsCore::~edgeMeshFormatsCore
virtual ~edgeMeshFormatsCore()=default
Destructor.
labelList.H
Foam::word
A class for handling words, derived from Foam::string.
Definition:
word.H:63
Foam::fileFormats::edgeMeshFormatsCore::getLineNoComment
static string getLineNoComment(ISstream &is, const char comment='#')
Read non-comment line.
Definition:
edgeMeshFormatsCore.C:35
Foam::ISstream
Generic input stream using a standard (STL) stream.
Definition:
ISstream.H:51
Foam::fileFormats::edgeMeshFormatsCore
A collection of helper functions for reading/writing edge formats.
Definition:
edgeMeshFormatsCore.H:56
Foam::fileFormats::edgeMeshFormatsCore::edgeMeshFormatsCore
edgeMeshFormatsCore()=default
Default construct.
Foam
Namespace for OpenFOAM.
Definition:
atmBoundaryLayer.C:26
src
meshTools
edgeMesh
edgeFormats
edgeMeshFormatsCore.H
Generated by
1.8.14