Home
Downloads
Documentation
Installation
User Guide
man-pages
API Documentation
README
Release Notes
Changes
License
Support
SourceForge Project
Main Page
Related Pages
Namespaces
Classes
Files
File List
File Members
All
Classes
Namespaces
Files
Functions
Variables
Typedefs
Enumerations
Enumerator
Friends
Macros
Pages
src
surfMesh
surfaceFormats
surfaceFormatsCore.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 | Copyright (C) 1991-2010 OpenCFD Ltd.
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::surfaceFormatsCore
26
27
Description
28
A collection of helper functions for reading/writing surface formats.
29
30
SourceFiles
31
surfaceFormatsCore.C
32
33
\*---------------------------------------------------------------------------*/
34
35
#ifndef surfaceFormatsCore_H
36
#define surfaceFormatsCore_H
37
38
#include <
OpenFOAM/Map.H
>
39
#include <
OpenFOAM/HashSet.H
>
40
#include <
OpenFOAM/labelList.H
>
41
#include <
surfMesh/surfZoneList.H
>
42
#include <
surfMesh/surfZoneIdentifierList.H
>
43
44
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45
46
namespace
Foam
47
{
48
49
// Forward declaration of friend functions and operators
50
51
class
IFstream;
52
class
Time;
53
54
namespace
fileFormats
55
{
56
57
/*---------------------------------------------------------------------------*\
58
Class surfaceFormatsCore Declaration
59
\*---------------------------------------------------------------------------*/
60
61
class
surfaceFormatsCore
62
{
63
protected
:
64
65
//- Return a list with a single entry,
66
// the size corresponds to that of the container
67
template
<
class
Container>
68
static
List<surfZone>
oneZone
69
(
70
const
Container& container,
71
const
word
&
name
=
"zone0"
72
)
73
{
74
return
List<surfZone>
(1,
surfZone
(
name
, container.size(), 0, 0));
75
}
76
77
//- Read non-comment line
78
static
string
getLineNoComment
(
IFstream
&);
79
80
81
public
:
82
83
// Static Data
84
85
//- The file extension corresponding to 'native' surface format
86
// Normally "ofs" (mnemonic: OF = OpenFOAM, S = Surface)
87
static
word
nativeExt
;
88
89
90
// Static Member Functions
91
92
static
bool
checkSupport
93
(
94
const
wordHashSet
& available,
95
const
word
& ext,
96
const
bool
verbose,
97
const
word
& functionName
98
);
99
100
//- Return the local file name (within time directory)
101
// NEEDS FIXING
102
static
fileName
localMeshFileName
(
const
word
& surfName=
""
);
103
104
//- Find instance with surfName
105
// NEEDS FIXING
106
static
fileName
findMeshInstance
(
const
Time
&,
const
word
& surfName=
""
);
107
108
//- Find mesh file with surfName
109
// NEEDS FIXING
110
static
fileName
findMeshFile
(
const
Time
&,
const
word
& surfName=
""
);
111
112
113
// Constructors
114
115
//- Construct null
116
surfaceFormatsCore
();
117
118
119
// Destructor
120
121
virtual
~surfaceFormatsCore
();
122
};
123
124
125
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
126
127
}
// End namespace fileFormats
128
}
// End namespace Foam
129
130
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
131
132
#endif
133
134
// ************************ vim: set sw=4 sts=4 et: ************************ //