calculatedFvPatchField.C
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2011-2016 OpenFOAM Foundation
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 \*---------------------------------------------------------------------------*/
27 
28 #include "calculatedFvPatchField.H"
29 #include "fvPatchFieldMapper.H"
30 
31 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
32 
33 template<class Type>
35 {
37 }
38 
39 
40 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
41 
42 template<class Type>
44 (
45  const fvPatch& p,
47 )
48 :
50 {}
51 
52 
53 template<class Type>
55 (
56  const fvPatch& p,
58  const dictionary& dict,
59  const bool valueRequired
60 )
61 :
62  fvPatchField<Type>(p, iF, dict, valueRequired)
63 {}
64 
65 
66 template<class Type>
68 (
70  const fvPatch& p,
72  const fvPatchFieldMapper& mapper
73 )
74 :
75  fvPatchField<Type>(ptf, p, iF, mapper)
76 {}
77 
78 
79 template<class Type>
81 (
83 )
84 :
86 {}
87 
88 
89 template<class Type>
91 (
94 )
95 :
96  fvPatchField<Type>(ptf, iF)
97 {}
98 
99 
100 template<class Type>
103 (
104  const fvPatch& p
105 )
106 {
107  auto patchTypeCstrIter = patchConstructorTablePtr_->cfind(p.type());
108 
109  if (patchTypeCstrIter.found())
110  {
111  return patchTypeCstrIter()
112  (
113  p,
115  );
116  }
117  else
118  {
119  return tmp<fvPatchField<Type>>
120  (
122  (
123  p,
125  )
126  );
127  }
128 }
129 
130 
131 template<class Type>
132 template<class Type2>
134 (
135  const fvPatchField<Type2>& pf
136 )
137 {
138  return NewCalculatedType(pf.patch());
139 }
140 
141 
142 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
143 
144 template<class Type>
147 (
148  const tmp<scalarField>&
149 ) const
150 {
152  << "cannot be called for a calculatedFvPatchField"
153  << "\n on patch " << this->patch().name()
154  << " of field " << this->internalField().name()
155  << " in file " << this->internalField().objectPath()
156  << "\n You are probably trying to solve for a field with a "
157  "default boundary condition."
158  << abort(FatalError);
159 
160  return *this;
161 }
162 
163 
164 template<class Type>
167 (
168  const tmp<scalarField>&
169 ) const
170 {
172  << "cannot be called for a calculatedFvPatchField"
173  << "\n on patch " << this->patch().name()
174  << " of field " << this->internalField().name()
175  << " in file " << this->internalField().objectPath()
176  << "\n You are probably trying to solve for a field with a "
177  "default boundary condition."
178  << abort(FatalError);
179 
180  return *this;
181 }
182 
183 
184 template<class Type>
187 {
189  << "cannot be called for a calculatedFvPatchField"
190  << "\n on patch " << this->patch().name()
191  << " of field " << this->internalField().name()
192  << " in file " << this->internalField().objectPath()
193  << "\n You are probably trying to solve for a field with a "
194  "default boundary condition."
195  << abort(FatalError);
196 
197  return *this;
198 }
199 
200 
201 template<class Type>
204 {
206  << "cannot be called for a calculatedFvPatchField"
207  << "\n on patch " << this->patch().name()
208  << " of field " << this->internalField().name()
209  << " in file " << this->internalField().objectPath()
210  << "\n You are probably trying to solve for a field with a "
211  "default boundary condition."
212  << abort(FatalError);
213 
214  return *this;
215 }
216 
217 
218 template<class Type>
220 {
222  this->writeEntry("value", os);
223 }
224 
225 
226 // ************************************************************************* //
Foam::fvPatchField
Abstract base class with a fat-interface to all derived classes covering all possible ways in which t...
Definition: volSurfaceMapping.H:50
Foam::calculatedFvPatchField::valueBoundaryCoeffs
virtual tmp< Field< Type > > valueBoundaryCoeffs(const tmp< scalarField > &) const
Return the matrix source coefficients corresponding to the.
Definition: calculatedFvPatchField.C:167
Foam::calculatedFvPatchField::gradientInternalCoeffs
tmp< Field< Type > > gradientInternalCoeffs() const
Return the matrix diagonal coefficients corresponding to the.
Definition: calculatedFvPatchField.C:186
p
volScalarField & p
Definition: createFieldRefs.H:8
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:62
Foam::calculatedFvPatchField::calculatedFvPatchField
calculatedFvPatchField(const fvPatch &, const DimensionedField< Type, volMesh > &)
Construct from patch and internal field.
Definition: calculatedFvPatchField.C:44
Foam::tmp
A class for managing temporary objects.
Definition: PtrList.H:61
calculatedFvPatchField.H
fvPatchFieldMapper.H
Foam::fvPatchField::calculatedType
static const word & calculatedType()
Return the type of the calculated for of fvPatchField.
Definition: calculatedFvPatchField.C:34
Foam::calculatedFvPatchField::gradientBoundaryCoeffs
tmp< Field< Type > > gradientBoundaryCoeffs() const
Return the matrix source coefficients corresponding to the.
Definition: calculatedFvPatchField.C:203
Foam::calculatedFvPatchField::write
virtual void write(Ostream &) const
Write.
Definition: calculatedFvPatchField.C:219
Foam::fvPatch
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:65
dict
dictionary dict
Definition: searchingEngine.H:14
Foam::FatalError
error FatalError
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:121
Foam::calculatedFvPatchField
This boundary condition is not designed to be evaluated; it is assmued that the value is assigned via...
Definition: calculatedFvPatchField.H:66
Foam::abort
errorManip< error > abort(error &err)
Definition: errorManip.H:144
FatalErrorInFunction
#define FatalErrorInFunction
Report an error message using Foam::FatalError.
Definition: error.H:381
Foam::foamVersion::patch
const std::string patch
OpenFOAM patch number as a std::string.
Foam::fvPatchField::NewCalculatedType
static tmp< fvPatchField< Type > > NewCalculatedType(const fvPatch &)
Return a pointer to a new calculatedFvPatchField created on.
Definition: calculatedFvPatchField.C:103
Foam::vtk::write
void write(vtk::formatter &fmt, const Type &val, const label n=1)
Component-wise write of a value (N times)
Definition: foamVtkOutputTemplates.C:35
Foam::calculatedFvPatchField::valueInternalCoeffs
virtual tmp< Field< Type > > valueInternalCoeffs(const tmp< scalarField > &) const
Return the matrix diagonal coefficients corresponding to the.
Definition: calculatedFvPatchField.C:147
Foam::fvPatchFieldMapper
Foam::fvPatchFieldMapper.
Definition: fvPatchFieldMapper.H:47
Foam::fvPatchField::patch
const fvPatch & patch() const
Return patch.
Definition: fvPatchField.H:343
Foam::Ostream
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:56
Foam::DimensionedField
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
Definition: DimensionedField.H:54