referredWallFace.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2019 OpenFOAM Foundation
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::referredWallFace
26 
27 Description
28  Storage for referred wall faces. Stores patch index, face and
29  associated points
30 
31 SourceFiles
32  referredWallFaceI.H
33  referredWallFace.C
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef referredWallFace_H
38 #define referredWallFace_H
39 
40 #include "face.H"
41 #include "pointField.H"
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 
48 // Forward declaration of classes
49 class Istream;
50 class Ostream;
51 
52 // Forward declaration of friend functions and operators
53 class referredWallFace;
54 Istream& operator>>(Istream&, referredWallFace&);
55 Ostream& operator<<(Ostream&, const referredWallFace&);
56 
57 
58 /*---------------------------------------------------------------------------*\
59  Class referredWallFace Declaration
60 \*---------------------------------------------------------------------------*/
61 
62 class referredWallFace
63 :
64  public face
65 {
66  // Private Data
67 
68  //- Points of face
69  pointField pts_;
70 
71  //- Index of originating patch
72  label patchi_;
73 
74 
75 public:
76 
77  // Constructors
78 
79  //- Construct null
81 
82  //- Construct from components
84  (
85  const face& f,
86  const pointField& pts,
88  );
89 
90 
91  //- Destructor
93 
94 
95  // Member Functions
96 
97  // Access
98 
99  //- Return access to the stored points
100  inline const pointField& points() const;
101 
102  //- Return non-const access to the stored points
103  inline pointField& points();
104 
105  //- Return access to the patch index
106  inline label patchIndex() const;
107 
108  //- Return non-const access to the patch index
109  inline label& patchIndex();
110 
111 
112  // Member Operators
113 
114  bool operator==(const referredWallFace&) const;
115  bool operator!=(const referredWallFace&) const;
116 
117  // IOstream Operators
118 
120  friend Ostream& operator<<(Ostream&, const referredWallFace&);
121 };
122 
123 
124 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
125 
126 } // End namespace Foam
127 
128 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
129 
130 #include "referredWallFaceI.H"
131 
132 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
133 
134 #endif
135 
136 // ************************************************************************* //
referredWallFace()
Construct null.
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
A face is a list of labels corresponding to mesh vertices.
Definition: face.H:75
An Istream is an abstract base class for all input systems (streams, files, token lists etc)...
Definition: Istream.H:57
Storage for referred wall faces. Stores patch index, face and associated points.
~referredWallFace()
Destructor.
bool operator==(const referredWallFace &) const
bool operator!=(const referredWallFace &) const
friend Istream & operator>>(Istream &, referredWallFace &)
Istream & operator>>(Istream &, directionInfo &)
const pointField & points() const
Return access to the stored points.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:53
label patchIndex() const
Return access to the patch index.
labelList f(nPoints)
label patchi
Ostream & operator<<(Ostream &, const ensightPart &)
friend Ostream & operator<<(Ostream &, const referredWallFace &)
Namespace for OpenFOAM.