timeVaryingMappedFixedValueFvPatchField.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-2024 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 
27 
28 
29 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
30 
31 template<class Type>
34 (
35  const fvPatch& p,
37  const dictionary& dict
38 )
39 :
40  fixedValueFvPatchField<Type>(p, iF, dict, false),
41  fieldMapper_(p, iF, dict)
42 {
43  if (dict.found("value"))
44  {
46  (
47  Field<Type>("value", iF.dimensions(), dict, p.size())
48  );
49  }
50  else
51  {
52  // Note: we use evaluate() here to trigger updateCoeffs followed
53  // by re-setting of fvatchfield::updated_ flag. This is
54  // so if first use is in the next time step it retriggers
55  // a new update.
57  }
58 }
59 
60 
61 template<class Type>
64 (
66  const fvPatch& p,
68  const fieldMapper& mapper
69 )
70 :
71  fixedValueFvPatchField<Type>(ptf, p, iF, mapper),
72  fieldMapper_(ptf.fieldMapper_)
73 {}
74 
75 
76 template<class Type>
79 (
82 )
83 :
84  fixedValueFvPatchField<Type>(ptf, iF),
85  fieldMapper_(ptf.fieldMapper_)
86 {}
87 
88 
89 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
90 
91 template<class Type>
93 (
94  const fvPatchField<Type>& ptf,
95  const fieldMapper& mapper
96 )
97 {
99  fieldMapper_.map
100  (
102  .fieldMapper_,
103  mapper
104  );
105 }
106 
107 
108 template<class Type>
110 (
111  const fvPatchField<Type>& ptf
112 )
113 {
115  fieldMapper_.reset
116  (
118  .fieldMapper_
119  );
120 }
121 
122 
123 template<class Type>
125 {
126  if (this->updated())
127  {
128  return;
129  }
130 
131  this->operator==(fieldMapper_.map());
132 
134 }
135 
136 
137 template<class Type>
139 (
140  Ostream& os
141 ) const
142 {
144  fieldMapper_.write(os);
145  writeEntry(os, "value", *this);
146 }
147 
148 
149 // ************************************************************************* //
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
const dimensionSet & dimensions() const
Return dimensions.
Pre-declare SubField and related Field type.
Definition: Field.H:83
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:57
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:162
Abstract base class for field mapping.
Definition: fieldMapper.H:48
This boundary condition supplies a fixed value constraint, and is the base class for a number of othe...
Abstract base class with a fat-interface to all derived classes covering all possible ways in which t...
Definition: fvPatchField.H:88
virtual void evaluate(const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)
Evaluate the patch field, sets Updated to false.
Definition: fvPatchField.C:209
virtual void write(Ostream &) const
Write.
Definition: fvPatchField.C:229
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
Definition: fvPatchField.C:202
virtual void reset(const fvPatchField< Type > &)
Reset the fvPatchField to the given fvPatchField.
Definition: fvPatchField.C:195
virtual void map(const fvPatchField< Type > &, const fieldMapper &)
Map the given fvPatchField onto this fvPatchField.
Definition: fvPatchField.C:185
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:64
This boundary conditions interpolates the values from a set of supplied points in space and time.
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
virtual void reset(const fvPatchField< Type > &)
Reset the fvPatchField to the given fvPatchField.
timeVaryingMappedFixedValueFvPatchField(const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)
Construct from patch, internal field and dictionary.
virtual void map(const fvPatchField< Type > &, const fieldMapper &)
Map the given fvPatchField onto this fvPatchField.
tmp< fvMatrix< Type > > operator==(const fvMatrix< Type > &, const fvMatrix< Type > &)
To & refCast(From &r)
Reference type cast template function.
Definition: typeInfo.H:129
void writeEntry(Ostream &os, const HashTable< T, Key, Hash > &ht)
Definition: HashTableIO.C:96
dictionary dict
volScalarField & p