wedgeFvPatchField.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-2012 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::wedgeFvPatchField
26 
27 Group
28  grpConstraintBoundaryConditions
29 
30 Description
31  This boundary condition is similar to the cyclic condition, except that
32  it is applied to 2-D geometries.
33 
34  \heading Patch usage
35 
36  Example of the boundary condition specification:
37  \verbatim
38  myPatch
39  {
40  type wedge;
41  }
42  \endverbatim
43 
44 SeeAlso
45  Foam::cyclicFvPatchField
46 
47 SourceFiles
48  wedgeFvPatchField.C
49 
50 \*---------------------------------------------------------------------------*/
51 
52 #ifndef wedgeFvPatchField_H
53 #define wedgeFvPatchField_H
54 
55 #include "transformFvPatchField.H"
56 #include "wedgeFvPatch.H"
57 
58 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
59 
60 namespace Foam
61 {
62 
63 /*---------------------------------------------------------------------------*\
64  Class wedgeFvPatchField Declaration
65 \*---------------------------------------------------------------------------*/
66 
67 template<class Type>
69 :
70  public transformFvPatchField<Type>
71 {
72 
73 public:
74 
75  //- Runtime type information
76  TypeName(wedgeFvPatch::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 wedgeFvPatchField onto a new patch
98  (
100  const fvPatch&,
102  const fvPatchFieldMapper&
103  );
104 
105  //- Construct as copy
107  (
109  );
110 
111  //- Construct and return a clone
112  virtual tmp<fvPatchField<Type> > clone() const
113  {
114  return tmp<fvPatchField<Type> >
115  (
116  new wedgeFvPatchField<Type>(*this)
117  );
118  }
119 
120  //- Construct as copy setting internal field reference
122  (
125  );
126 
127  //- Construct and return a clone setting internal field reference
129  (
131  ) const
132  {
133  return tmp<fvPatchField<Type> >
134  (
135  new wedgeFvPatchField<Type>(*this, iF)
136  );
137  }
138 
139 
140  // Member functions
141 
142  // Evaluation functions
143 
144  //- Return gradient at boundary
145  virtual tmp<Field<Type> > snGrad() const;
146 
147  //- Evaluate the patch field
148  virtual void evaluate
149  (
150  const Pstream::commsTypes commsType=Pstream::blocking
151  );
152 
153  //- Return face-gradient transform diagonal
154  virtual tmp<Field<Type> > snGradTransformDiag() const;
155 };
156 
157 
158 // * * * * * * * * * * * Template Specialisations * * * * * * * * * * * * * //
159 
160 template<>
162 
163 template<>
165 (
166  const Pstream::commsTypes commsType
167 );
168 
169 
170 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
171 
172 } // End namespace Foam
173 
174 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
175 
176 #ifdef NoRepository
177 # include "wedgeFvPatchField.C"
178 #endif
179 
180 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
181 
182 #endif
183 
184 // ************************************************************************* //
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
virtual tmp< Field< Type > > snGrad() const
Return gradient at boundary.
Foam::fvPatchFieldMapper.
virtual void evaluate(const Pstream::commsTypes commsType=Pstream::blocking)
Evaluate the patch field.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
Namespace for OpenFOAM.
virtual tmp< fvPatchField< Type > > clone() const
Construct and return a clone.
This boundary condition is similar to the cyclic condition, except that it is applied to 2-D geometri...
virtual tmp< Field< Type > > snGradTransformDiag() const
Return face-gradient transform diagonal.
commsTypes
Types of communications.
Definition: UPstream.H:64
wedgeFvPatchField(const fvPatch &, const DimensionedField< Type, volMesh > &)
Construct from patch and internal field.
Foam::transformFvPatchField.
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:61
A class for managing temporary objects.
Definition: PtrList.H:118
TypeName(wedgeFvPatch::typeName_())
Runtime type information.