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-2023 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, dict, iF.name())
42 {
43  if (dict.found("value"))
44  {
46  }
47  else
48  {
49  // Note: we use evaluate() here to trigger updateCoeffs followed
50  // by re-setting of fvatchfield::updated_ flag. This is
51  // so if first use is in the next time step it retriggers
52  // a new update.
54  }
55 }
56 
57 
58 template<class Type>
61 (
63  const fvPatch& p,
65  const fvPatchFieldMapper& mapper
66 )
67 :
68  fixedValueFvPatchField<Type>(ptf, p, iF, mapper),
69  fieldMapper_(ptf.fieldMapper_)
70 {}
71 
72 
73 template<class Type>
76 (
79 )
80 :
81  fixedValueFvPatchField<Type>(ptf, iF),
82  fieldMapper_(ptf.fieldMapper_)
83 {}
84 
85 
86 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
87 
88 template<class Type>
90 (
91  const fvPatchField<Type>& ptf,
92  const fvPatchFieldMapper& mapper
93 )
94 {
96  fieldMapper_.map
97  (
99  .fieldMapper_,
100  mapper
101  );
102 }
103 
104 
105 template<class Type>
107 (
108  const fvPatchField<Type>& ptf
109 )
110 {
112  fieldMapper_.reset
113  (
115  .fieldMapper_
116  );
117 }
118 
119 
120 template<class Type>
122 {
123  if (this->updated())
124  {
125  return;
126  }
127 
128  this->operator==(fieldMapper_.map());
129 
131 }
132 
133 
134 template<class Type>
136 (
137  Ostream& os
138 ) const
139 {
141  fieldMapper_.write(os);
142  writeEntry(os, "value", *this);
143 }
144 
145 
146 // ************************************************************************* //
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
Pre-declare SubField and related Field type.
Definition: Field.H:82
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:160
This boundary condition supplies a fixed value constraint, and is the base class for a number of othe...
Foam::fvPatchFieldMapper.
Abstract base class with a fat-interface to all derived classes covering all possible ways in which t...
Definition: fvPatchField.H:87
virtual void evaluate(const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)
Evaluate the patch field, sets Updated to false.
Definition: fvPatchField.C:211
virtual void write(Ostream &) const
Write.
Definition: fvPatchField.C:231
virtual void operator==(const fvPatchField< Type > &)
Definition: fvPatchField.C:417
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
Definition: fvPatchField.C:204
virtual void reset(const fvPatchField< Type > &)
Reset the fvPatchField to the given fvPatchField.
Definition: fvPatchField.C:197
virtual void map(const fvPatchField< Type > &, const fvPatchFieldMapper &)
Map the given fvPatchField onto this fvPatchField.
Definition: fvPatchField.C:187
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.
virtual void map(const fvPatchField< Type > &, const fvPatchFieldMapper &)
Map the given fvPatchField onto this fvPatchField.
timeVaryingMappedFixedValueFvPatchField(const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)
Construct from patch, internal field and dictionary.
tmp< fvMatrix< Type > > operator==(const fvMatrix< Type > &, const fvMatrix< Type > &)
To & refCast(From &r)
Reference type cast template function.
Definition: typeInfo.H:111
void writeEntry(Ostream &os, const HashTable< T, Key, Hash > &ht)
Definition: HashTableIO.C:96
word name(const complex &)
Return a string representation of a complex.
Definition: complex.C:47
dictionary dict
volScalarField & p