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