OpenFOAM: API Guide
v1912
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
-------------------------------------------------------------------------------
10
License
11
This file is part of OpenFOAM.
12
13
OpenFOAM is free software: you can redistribute it and/or modify it
14
under the terms of the GNU General Public License as published by
15
the Free Software Foundation, either version 3 of the License, or
16
(at your option) any later version.
17
18
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21
for more details.
22
23
You should have received a copy of the GNU General Public License
24
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25
26
Class
27
Foam::fileFormats::edgeMeshFormatsCore
28
29
Description
30
A collection of helper functions for reading/writing edge formats.
31
32
SourceFiles
33
edgeMeshFormatsCore.C
34
35
\*---------------------------------------------------------------------------*/
36
37
#ifndef edgeMeshFormatsCore_H
38
#define edgeMeshFormatsCore_H
39
40
#include "
Map.H
"
41
#include "
HashSet.H
"
42
#include "
labelList.H
"
43
44
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45
46
namespace
Foam
47
{
48
49
// Forward declaration of classes
50
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
// Static Member Functions
79
80
static
bool
checkSupport
81
(
82
const
wordHashSet
& available,
83
const
word
& ext,
84
const
bool
verbose,
85
const
word
& functionName
86
);
87
88
// //- Return the local file name (within time directory)
89
// // NEEDS FIXING
90
// static fileName localMeshFileName(const word& edgeName="");
91
92
// //- Find instance with edgeName
93
// // NEEDS FIXING
94
// static fileName findMeshInstance
95
// (
96
// const Time&,
97
// const word& edgeName=""
98
// );
99
100
// //- Find mesh file with edgeName
101
// // NEEDS FIXING
102
// static fileName findMeshFile(const Time&, const word& edgeName="");
103
104
105
// Constructors
106
107
//- Construct null
108
edgeMeshFormatsCore
() =
default
;
109
110
111
//- Destructor
112
virtual
~edgeMeshFormatsCore
() =
default
;
113
114
};
115
116
117
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
118
119
}
// End namespace fileFormats
120
}
// End namespace Foam
121
122
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
123
124
#endif
125
126
// ************************************************************************* //
Foam::fileFormats::edgeMeshFormatsCore::edgeMeshFormatsCore
edgeMeshFormatsCore()=default
Construct null.
Foam::word
A class for handling words, derived from Foam::string.
Definition:
word.H:62
Foam::ISstream
Generic input stream using standard (STL) streams.
Definition:
ISstream.H:54
Foam::fileFormats::edgeMeshFormatsCore::getLineNoComment
static string getLineNoComment(ISstream &is, const char comment='#')
Read non-comment line.
Definition:
edgeMeshFormatsCore.C:42
Foam::HashSet< word >
Map.H
labelList.H
Foam::fileFormats::edgeMeshFormatsCore::~edgeMeshFormatsCore
virtual ~edgeMeshFormatsCore()=default
Destructor.
HashSet.H
Foam
Namespace for OpenFOAM.
Definition:
atmBoundaryLayer.C:33
Foam::fileFormats::edgeMeshFormatsCore::nativeExt
static word nativeExt
The file extension corresponding to 'native' edge format.
Definition:
edgeMeshFormatsCore.H:75
Foam::fileFormats::edgeMeshFormatsCore::checkSupport
static bool checkSupport(const wordHashSet &available, const word &ext, const bool verbose, const word &functionName)
Definition:
edgeMeshFormatsCore.C:159
Foam::fileFormats::edgeMeshFormatsCore
A collection of helper functions for reading/writing edge formats.
Definition:
edgeMeshFormatsCore.H:60
src
meshTools
edgeMesh
edgeMeshFormats
edgeMeshFormatsCore.H
Generated by
1.8.17
OPENFOAM® is a registered
trademark
of OpenCFD Ltd.