emptyFvPatch.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) 2011 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::emptyFvPatch
26 
27 Description
28  A patch which will not exist in the fvMesh. Typical example is a front and
29  back plane of a 2-D geometry
30 
31 SourceFiles
32  emptyFvPatch.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef emptyFvPatch_H
37 #define emptyFvPatch_H
38 
39 #include "fvPatch.H"
40 #include "emptyPolyPatch.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class emptyFvPatch Declaration
49 \*---------------------------------------------------------------------------*/
50 
51 class emptyFvPatch
52 :
53  public fvPatch
54 {
55  // Private data
56 
57  //- face-cell addressing
58  const labelList::subList faceCells_;
59 
60 
61 public:
62 
63  //- Runtime type information
64  TypeName(emptyPolyPatch::typeName_());
65 
66 
67  // Constructors
68 
69  //- Construct from polyPatch
70  emptyFvPatch(const polyPatch& patch, const fvBoundaryMesh& bm);
71 
72 
73  // Member Functions
74 
75  // Access
76 
77  virtual label size() const
78  {
79  return 0;
80  }
81 
82  //- Return faceCells
83  virtual const labelUList& faceCells() const;
84 };
85 
86 
87 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
88 
89 } // End namespace Foam
90 
91 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
92 
93 #endif
94 
95 // ************************************************************************* //
emptyFvPatch(const polyPatch &patch, const fvBoundaryMesh &bm)
Construct from polyPatch.
Definition: emptyFvPatch.C:44
Foam::fvBoundaryMesh.
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 patch which will not exist in the fvMesh. Typical example is a front and back plane of a 2-D geomet...
Definition: emptyFvPatch.H:50
virtual const labelUList & faceCells() const
Return faceCells.
Definition: emptyFvPatch.C:59
Namespace for OpenFOAM.
A patch is a list of labels that address the faces in the global face list.
Definition: polyPatch.H:66
const polyPatch & patch() const
Return the polyPatch.
Definition: fvPatch.H:143
virtual label size() const
Return size.
Definition: emptyFvPatch.H:76
A 1D vector of objects of type <T>, where the size of the vector is known and can be used for subscri...
Definition: HashTable.H:60
TypeName(emptyPolyPatch::typeName_())
Runtime type information.
A List obtained as a section of another List.
Definition: SubList.H:53
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:61