fixedGradientFaPatchField.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) 2016-2017 Wikki Ltd
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 
29 
30 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
31 
32 template<class Type>
34 (
35  const faPatch& p,
37 )
38 :
39  faPatchField<Type>(p, iF),
40  gradient_(p.size(), Zero)
41 {}
42 
43 
44 template<class Type>
46 (
48  const faPatch& p,
50  const faPatchFieldMapper& mapper
51 )
52 :
53  faPatchField<Type>(ptf, p, iF, mapper),
54  gradient_(ptf.gradient_, mapper)
55 {}
56 
57 
58 template<class Type>
60 (
61  const faPatch& p,
63  const dictionary& dict
64 )
65 :
66  faPatchField<Type>(p, iF),
67  gradient_("gradient", dict, p.size())
68 {
69  evaluate();
70 }
71 
72 
73 template<class Type>
75 (
77 )
78 :
79  faPatchField<Type>(ptf),
80  gradient_(ptf.gradient_)
81 {}
82 
83 
84 template<class Type>
86 (
89 )
90 :
91  faPatchField<Type>(ptf, iF),
92  gradient_(ptf.gradient_)
93 {}
94 
95 
96 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
97 
98 template<class Type>
100 (
101  const faPatchFieldMapper& m
102 )
103 {
105  gradient_.autoMap(m);
106 }
107 
108 
109 template<class Type>
111 (
112  const faPatchField<Type>& ptf,
113  const labelList& addr
114 )
115 {
116  faPatchField<Type>::rmap(ptf, addr);
117 
118  const fixedGradientFaPatchField<Type>& fgptf =
119  refCast<const fixedGradientFaPatchField<Type>>(ptf);
120 
121  gradient_.rmap(fgptf.gradient_, addr);
122 }
123 
124 
125 template<class Type>
127 {
128  if (!this->updated())
129  {
130  this->updateCoeffs();
131  }
132 
134  (
135  this->patchInternalField() + gradient_/this->patch().deltaCoeffs()
136  );
137 
139 }
140 
141 
142 template<class Type>
145 (
146  const tmp<scalarField>&
147 ) const
148 {
149  return tmp<Field<Type>>::New(this->size(), pTraits<Type>::one);
150 }
151 
152 
153 template<class Type>
156 (
157  const tmp<scalarField>&
158 ) const
159 {
160  return gradient()/this->patch().deltaCoeffs();
161 }
162 
163 
164 template<class Type>
167 {
168  return tmp<Field<Type>>::New(this->size(), Zero);
169 }
170 
171 
172 template<class Type>
175 {
176  return gradient();
177 }
178 
179 
180 template<class Type>
182 {
184  gradient_.writeEntry("gradient", os);
185 }
186 
187 
188 // ************************************************************************* //
Foam::fixedGradientFaPatchField::gradientInternalCoeffs
virtual tmp< Field< Type > > gradientInternalCoeffs() const
Return the matrix diagonal coefficients corresponding to the.
Definition: fixedGradientFaPatchField.C:166
p
volScalarField & p
Definition: createFieldRefs.H:8
Foam::faPatchField
faPatchField<Type> abstract base class. This class gives a fat-interface to all derived classes cover...
Definition: areaFieldsFwd.H:50
Foam::tmp
A class for managing temporary objects.
Definition: PtrList.H:61
Foam::Zero
static constexpr const zero Zero
Global zero (0)
Definition: zero.H:131
fixedGradientFaPatchField.H
Foam::fixedGradientFaPatchField::write
virtual void write(Ostream &) const
Write.
Definition: fixedGradientFaPatchField.C:181
Foam::fixedGradientFaPatchField::fixedGradientFaPatchField
fixedGradientFaPatchField(const faPatch &, const DimensionedField< Type, areaMesh > &)
Construct from patch and internal field.
Definition: fixedGradientFaPatchField.C:34
Foam::faPatchFieldMapper
Definition: faPatchFieldMapper.H:44
Foam::fixedGradientFaPatchField::evaluate
virtual void evaluate(const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)
Evaluate the patch field.
Definition: fixedGradientFaPatchField.C:126
Foam::fixedGradientFaPatchField::valueBoundaryCoeffs
virtual tmp< Field< Type > > valueBoundaryCoeffs(const tmp< scalarField > &) const
Return the matrix source coefficients corresponding to the.
Definition: fixedGradientFaPatchField.C:156
Foam::Field
Generic templated field type.
Definition: Field.H:63
Foam::fixedGradientFaPatchField
Author Zeljko Tukovic, FMENA Hrvoje Jasak, Wikki Ltd.
Definition: fixedGradientFaPatchField.H:54
Foam::fixedGradientFaPatchField::autoMap
virtual void autoMap(const faPatchFieldMapper &)
Map (and resize as needed) from self given a mapping object.
Definition: fixedGradientFaPatchField.C:100
dict
dictionary dict
Definition: searchingEngine.H:14
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:123
os
OBJstream os(runTime.globalPath()/outputName)
Foam::New
tmp< DimensionedField< TypeR, GeoMesh > > New(const tmp< DimensionedField< TypeR, GeoMesh >> &tdf1, const word &name, const dimensionSet &dimensions)
Global function forwards to reuseTmpDimensionedField::New.
Definition: DimensionedFieldReuseFunctions.H:105
Foam::UPstream::commsTypes
commsTypes
Types of communications.
Definition: UPstream.H:69
Foam::fixedGradientFaPatchField::valueInternalCoeffs
virtual tmp< Field< Type > > valueInternalCoeffs(const tmp< scalarField > &) const
Return the matrix diagonal coefficients corresponding to the.
Definition: fixedGradientFaPatchField.C:145
Foam::foamVersion::patch
const std::string patch
OpenFOAM patch number as a std::string.
Foam::List< label >
Foam::pTraits
A traits class, which is primarily used for primitives.
Definition: pTraits.H:56
Foam::fixedGradientFaPatchField::rmap
virtual void rmap(const faPatchField< Type > &, const labelList &)
Reverse map the given faPatchField onto this faPatchField.
Definition: fixedGradientFaPatchField.C:111
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:36
Foam::Ostream
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:56
Foam::faPatch
Finite area patch class. Used for 2-D non-Euclidian finite area method.
Definition: faPatch.H:69
Foam::DimensionedField
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
Definition: DimensionedField.H:54
Foam::fixedGradientFaPatchField::gradientBoundaryCoeffs
virtual tmp< Field< Type > > gradientBoundaryCoeffs() const
Return the matrix source coefficients corresponding to the.
Definition: fixedGradientFaPatchField.C:174
Foam::stringOps::evaluate
string evaluate(label fieldWidth, const std::string &s, size_t pos=0, size_t len=std::string::npos)
String evaluation with specified (positive, non-zero) field width.
Definition: stringOpsEvaluate.C:37