calculatedFvPatchField.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-2016 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 Group
28  grpGenericBoundaryConditions
29 
30 Description
31  This boundary condition is not designed to be evaluated; it is assmued
32  that the value is assigned via field assignment, and not via a call to
33  e.g. \c updateCoeffs or \c evaluate.
34 
35 Usage
36  Example of the boundary condition specification:
37  \verbatim
38  <patchName>
39  {
40  type calculated;
41  value uniform (0 0 0); // Required value entry
42  }
43  \endverbatim
44 
45 SourceFiles
46  calculatedFvPatchField.C
47 
48 \*---------------------------------------------------------------------------*/
49 
50 #ifndef calculatedFvPatchField_H
51 #define calculatedFvPatchField_H
52 
53 #include "fvPatchField.H"
54 
55 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
56 
57 namespace Foam
58 {
59 
60 /*---------------------------------------------------------------------------*\
61  Class calculatedFvPatchField Declaration
62 \*---------------------------------------------------------------------------*/
63 
64 template<class Type>
66 :
67  public fvPatchField<Type>
68 {
69 
70 public:
71 
72  //- Runtime type information
73  TypeName("calculated");
74 
75 
76  // Constructors
77 
78  //- Construct from patch and internal field
80  (
81  const fvPatch&,
83  );
84 
85  //- Construct from patch, internal field and dictionary
87  (
88  const fvPatch&,
90  const dictionary&,
91  const bool valueRequired=true
92  );
93 
94  //- Construct by mapping given patchField<Type> onto a new patch
96  (
98  const fvPatch&,
100  const fvPatchFieldMapper&
101  );
102 
103  //- Construct as copy
105  (
107  );
108 
109  //- Construct and return a clone
110  virtual tmp<fvPatchField<Type>> clone() const
111  {
112  return tmp<fvPatchField<Type>>
113  (
115  );
116  }
117 
118  //- Construct as copy setting internal field reference
120  (
123  );
124 
125  //- Construct and return a clone setting internal field reference
127  (
129  ) const
130  {
131  return tmp<fvPatchField<Type>>
132  (
133  new calculatedFvPatchField<Type>(*this, iF)
134  );
135  }
136 
137 
138  // Member functions
139 
140  // Attributes
141 
142  //- Return true if this patch field fixes a value.
143  // Needed to check if a level has to be specified while solving
144  // Poissons equations.
145  virtual bool fixesValue() const
146  {
147  return true;
148  }
149 
150 
151  // Evaluation functions
152 
153  //- Return the matrix diagonal coefficients corresponding to the
154  // evaluation of the value of this patchField with given weights
156  (
157  const tmp<scalarField>&
158  ) const;
159 
160  //- Return the matrix source coefficients corresponding to the
161  // evaluation of the value of this patchField with given weights
163  (
164  const tmp<scalarField>&
165  ) const;
166 
167  //- Return the matrix diagonal coefficients corresponding to the
168  // evaluation of the gradient of this patchField
170 
171  //- Return the matrix source coefficients corresponding to the
172  // evaluation of the gradient of this patchField
174 
175 
176  //- Write
177  virtual void write(Ostream&) const;
178 };
179 
180 
181 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
182 
183 } // End namespace Foam
184 
185 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
186 
187 #ifdef NoRepository
188  #include "calculatedFvPatchField.C"
189 #endif
190 
191 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
192 
193 #endif
194 
195 // ************************************************************************* //
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:137
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.