referredWallFace.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-2016 OpenFOAM Foundation
9 Copyright (C) 2020 OpenCFD Ltd.
10-------------------------------------------------------------------------------
11License
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
27Class
28 Foam::referredWallFace
29
30Description
31 Storage for referred wall faces. Stores patch index, face and
32 associated points
33
34SourceFiles
35 referredWallFaceI.H
36 referredWallFace.C
37
38\*---------------------------------------------------------------------------*/
39
40#ifndef referredWallFace_H
41#define referredWallFace_H
42
43#include "face.H"
44#include "pointField.H"
45
46// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
47
48namespace Foam
49{
50
51// Forward Declarations
52class referredWallFace;
53Istream& operator>>(Istream&, referredWallFace&);
54Ostream& operator<<(Ostream&, const referredWallFace&);
55
56/*---------------------------------------------------------------------------*\
57 Class referredWallFace Declaration
58\*---------------------------------------------------------------------------*/
61:
62 public face
63{
64 // Private Data
65
66 //- Points of face
67 pointField pts_;
68
69 //- Index of originating patch
70 label patchi_;
71
72
73public:
74
75 // Generated Methods
76
77 //- Default construct
78 referredWallFace() = default;
79
80
81 // Constructors
82
83 //- Construct from components
85 (
86 const face& f,
87 const pointField& pts,
88 label patchi
89 );
90
91
92 // Member Functions
93
94 // Access
95
96 //- Return access to the stored points
97 inline const pointField& points() const;
98
99 //- Return non-const access to the stored points
100 inline pointField& points();
101
102 //- Return access to the patch index
103 inline label patchIndex() const;
104
105 //- Return non-const access to the patch index
106 inline label& patchIndex();
107
108
109 // Member Operators
110
111 bool operator==(const referredWallFace&) const;
112 bool operator!=(const referredWallFace&) const;
113
114
115 // IOstream Operators
118 friend Ostream& operator<<(Ostream&, const referredWallFace&);
119};
120
121
122// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
123
124} // End namespace Foam
125
126// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
127
128#include "referredWallFaceI.H"
129
130// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
131
132#endif
133
134// ************************************************************************* //
An Istream is an abstract base class for all input systems (streams, files, token lists etc)....
Definition: Istream.H:64
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:62
A face is a list of labels corresponding to mesh vertices.
Definition: face.H:75
Storage for referred wall faces. Stores patch index, face and associated points.
label patchIndex() const
Return access to the patch index.
friend Istream & operator>>(Istream &, referredWallFace &)
bool operator!=(const referredWallFace &) const
friend Ostream & operator<<(Ostream &, const referredWallFace &)
bool operator==(const referredWallFace &) const
const pointField & points() const
Return access to the stored points.
referredWallFace()=default
Default construct.
Namespace for OpenFOAM.
Ostream & operator<<(Ostream &, const boundaryPatch &p)
Write boundaryPatch as dictionary entries (without surrounding braces)
Definition: boundaryPatch.C:83
Istream & operator>>(Istream &, directionInfo &)
labelList f(nPoints)