basicSymmetryFvPatchField.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-2018 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::basicSymmetryFvPatchField
26 
27 Description
28  A symmetry patch
29 
30 SourceFiles
31  basicSymmetryFvPatchField.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef basicSymmetryFvPatchField_H
36 #define basicSymmetryFvPatchField_H
37 
38 #include "transformFvPatchField.H"
39 #include "symmetryFvPatch.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class basicSymmetryFvPatchField Declaration
48 \*---------------------------------------------------------------------------*/
49 
50 template<class Type>
52 :
53  public transformFvPatchField<Type>
54 {
55 
56 public:
57 
58  // Constructors
59 
60  //- Construct from patch and internal field
62  (
63  const fvPatch&,
65  );
66 
67  //- Construct from patch, internal field and dictionary
69  (
70  const fvPatch&,
72  const dictionary&
73  );
74 
75  //- Construct by mapping given basicSymmetryFvPatchField onto a new
76  // patch
78  (
80  const fvPatch&,
82  const fvPatchFieldMapper&
83  );
84 
85  //- Construct as copy
87  (
89  );
90 
91  //- Construct and return a clone
92  virtual tmp<fvPatchField<Type>> clone() const
93  {
95  (
97  );
98  }
99 
100  //- Construct as copy setting internal field reference
102  (
105  );
106 
107  //- Construct and return a clone setting internal field reference
109  (
111  ) const
112  {
113  return tmp<fvPatchField<Type>>
114  (
115  new basicSymmetryFvPatchField<Type>(*this, iF)
116  );
117  }
118 
119 
120  // Member functions
121 
122  //- Return gradient at boundary
123  virtual tmp<Field<Type>> snGrad() const;
124 
125  //- Evaluate the patch field
126  virtual void evaluate
127  (
129  );
130 
131  //- Return face-gradient transform diagonal
132  virtual tmp<Field<Type>> snGradTransformDiag() const;
133 };
134 
135 
136 // * * * * * * * * * * * Template Specialisations * * * * * * * * * * * * * //
137 
138 template<>
140 
141 template<>
143 (
144  const Pstream::commsTypes commsType
145 );
146 
147 
148 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
149 
150 } // End namespace Foam
151 
152 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
153 
154 #ifdef NoRepository
155  #include "basicSymmetryFvPatchField.C"
156 #endif
157 
158 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
159 
160 #endif
161 
162 // ************************************************************************* //
virtual tmp< fvPatchField< Type > > clone() const
Construct and return a clone.
virtual tmp< Field< Type > > snGrad() const
Return gradient at boundary.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
commsTypes
Types of communications.
Definition: UPstream.H:64
virtual tmp< Field< Type > > snGradTransformDiag() const
Return face-gradient transform diagonal.
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:61
Foam::fvPatchFieldMapper.
Foam::transformFvPatchField.
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
A class for managing temporary objects.
Definition: PtrList.H:53
virtual void evaluate(const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)
Evaluate the patch field.
Namespace for OpenFOAM.
basicSymmetryFvPatchField(const fvPatch &, const DimensionedField< Type, volMesh > &)
Construct from patch and internal field.