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