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
triSurface
triSurface
geometricSurfacePatch
geometricSurfacePatch.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::geometricSurfacePatch
26
27
Description
28
The geometricSurfacePatch is like patchIdentifier but for surfaces.
29
Holds type, name and index.
30
31
SourceFiles
32
geometricSurfacePatch.C
33
34
\*---------------------------------------------------------------------------*/
35
36
#ifndef geometricSurfacePatch_H
37
#define geometricSurfacePatch_H
38
39
#include <
OpenFOAM/word.H
>
40
#include <
OpenFOAM/label.H
>
41
#include <
OpenFOAM/typeInfo.H
>
42
43
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44
45
namespace
Foam
46
{
47
48
class
dictionary;
49
50
/*---------------------------------------------------------------------------*\
51
Class geometricSurfacePatch Declaration
52
\*---------------------------------------------------------------------------*/
53
54
class
geometricSurfacePatch
55
{
56
// Private data
57
58
//- Type name of patch
59
word
geometricType_;
60
61
//- Name of patch
62
word
name_;
63
64
//- Index of patch in boundary
65
label index_;
66
67
public
:
68
69
//- Runtime type information
70
ClassName
(
"geometricSurfacePatch"
);
71
72
73
// Constructors
74
75
//- Construct null
76
geometricSurfacePatch
();
77
78
//- Construct from components
79
geometricSurfacePatch
80
(
81
const
word
&
geometricType
,
82
const
word
&
name
,
83
const
label
index
84
);
85
86
//- Construct from Istream
87
geometricSurfacePatch
(
Istream
&,
const
label index);
88
89
//- Construct from dictionary
90
geometricSurfacePatch
91
(
92
const
word
& name,
93
const
dictionary
& dict,
94
const
label index
95
);
96
97
98
// Member Functions
99
100
//- Return name
101
const
word
&
name
()
const
102
{
103
return
name_;
104
}
105
106
//- Return name
107
word
&
name
()
108
{
109
return
name_;
110
}
111
112
//- Return the type of the patch
113
const
word
&
geometricType
()
const
114
{
115
return
geometricType_;
116
}
117
118
//- Return the type of the patch
119
word
&
geometricType
()
120
{
121
return
geometricType_;
122
}
123
124
//- Return the index of this patch in the boundaryMesh
125
label
index
()
const
126
{
127
return
index_;
128
}
129
130
//- Return the index of this patch in the boundaryMesh
131
label&
index
()
132
{
133
return
index_;
134
}
135
136
//- Write
137
void
write
(
Ostream
&)
const
;
138
139
//- Write dictionary
140
void
writeDict
(
Ostream
&)
const
;
141
142
143
// Member Operators
144
145
bool
operator!=
(
const
geometricSurfacePatch
&)
const
;
146
147
//- compare.
148
bool
operator==
(
const
geometricSurfacePatch
&)
const
;
149
150
151
// Ostream Operator
152
153
friend
Ostream
&
operator<<
(
Ostream
&,
const
geometricSurfacePatch
&);
154
friend
Istream
&
operator>>
(
Istream
&,
geometricSurfacePatch
&);
155
};
156
157
158
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
159
160
}
// End namespace Foam
161
162
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
163
164
#endif
165
166
// ************************ vim: set sw=4 sts=4 et: ************************ //