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-2018 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 )
72 :
73  fvPatchField<Type>(ptf, p, iF, mapper)
74 {}
75 
76 
77 template<class Type>
79 (
81 )
82 :
84 {}
85 
86 
87 template<class Type>
89 (
92 )
93 :
94  fvPatchField<Type>(ptf, iF)
95 {}
96 
97 
98 template<class Type>
101 (
102  const fvPatch& p
103 )
104 {
105  typename patchConstructorTable::iterator patchTypeCstrIter =
106  patchConstructorTablePtr_->find(p.type());
107 
108  if (patchTypeCstrIter != patchConstructorTablePtr_->end())
109  {
110  return patchTypeCstrIter()
111  (
112  p,
114  );
115  }
116  else
117  {
118  return tmp<fvPatchField<Type>>
119  (
121  (
122  p,
124  )
125  );
126  }
127 }
128 
129 
130 template<class Type>
131 template<class Type2>
133 (
134  const fvPatchField<Type2>& pf
135 )
136 {
137  return NewCalculatedType(pf.patch());
138 }
139 
140 
141 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
142 
143 template<class Type>
146 (
147  const tmp<scalarField>&
148 ) const
149 {
151  << "cannot be called for a calculatedFvPatchField"
152  << "\n on patch " << this->patch().name()
153  << " of field " << this->internalField().name()
154  << " in file " << this->internalField().objectPath()
155  << "\n You are probably trying to solve for a field with a "
156  "default boundary condition."
157  << abort(FatalError);
158 
159  return *this;
160 }
161 
162 
163 template<class Type>
166 (
167  const tmp<scalarField>&
168 ) const
169 {
171  << "cannot be called for a calculatedFvPatchField"
172  << "\n on patch " << this->patch().name()
173  << " of field " << this->internalField().name()
174  << " in file " << this->internalField().objectPath()
175  << "\n You are probably trying to solve for a field with a "
176  "default boundary condition."
177  << abort(FatalError);
178 
179  return *this;
180 }
181 
182 
183 template<class Type>
186 {
188  << "cannot be called for a calculatedFvPatchField"
189  << "\n on patch " << this->patch().name()
190  << " of field " << this->internalField().name()
191  << " in file " << this->internalField().objectPath()
192  << "\n You are probably trying to solve for a field with a "
193  "default boundary condition."
194  << abort(FatalError);
195 
196  return *this;
197 }
198 
199 
200 template<class Type>
203 {
205  << "cannot be called for a calculatedFvPatchField"
206  << "\n on patch " << this->patch().name()
207  << " of field " << this->internalField().name()
208  << " in file " << this->internalField().objectPath()
209  << "\n You are probably trying to solve for a field with a "
210  "default boundary condition."
211  << abort(FatalError);
212 
213  return *this;
214 }
215 
216 
217 template<class Type>
219 {
221  this->writeEntry("value", os);
222 }
223 
224 
225 // ************************************************************************* //
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:137
#define FatalErrorInFunction
Report an error message using Foam::FatalError.
Definition: error.H:319
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.
static const word & calculatedType()
Return the type of the calculated for of fvPatchField.
void write(Ostream &, const label, const dictionary &)
Write with dictionary lookup.
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 assmued that the value is assigned via...
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:340
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...
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