transformFvPatchField.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-2016 OpenFOAM Foundation
9 -------------------------------------------------------------------------------
10 License
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 
26 Class
27  Foam::transformFvPatchField
28 
29 Group
30  grpGenericBoundaryConditions
31 
32 Description
33  Foam::transformFvPatchField
34 
35 SourceFiles
36  transformFvPatchField.C
37 
38 \*---------------------------------------------------------------------------*/
39 
40 #ifndef transformFvPatchField_H
41 #define transformFvPatchField_H
42 
43 #include "fvPatchField.H"
44 
45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
46 
47 namespace Foam
48 {
49 
50 /*---------------------------------------------------------------------------*\
51  Class transformFvPatch Declaration
52 \*---------------------------------------------------------------------------*/
53 
54 template<class Type>
56 :
57  public fvPatchField<Type>
58 {
59 
60 public:
61 
62  //- Runtime type information
63  TypeName("transform");
64 
65 
66  // Constructors
67 
68  //- Construct from patch and internal field
70  (
71  const fvPatch&,
73  );
74 
75  //- Construct from patch, internal field and dictionary
77  (
78  const fvPatch&,
80  const dictionary&
81  );
82 
83  //- Construct by mapping the given transformFvPatchField<Type>
84  // onto a new patch
86  (
88  const fvPatch&,
90  const fvPatchFieldMapper&
91  );
92 
93  //- Construct as copy
95  (
97  );
98 
99  //- Construct and return a clone
100  virtual tmp<fvPatchField<Type>> clone() const = 0;
101 
102  //- Construct as copy setting internal field reference
104  (
107  );
108 
109  //- Construct and return a clone setting internal field reference
111  (
113  ) const = 0;
114 
115 
116  // Member functions
117 
118  // Attributes
119 
120  //- Return true if the value of the patch field
121  // is altered by assignment
122  virtual bool assignable() const
123  {
124  return true;
125  }
126 
127 
128  // Evaluation functions
129 
130  //- Return gradient at boundary
131  virtual tmp<Field<Type>> snGrad() const = 0;
132 
133  //- Return face-gradient transform diagonal
134  virtual tmp<Field<Type>> snGradTransformDiag() const = 0;
135 
136  //- Return the matrix diagonal coefficients corresponding to the
137  // evaluation of the value of this patchField with given weights
139  (
140  const tmp<scalarField>&
141  ) const;
142 
143  //- Return the matrix source coefficients corresponding to the
144  // evaluation of the value of this patchField with given weights
146  (
147  const tmp<scalarField>&
148  ) const;
149 
150  //- Return the matrix diagonal coefficients corresponding to the
151  // evaluation of the gradient of this patchField
152  virtual tmp<Field<Type>> gradientInternalCoeffs() const;
153 
154  //- Return the matrix source coefficients corresponding to the
155  // evaluation of the gradient of this patchField
156  virtual tmp<Field<Type>> gradientBoundaryCoeffs() const;
157 
158 
159  // Member operators
160 
161  virtual void operator=(const fvPatchField<Type>&);
162 };
163 
164 
165 // * * * * * * * * * * * Template Specialisations * * * * * * * * * * * * * //
166 
167 template<>
169 (
170  const tmp<scalarField>&
171 ) const;
172 
173 template<>
175 
176 
177 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
178 
179 } // End namespace Foam
180 
181 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
182 
183 #ifdef NoRepository
184  #include "transformFvPatchField.C"
185 #endif
186 
187 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
188 
189 #endif
190 
191 // ************************************************************************* //
Foam::fvPatchField
Abstract base class with a fat-interface to all derived classes covering all possible ways in which t...
Definition: volSurfaceMapping.H:50
Foam::transformFvPatchField::gradientBoundaryCoeffs
virtual tmp< Field< Type > > gradientBoundaryCoeffs() const
Return the matrix source coefficients corresponding to the.
Definition: transformFvPatchField.C:131
transformFvPatchField.C
Foam::tmp
A class for managing temporary objects.
Definition: PtrList.H:59
Foam::transformFvPatchField::gradientInternalCoeffs
virtual tmp< Field< Type > > gradientInternalCoeffs() const
Return the matrix diagonal coefficients corresponding to the.
Definition: transformFvPatchField.C:123
Foam::transformFvPatchField::transformFvPatchField
transformFvPatchField(const fvPatch &, const DimensionedField< Type, volMesh > &)
Construct from patch and internal field.
Definition: transformFvPatchField.C:36
Foam::transformFvPatchField::assignable
virtual bool assignable() const
Return true if the value of the patch field.
Definition: transformFvPatchField.H:121
Foam::fvPatch
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:65
Foam::transformFvPatchField::TypeName
TypeName("transform")
Runtime type information.
Foam::transformFvPatchField::valueBoundaryCoeffs
virtual tmp< Field< Type > > valueBoundaryCoeffs(const tmp< scalarField > &) const
Return the matrix source coefficients corresponding to the.
Definition: transformFvPatchField.C:107
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:121
Foam::transformFvPatchField::operator=
virtual void operator=(const fvPatchField< Type > &)
Definition: transformFvPatchField.C:143
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::transformFvPatchField::clone
virtual tmp< fvPatchField< Type > > clone() const =0
Construct and return a clone.
Foam::transformFvPatchField::snGradTransformDiag
virtual tmp< Field< Type > > snGradTransformDiag() const =0
Return face-gradient transform diagonal.
Foam::transformFvPatchField::snGrad
virtual tmp< Field< Type > > snGrad() const =0
Return gradient at boundary.
Foam::transformFvPatchField
Foam::transformFvPatchField.
Definition: transformFvPatchField.H:54
Foam::transformFvPatchField::valueInternalCoeffs
virtual tmp< Field< Type > > valueInternalCoeffs(const tmp< scalarField > &) const
Return the matrix diagonal coefficients corresponding to the.
Definition: transformFvPatchField.C:96
Foam::fvPatchFieldMapper
Foam::fvPatchFieldMapper.
Definition: fvPatchFieldMapper.H:47
Foam::DimensionedField
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
Definition: DimensionedField.H:54
fvPatchField.H