transformFaPatchField.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) 2016-2017 Wikki Ltd
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::transformFaPatchField
28 
29 Description
30 
31 Author
32  Zeljko Tukovic, FMENA
33  Hrvoje Jasak, Wikki Ltd.
34 
35 SourceFiles
36  transformFaPatchField.C
37 
38 \*---------------------------------------------------------------------------*/
39 
40 #ifndef transformFaPatchField_H
41 #define transformFaPatchField_H
42 
43 #include "faPatchField.H"
44 #include "areaFaMesh.H"
45 
46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
47 
48 namespace Foam
49 {
50 
51 /*---------------------------------------------------------------------------*\
52  Class transformFaPatch Declaration
53 \*---------------------------------------------------------------------------*/
54 
55 template<class Type>
57 :
58  public faPatchField<Type>
59 {
60 
61 public:
62 
63  //- Runtime type information
64  TypeName("transform");
65 
66 
67  // Constructors
68 
69  //- Construct from patch and internal field
71  (
72  const faPatch&,
74  );
75 
76  //- Construct from patch, internal field and dictionary
78  (
79  const faPatch&,
81  const dictionary&
82  );
83 
84  //- Construct by mapping the given transformFaPatchField<Type>
85  // onto a new patch
87  (
89  const faPatch&,
91  const faPatchFieldMapper&
92  );
93 
94  //- Construct and return a clone
95  virtual tmp<faPatchField<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  // Evaluation functions
114 
115  //- Return gradient at boundary
116  virtual tmp<Field<Type>> snGrad() const = 0;
117 
118  //- Return face-gradient transform diagonal
119  virtual tmp<Field<Type>> snGradTransformDiag() const = 0;
120 
121  //- Return the matrix diagonal coefficients corresponding to the
122  // evaluation of the value of this patchField with given weights
124  (
125  const tmp<scalarField>&
126  ) const;
127 
128  //- Return the matrix source coefficients corresponding to the
129  // evaluation of the value of this patchField with given weights
131  (
132  const tmp<scalarField>&
133  ) const;
134 
135  //- Return the matrix diagonal coefficients corresponding to the
136  // evaluation of the gradient of this patchField
137  virtual tmp<Field<Type>> gradientInternalCoeffs() const;
138 
139  //- Return the matrix source coefficients corresponding to the
140  // evaluation of the gradient of this patchField
141  virtual tmp<Field<Type>> gradientBoundaryCoeffs() const;
142 
143 
144  // Member operators
145 
146  virtual void operator=(const faPatchField<Type>&);
147 };
148 
149 
150 // * * * * * * * * * * * Template Specialisations * * * * * * * * * * * * * //
151 
152 template<>
154 
155 
156 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
157 
158 } // End namespace Foam
159 
160 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
161 
162 #ifdef NoRepository
163  #include "transformFaPatchField.C"
164 #endif
165 
166 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
167 
168 #endif
169 
170 // ************************************************************************* //
Foam::transformFaPatchField::gradientBoundaryCoeffs
virtual tmp< Field< Type > > gradientBoundaryCoeffs() const
Return the matrix source coefficients corresponding to the.
Definition: transformFaPatchField.C:120
Foam::faPatchField
faPatchField<Type> abstract base class. This class gives a fat-interface to all derived classes cover...
Definition: areaFieldsFwd.H:50
Foam::tmp
A class for managing temporary objects.
Definition: PtrList.H:59
Foam::transformFaPatchField::gradientInternalCoeffs
virtual tmp< Field< Type > > gradientInternalCoeffs() const
Return the matrix diagonal coefficients corresponding to the.
Definition: transformFaPatchField.C:112
faPatchField.H
Foam::faPatchFieldMapper
Definition: faPatchFieldMapper.H:44
Foam::transformFaPatchField::operator=
virtual void operator=(const faPatchField< Type > &)
Definition: transformFaPatchField.C:132
Foam::transformFaPatchField::TypeName
TypeName("transform")
Runtime type information.
Foam::transformFaPatchField::valueBoundaryCoeffs
virtual tmp< Field< Type > > valueBoundaryCoeffs(const tmp< scalarField > &) const
Return the matrix source coefficients corresponding to the.
Definition: transformFaPatchField.C:96
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:121
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::transformFaPatchField::snGrad
virtual tmp< Field< Type > > snGrad() const =0
Return gradient at boundary.
areaFaMesh.H
Foam::transformFaPatchField::clone
virtual tmp< faPatchField< Type > > clone() const =0
Construct and return a clone.
Foam::transformFaPatchField::snGradTransformDiag
virtual tmp< Field< Type > > snGradTransformDiag() const =0
Return face-gradient transform diagonal.
transformFaPatchField.C
Foam::transformFaPatchField::transformFaPatchField
transformFaPatchField(const faPatch &, const DimensionedField< Type, areaMesh > &)
Construct from patch and internal field.
Definition: transformFaPatchField.C:35
Foam::transformFaPatchField::valueInternalCoeffs
virtual tmp< Field< Type > > valueInternalCoeffs(const tmp< scalarField > &) const
Return the matrix diagonal coefficients corresponding to the.
Definition: transformFaPatchField.C:85
Foam::faPatch
Finite area patch class. Used for 2-D non-Euclidian finite area method.
Definition: faPatch.H:65
Foam::transformFaPatchField
Author Zeljko Tukovic, FMENA Hrvoje Jasak, Wikki Ltd.
Definition: transformFaPatchField.H:55
Foam::DimensionedField
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
Definition: DimensionedField.H:54