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-2020 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  //- Disallow copy without setting internal field reference
90 
91  //- Copy constructor setting internal field reference
93  (
96  );
97 
98  //- Construct and return a clone setting internal field reference
100  (
102  ) const = 0;
103 
104 
105  // Member Functions
106 
107  // Attributes
108 
109  //- Return true if the value of the patch field
110  // is altered by assignment
111  virtual bool assignable() const
112  {
113  return true;
114  }
115 
116 
117  // Evaluation functions
118 
119  //- Return gradient at boundary
120  virtual tmp<Field<Type>> snGrad() const = 0;
121 
122  //- Return face-gradient transform diagonal
123  virtual tmp<Field<Type>> snGradTransformDiag() const = 0;
124 
125  //- Return the matrix diagonal coefficients corresponding to the
126  // evaluation of the value of this patchField with given weights
128  (
129  const tmp<scalarField>&
130  ) const;
131 
132  //- Return the matrix source coefficients corresponding to the
133  // evaluation of the value of this patchField with given weights
135  (
136  const tmp<scalarField>&
137  ) const;
138 
139  //- Return the matrix diagonal coefficients corresponding to the
140  // evaluation of the gradient of this patchField
141  virtual tmp<Field<Type>> gradientInternalCoeffs() const;
142 
143  //- Return the matrix source coefficients corresponding to the
144  // evaluation of the gradient of this patchField
145  virtual tmp<Field<Type>> gradientBoundaryCoeffs() const;
146 
147 
148  // Member Operators
149 
150  virtual void operator=(const fvPatchField<Type>&);
151 };
152 
153 
154 // * * * * * * * * * * * Template Specialisations * * * * * * * * * * * * * //
155 
156 template<>
158 (
159  const tmp<scalarField>&
160 ) const;
161 
162 template<>
164 
165 
166 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
167 
168 } // End namespace Foam
169 
170 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
171 
172 #ifdef NoRepository
173  #include "transformFvPatchField.C"
174 #endif
175 
176 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
177 
178 #endif
179 
180 // ************************************************************************* //
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:156
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:62
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 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.
tmp< fvPatchField< Type > > clone() const
Disallow clone without setting internal field reference.
Definition: fvPatchField.H:199
Namespace for OpenFOAM.