basicSymmetryFvPatchField.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::basicSymmetryFvPatchField
28
29Group
30 grpConstraintBoundaryConditions
31
32Description
33 A symmetry patch
34
35SourceFiles
36 basicSymmetryFvPatchField.C
37
38\*---------------------------------------------------------------------------*/
39
40#ifndef basicSymmetryFvPatchField_H
41#define basicSymmetryFvPatchField_H
42
44#include "symmetryFvPatch.H"
45
46// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
47
48namespace Foam
49{
50
51/*---------------------------------------------------------------------------*\
52 Class basicSymmetryFvPatchField Declaration
53\*---------------------------------------------------------------------------*/
54
55template<class Type>
57:
58 public transformFvPatchField<Type>
59{
60
61public:
62
63 // Constructors
64
65 //- Construct from patch and internal field
67 (
68 const fvPatch&,
70 );
71
72 //- Construct from patch, internal field and dictionary
74 (
75 const fvPatch&,
77 const dictionary&
78 );
79
80 //- Construct by mapping given basicSymmetryFvPatchField onto a new
81 // patch
83 (
85 const fvPatch&,
88 );
89
90 //- Construct as copy
92 (
94 );
95
96 //- Construct and return a clone
97 virtual tmp<fvPatchField<Type>> clone() const
98 {
100 (
102 );
103 }
104
105 //- Construct as copy setting internal field reference
107 (
110 );
111
112 //- Construct and return a clone setting internal field reference
114 (
116 ) const
117 {
119 (
121 );
122 }
123
124
125 // Member functions
126
127 //- Return gradient at boundary
128 virtual tmp<Field<Type>> snGrad() const;
129
130 //- Evaluate the patch field
131 virtual void evaluate
132 (
134 );
135
136 //- Return face-gradient transform diagonal
137 virtual tmp<Field<Type>> snGradTransformDiag() const;
138};
139
140
141// * * * * * * * * * * * Template Specialisations * * * * * * * * * * * * * //
142
143template<>
145
146template<>
148(
149 const Pstream::commsTypes commsType
150);
151
152
153// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
154
155} // End namespace Foam
156
157// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
158
159#ifdef NoRepository
161#endif
162
163// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
164
165#endif
166
167// ************************************************************************* //
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
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.
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.
Namespace for OpenFOAM.