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 | www.openfoam.com
6 \\/ M anipulation |
7-------------------------------------------------------------------------------
8 Copyright (C) 2011-2017 OpenFOAM Foundation
9-------------------------------------------------------------------------------
10License
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
26Class
27 Foam::wedgeFvPatchField
28
29Group
30 grpConstraintBoundaryConditions
31
32Description
33 This boundary condition is similar to the cyclic condition, except that
34 it is applied to 2-D geometries.
35
36Usage
37 Example of the boundary condition specification:
38 \verbatim
39 <patchName>
40 {
41 type wedge;
42 }
43 \endverbatim
44
45See also
46 Foam::cyclicFvPatchField
47
48SourceFiles
49 wedgeFvPatchField.C
50
51\*---------------------------------------------------------------------------*/
52
53#ifndef wedgeFvPatchField_H
54#define wedgeFvPatchField_H
55
57#include "wedgeFvPatch.H"
58
59// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
60
61namespace Foam
62{
63
64/*---------------------------------------------------------------------------*\
65 Class wedgeFvPatchField Declaration
66\*---------------------------------------------------------------------------*/
67
68template<class Type>
70:
71 public transformFvPatchField<Type>
72{
73
74public:
75
76 //- Runtime type information
77 TypeName(wedgeFvPatch::typeName_());
78
79
80 // Constructors
81
82 //- Construct from patch and internal field
84 (
85 const fvPatch&,
87 );
88
89 //- Construct from patch, internal field and dictionary
91 (
92 const fvPatch&,
94 const dictionary&
95 );
96
97 //- Construct by mapping given wedgeFvPatchField onto a new patch
99 (
101 const fvPatch&,
103 const fvPatchFieldMapper&
104 );
105
106 //- Construct as copy
108 (
110 );
111
112 //- Construct and return a clone
113 virtual tmp<fvPatchField<Type>> clone() const
114 {
116 (
117 new wedgeFvPatchField<Type>(*this)
118 );
119 }
120
121 //- Construct as copy setting internal field reference
123 (
126 );
127
128 //- Construct and return a clone setting internal field reference
130 (
132 ) const
133 {
135 (
136 new wedgeFvPatchField<Type>(*this, iF)
137 );
138 }
139
140
141 // Member functions
142
143 //- Return gradient at boundary
144 virtual tmp<Field<Type>> snGrad() const;
145
146 //- Evaluate the patch field
147 virtual void evaluate
148 (
150 );
151
152 //- Return face-gradient transform diagonal
153 virtual tmp<Field<Type>> snGradTransformDiag() const;
154};
155
156
157// * * * * * * * * * * * Template Specialisations * * * * * * * * * * * * * //
158
159template<>
161
162template<>
164(
165 const Pstream::commsTypes commsType
166);
167
168
169// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
170
171} // End namespace Foam
172
173// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
174
175#ifdef NoRepository
176 #include "wedgeFvPatchField.C"
177#endif
178
179// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
180
181#endif
182
183// ************************************************************************* //
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
void evaluate()
Evaluate boundary conditions.
commsTypes
Types of communications.
Definition: UPstream.H:67
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:126
A FieldMapper for finite-volume patch fields.
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:71
A class for managing temporary objects.
Definition: tmp.H:65
Foam::transformFvPatchField.
This boundary condition is similar to the cyclic condition, except that it is applied to 2-D geometri...
TypeName(wedgeFvPatch::typeName_())
Runtime type information.
virtual void evaluate(const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)
Evaluate the patch field.
virtual tmp< Field< Type > > snGrad() const
Return gradient at boundary.
virtual tmp< fvPatchField< Type > > clone() const
Construct and return a clone.
virtual tmp< Field< Type > > snGradTransformDiag() const
Return face-gradient transform diagonal.
virtual tmp< fvPatchField< Type > > clone(const DimensionedField< Type, volMesh > &iF) const
Construct and return a clone setting internal field reference.
Namespace for OpenFOAM.
#define TypeName(TypeNameString)
Declare a ClassName() with extra virtual type info.
Definition: typeInfo.H:73