calculatedFvPatchField.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-2019 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::calculatedFvPatchField
26 
27 Description
28  This boundary condition is not designed to be evaluated; it is assmued
29  that the value is assigned via field assignment, and not via a call to
30  e.g. \c updateCoeffs or \c evaluate.
31 
32 Usage
33  Example of the boundary condition specification:
34  \verbatim
35  <patchName>
36  {
37  type calculated;
38  value uniform (0 0 0); // Required value entry
39  }
40  \endverbatim
41 
42 SourceFiles
43  calculatedFvPatchField.C
44 
45 \*---------------------------------------------------------------------------*/
46 
47 #ifndef calculatedFvPatchField_H
48 #define calculatedFvPatchField_H
49 
50 #include "fvPatchField.H"
51 
52 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
53 
54 namespace Foam
55 {
56 
57 /*---------------------------------------------------------------------------*\
58  Class calculatedFvPatchField Declaration
59 \*---------------------------------------------------------------------------*/
60 
61 template<class Type>
63 :
64  public fvPatchField<Type>
65 {
66 
67 public:
68 
69  //- Runtime type information
70  TypeName("calculated");
71 
72 
73  // Constructors
74 
75  //- Construct from patch and internal field
77  (
78  const fvPatch&,
80  );
81 
82  //- Construct from patch, internal field and dictionary
84  (
85  const fvPatch&,
87  const dictionary&,
88  const bool valueRequired=true
89  );
90 
91  //- Construct by mapping given patchField<Type> onto a new patch
93  (
95  const fvPatch&,
97  const fvPatchFieldMapper&,
98  const bool mappingRequired=true
99  );
100 
101  //- Copy constructor
103  (
105  );
106 
107  //- Construct and return a clone
108  virtual tmp<fvPatchField<Type>> clone() const
109  {
110  return tmp<fvPatchField<Type>>
111  (
113  );
114  }
115 
116  //- Copy constructor setting internal field reference
118  (
121  );
122 
123  //- Construct and return a clone setting internal field reference
125  (
127  ) const
128  {
129  return tmp<fvPatchField<Type>>
130  (
131  new calculatedFvPatchField<Type>(*this, iF)
132  );
133  }
134 
135 
136  // Member Functions
137 
138  // Attributes
139 
140  //- Return true if this patch field fixes a value.
141  // Needed to check if a level has to be specified while solving
142  // Poissons equations.
143  virtual bool fixesValue() const
144  {
145  return true;
146  }
147 
148 
149  // Evaluation functions
150 
151  //- Return the matrix diagonal coefficients corresponding to the
152  // evaluation of the value of this patchField with given weights
154  (
155  const tmp<scalarField>&
156  ) const;
157 
158  //- Return the matrix source coefficients corresponding to the
159  // evaluation of the value of this patchField with given weights
161  (
162  const tmp<scalarField>&
163  ) const;
164 
165  //- Return the matrix diagonal coefficients corresponding to the
166  // evaluation of the gradient of this patchField
168 
169  //- Return the matrix source coefficients corresponding to the
170  // evaluation of the gradient of this patchField
172 
173 
174  //- Write
175  virtual void write(Ostream&) const;
176 };
177 
178 
179 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
180 
181 } // End namespace Foam
182 
183 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
184 
185 #ifdef NoRepository
186  #include "calculatedFvPatchField.C"
187 #endif
188 
189 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
190 
191 #endif
192 
193 // ************************************************************************* //
virtual tmp< Field< Type > > valueInternalCoeffs(const tmp< scalarField > &) const
Return the matrix diagonal coefficients corresponding to the.
tmp< Field< Type > > gradientInternalCoeffs() const
Return the matrix diagonal coefficients corresponding to the.
TypeName("calculated")
Runtime type information.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:158
virtual bool fixesValue() const
Return true if this patch field fixes a value.
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 void write(Ostream &) const
Write.
tmp< Field< Type > > gradientBoundaryCoeffs() const
Return the matrix source coefficients corresponding to the.
Foam::fvPatchFieldMapper.
virtual tmp< fvPatchField< Type > > clone() const
Construct and return a clone.
This boundary condition is not designed to be evaluated; it is assmued that the value is assigned via...
virtual tmp< Field< Type > > valueBoundaryCoeffs(const tmp< scalarField > &) const
Return the matrix source coefficients corresponding to the.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:53
calculatedFvPatchField(const fvPatch &, const DimensionedField< Type, volMesh > &)
Construct from patch and internal field.
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
Namespace for OpenFOAM.