symmetryPlaneFvPatch.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) 2013 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::symmetryPlaneFvPatch
26 
27 Description
28  Symmetry-plane patch.
29 
30 SourceFiles
31  symmetryPlaneFvPatch.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef symmetryPlaneFvPatch_H
36 #define symmetryPlaneFvPatch_H
37 
38 #include "fvPatch.H"
39 #include "symmetryPlanePolyPatch.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class symmetryPlaneFvPatch Declaration
48 \*---------------------------------------------------------------------------*/
49 
51 :
52  public fvPatch
53 {
54  // Private data
55 
56  //- Local reference cast into the symmetryPlane patch
57  const symmetryPlanePolyPatch& symmetryPlanePolyPatch_;
58 
59 
60 public:
61 
62  //- Runtime type information
63  TypeName(symmetryPlanePolyPatch::typeName_());
64 
65 
66  // Constructors
67 
68  //- Construct from polyPatch
70  :
71  fvPatch(patch, bm),
72  symmetryPlanePolyPatch_
73  (
74  refCast<const symmetryPlanePolyPatch>(patch)
75  )
76  {}
77 
78 
79  // Member Functions
80 
81  //- Return symmetry plane normal
82  const vector& n() const
83  {
84  return symmetryPlanePolyPatch_.n();
85  }
86 };
87 
88 
89 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
90 
91 } // End namespace Foam
92 
93 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
94 
95 #endif
96 
97 // ************************************************************************* //
Symmetry-plane patch.
const vector & n() const
Return symmetry plane normal.
To & refCast(From &r)
Reference type cast template function.
Definition: typeInfo.H:106
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:61
symmetryPlaneFvPatch(const polyPatch &patch, const fvBoundaryMesh &bm)
Construct from polyPatch.
TypeName(symmetryPlanePolyPatch::typeName_())
Runtime type information.
const polyPatch & patch() const
Return the polyPatch.
Definition: fvPatch.H:143
const vector & n() const
Return symmetry plane normal.
Foam::fvBoundaryMesh.
A patch is a list of labels that address the faces in the global face list.
Definition: polyPatch.H:66
Namespace for OpenFOAM.