calculatedFvPatchField.C
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 \*---------------------------------------------------------------------------*/
25 
26 #include "calculatedFvPatchField.H"
27 #include "fvPatchFieldMapper.H"
28 
29 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
30 
31 template<class Type>
33 {
35 }
36 
37 
38 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
39 
40 template<class Type>
42 (
43  const fvPatch& p,
45 )
46 :
48 {}
49 
50 
51 template<class Type>
53 (
54  const fvPatch& p,
56  const dictionary& dict,
57  const bool valueRequired
58 )
59 :
60  fvPatchField<Type>(p, iF, dict, valueRequired)
61 {}
62 
63 
64 template<class Type>
66 (
68  const fvPatch& p,
70  const fvPatchFieldMapper& mapper,
71  const bool mappingRequired
72 )
73 :
74  fvPatchField<Type>(ptf, p, iF, mapper, mappingRequired)
75 {}
76 
77 
78 template<class Type>
80 (
83 )
84 :
85  fvPatchField<Type>(ptf, iF)
86 {}
87 
88 
89 template<class Type>
92 (
93  const fvPatch& p
94 )
95 {
96  typename patchConstructorTable::iterator patchTypeCstrIter =
97  patchConstructorTablePtr_->find(p.type());
98 
99  if (patchTypeCstrIter != patchConstructorTablePtr_->end())
100  {
101  return patchTypeCstrIter()
102  (
103  p,
105  );
106  }
107  else
108  {
109  return tmp<fvPatchField<Type>>
110  (
112  (
113  p,
115  )
116  );
117  }
118 }
119 
120 
121 template<class Type>
122 template<class Type2>
124 (
125  const fvPatchField<Type2>& pf
126 )
127 {
128  return NewCalculatedType(pf.patch());
129 }
130 
131 
132 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
133 
134 template<class Type>
137 (
138  const tmp<scalarField>&
139 ) const
140 {
142  << "cannot be called for a calculatedFvPatchField"
143  << "\n on patch " << this->patch().name()
144  << " of field " << this->internalField().name()
145  << " in file " << this->internalField().objectPath()
146  << "\n You are probably trying to solve for a field with a "
147  "default boundary condition."
148  << abort(FatalError);
149 
150  return *this;
151 }
152 
153 
154 template<class Type>
157 (
158  const tmp<scalarField>&
159 ) const
160 {
162  << "cannot be called for a calculatedFvPatchField"
163  << "\n on patch " << this->patch().name()
164  << " of field " << this->internalField().name()
165  << " in file " << this->internalField().objectPath()
166  << "\n You are probably trying to solve for a field with a "
167  "default boundary condition."
168  << abort(FatalError);
169 
170  return *this;
171 }
172 
173 
174 template<class Type>
177 {
179  << "cannot be called for a calculatedFvPatchField"
180  << "\n on patch " << this->patch().name()
181  << " of field " << this->internalField().name()
182  << " in file " << this->internalField().objectPath()
183  << "\n You are probably trying to solve for a field with a "
184  "default boundary condition."
185  << abort(FatalError);
186 
187  return *this;
188 }
189 
190 
191 template<class Type>
194 {
196  << "cannot be called for a calculatedFvPatchField"
197  << "\n on patch " << this->patch().name()
198  << " of field " << this->internalField().name()
199  << " in file " << this->internalField().objectPath()
200  << "\n You are probably trying to solve for a field with a "
201  "default boundary condition."
202  << abort(FatalError);
203 
204  return *this;
205 }
206 
207 
208 template<class Type>
210 {
212  writeEntry(os, "value", *this);
213 }
214 
215 
216 // ************************************************************************* //
dictionary dict
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.
error FatalError
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
#define FatalErrorInFunction
Report an error message using Foam::FatalError.
Definition: error.H:323
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 void write(Ostream &) const
Write.
tmp< Field< Type > > gradientBoundaryCoeffs() const
Return the matrix source coefficients corresponding to the.
static const word & calculatedType()
Return the type of the calculated for of fvPatchField.
A class for handling words, derived from string.
Definition: word.H:59
Foam::fvPatchFieldMapper.
This boundary condition is not designed to be evaluated; it is assumed that the value is assigned via...
void write(std::ostream &os, const bool binary, List< floatScalar > &fField)
Write floats ascii or binary.
virtual tmp< Field< Type > > valueBoundaryCoeffs(const tmp< scalarField > &) const
Return the matrix source coefficients corresponding to the.
errorManip< error > abort(error &err)
Definition: errorManip.H:131
const fvPatch & patch() const
Return patch.
Definition: fvPatchField.H:337
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:54
calculatedFvPatchField(const fvPatch &, const DimensionedField< Type, volMesh > &)
Construct from patch and internal field.
void writeEntry(Ostream &os, const HashTable< T, Key, Hash > &ht)
Definition: HashTableIO.C:96
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
static tmp< fvPatchField< Type > > NewCalculatedType(const fvPatch &)
Return a pointer to a new calculatedFvPatchField created on.
volScalarField & p
A class for managing temporary objects.
Definition: PtrList.H:53