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