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 | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2013 OpenFOAM Foundation
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 Class
27  Foam::symmetryPlaneFvPatch
28 
29 Description
30  Symmetry-plane patch.
31 
32 SourceFiles
33  symmetryPlaneFvPatch.C
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef symmetryPlaneFvPatch_H
38 #define symmetryPlaneFvPatch_H
39 
40 #include "fvPatch.H"
41 #include "symmetryPlanePolyPatch.H"
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 
48 /*---------------------------------------------------------------------------*\
49  Class symmetryPlaneFvPatch Declaration
50 \*---------------------------------------------------------------------------*/
51 
53 :
54  public fvPatch
55 {
56  // Private data
57 
58  //- Local reference cast into the symmetryPlane patch
59  const symmetryPlanePolyPatch& symmetryPlanePolyPatch_;
60 
61 
62 public:
63 
64  //- Runtime type information
65  TypeName(symmetryPlanePolyPatch::typeName_());
66 
67 
68  // Constructors
69 
70  //- Construct from polyPatch
72  :
73  fvPatch(patch, bm),
74  symmetryPlanePolyPatch_
75  (
77  )
78  {}
79 
80 
81  // Member Functions
82 
83  //- Return symmetry plane normal
84  const vector& n() const
85  {
86  return symmetryPlanePolyPatch_.n();
87  }
88 };
89 
90 
91 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
92 
93 } // End namespace Foam
94 
95 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
96 
97 #endif
98 
99 // ************************************************************************* //
Foam::symmetryPlanePolyPatch::n
const vector & n() const
Return symmetry plane normal.
Definition: symmetryPlanePolyPatch.H:174
Foam::symmetryPlaneFvPatch
Symmetry-plane patch.
Definition: symmetryPlaneFvPatch.H:51
Foam::fvBoundaryMesh
Foam::fvBoundaryMesh.
Definition: fvBoundaryMesh.H:57
Foam::symmetryPlaneFvPatch::symmetryPlaneFvPatch
symmetryPlaneFvPatch(const polyPatch &patch, const fvBoundaryMesh &bm)
Construct from polyPatch.
Definition: symmetryPlaneFvPatch.H:70
Foam::polyPatch
A patch is a list of labels that address the faces in the global face list.
Definition: polyPatch.H:68
Foam::symmetryPlanePolyPatch
Symmetry-plane patch.
Definition: symmetryPlanePolyPatch.H:50
Foam::fvPatch
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:65
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::symmetryPlaneFvPatch::TypeName
TypeName(symmetryPlanePolyPatch::typeName_())
Runtime type information.
Foam::refCast
To & refCast(From &r)
Reference type cast template function.
Definition: typeInfo.H:131
symmetryPlanePolyPatch.H
Foam::Vector< scalar >
Foam::symmetryPlaneFvPatch::n
const vector & n() const
Return symmetry plane normal.
Definition: symmetryPlaneFvPatch.H:83
Foam::fvPatch::patch
const polyPatch & patch() const
Return the polyPatch.
Definition: fvPatch.H:161
fvPatch.H