symmetryPlaneFvPatchField.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) 2013-2023 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::symmetryPlaneFvPatchField
26 
27 Description
28  This boundary condition enforces a symmetryPlane constraint
29 
30 Usage
31  Example of the boundary condition specification:
32  \verbatim
33  <patchName>
34  {
35  type symmetryPlane;
36  }
37  \endverbatim
38 
39 SourceFiles
40  symmetryPlaneFvPatchField.C
41  symmetryPlaneFvPatchFields.C
42  symmetryPlaneFvPatchFields.H
43  symmetryPlaneFvPatchFieldsFwd.H
44 
45 \*---------------------------------------------------------------------------*/
46 
47 #ifndef symmetryPlaneFvPatchField_H
48 #define symmetryPlaneFvPatchField_H
49 
51 #include "symmetryPlaneFvPatch.H"
52 
53 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
54 
55 namespace Foam
56 {
57 
58 /*---------------------------------------------------------------------------*\
59  Class symmetryPlaneFvPatchField Declaration
60 \*---------------------------------------------------------------------------*/
61 
62 template<class Type>
64 :
65  public basicSymmetryFvPatchField<Type>
66 {
67  // Private Data
68 
69  //- Local reference cast into the symmetryPlane patch
70  const symmetryPlaneFvPatch& symmetryPlanePatch_;
71 
72 
73 public:
74 
75  //- Runtime type information
76  TypeName(symmetryPlaneFvPatch::typeName_());
77 
78 
79  // Constructors
80 
81  //- Construct from patch and internal field
83  (
84  const fvPatch&,
86  );
87 
88  //- Construct from patch, internal field and dictionary
90  (
91  const fvPatch&,
93  const dictionary&
94  );
95 
96  //- Construct by mapping given symmetryPlaneFvPatchField
97  // onto a new patch
99  (
101  const fvPatch&,
103  const fieldMapper&
104  );
105 
106  //- Disallow copy without setting internal field reference
108  (
110  ) = delete;
111 
112  //- Copy constructor setting internal field reference
114  (
117  );
118 
119  //- Construct and return a clone setting internal field reference
121  (
123  ) const
124  {
125  return tmp<fvPatchField<Type>>
126  (
127  new symmetryPlaneFvPatchField<Type>(*this, iF)
128  );
129  }
130 
131 
132  // Member Functions
133 
134  //- Return gradient at boundary
135  virtual tmp<Field<Type>> snGrad() const;
136 
137  //- Evaluate the patch field
138  virtual void evaluate
139  (
141  );
142 
143  //- Return face-gradient transform diagonal
144  virtual tmp<Field<Type>> snGradTransformDiag() const;
145 };
146 
147 
148 // * * * * * * * * * * * Template Specialisations * * * * * * * * * * * * * //
149 
150 template<>
152 
153 template<>
155 (
156  const Pstream::commsTypes commsType
157 );
158 
159 
160 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
161 
162 } // End namespace Foam
163 
164 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
165 
166 #ifdef NoRepository
167  #include "symmetryPlaneFvPatchField.C"
168 #endif
169 
170 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
171 
172 #endif
173 
174 // ************************************************************************* //
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
commsTypes
Types of communications.
Definition: UPstream.H:65
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:162
Abstract base class for field mapping.
Definition: fieldMapper.H:48
tmp< fvPatchField< Type > > clone() const
Disallow clone without setting internal field reference.
Definition: fvPatchField.H:204
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:64
This boundary condition enforces a symmetryPlane constraint.
virtual void evaluate(const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)
Evaluate the patch field.
virtual tmp< Field< Type > > snGrad() const
Return gradient at boundary.
symmetryPlaneFvPatchField(const fvPatch &, const DimensionedField< Type, volMesh > &)
Construct from patch and internal field.
TypeName(symmetryPlaneFvPatch::typeName_())
Runtime type information.
virtual tmp< Field< Type > > snGradTransformDiag() const
Return face-gradient transform diagonal.
A class for managing temporary objects.
Definition: tmp.H:55
Namespace for OpenFOAM.