fixedJumpAMIFvPatchField.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) 2012-2022 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 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
29 
30 template<class Type>
32 (
33  const fvPatch& p,
35 )
36 :
38  jump_(this->size(), Zero)
39 {}
40 
41 
42 template<class Type>
44 (
45  const fvPatch& p,
47  const dictionary& dict
48 )
49 :
51  jump_(p.size(), Zero)
52 {
53  if (this->cyclicAMIPatch().owner())
54  {
55  jump_ = Field<Type>("jump", dict, p.size());
56  }
57 
58  if (dict.found("value"))
59  {
61  (
62  Field<Type>("value", dict, p.size())
63  );
64  }
65  else
66  {
67  this->evaluate(Pstream::commsTypes::blocking);
68  }
69 }
70 
71 
72 template<class Type>
74 (
76  const fvPatch& p,
78  const fvPatchFieldMapper& mapper
79 )
80 :
81  jumpCyclicAMIFvPatchField<Type>(ptf, p, iF, mapper),
82  jump_(mapper(ptf.jump_))
83 {}
84 
85 
86 template<class Type>
88 (
91 )
92 :
94  jump_(ptf.jump_)
95 {}
96 
97 
98 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
99 
100 template<class Type>
102 {
103  if (this->cyclicAMIPatch().owner())
104  {
105  return jump_;
106  }
107  else
108  {
109  const fixedJumpAMIFvPatchField& nbrPatch =
110  refCast<const fixedJumpAMIFvPatchField<Type>>
111  (
112  this->nbrPatchField()
113  );
114 
115  if (this->cyclicAMIPatch().applyLowWeightCorrection())
116  {
117  return this->cyclicAMIPatch().interpolate
118  (
119  nbrPatch.jump(),
120  Field<Type>(this->size(), Zero)
121  );
122  }
123  else
124  {
125  return this->cyclicAMIPatch().interpolate(nbrPatch.jump());
126  }
127  }
128 }
129 
130 
131 template<class Type>
133 (
134  const fvPatchFieldMapper& m
135 )
136 {
138  m(jump_, jump_);
139 }
140 
141 
142 template<class Type>
144 (
145  const fvPatchField<Type>& ptf,
146  const labelList& addr
147 )
148 {
150 
151  const fixedJumpAMIFvPatchField<Type>& tiptf =
152  refCast<const fixedJumpAMIFvPatchField<Type>>(ptf);
153  jump_.rmap(tiptf.jump_, addr);
154 }
155 
156 
157 template<class Type>
159 (
160  const fvPatchField<Type>& ptf
161 )
162 {
164 
165  const fixedJumpAMIFvPatchField<Type>& tiptf =
166  refCast<const fixedJumpAMIFvPatchField<Type>>(ptf);
167  jump_.reset(tiptf.jump_);
168 }
169 
170 
171 template<class Type>
173 {
175  writeEntry(os, "patchType", this->interfaceFieldType());
176 
177  if (this->cyclicAMIPatch().owner())
178  {
179  writeEntry(os, "jump", jump_);
180  }
181 
182  writeEntry(os, "value", *this);
183 }
184 
185 
186 // ************************************************************************* //
This boundary condition provides a base class that enforces a cyclic condition with a specified &#39;jump...
dictionary dict
bool found(const word &, bool recursive=false, bool patternMatch=true) const
Search dictionary for given keyword.
Definition: dictionary.C:663
void evaluate(GeometricField< Type, PatchField, GeoMesh > &result, const Function1< Type > &func, const GeometricField< Type, PatchField, GeoMesh > &x)
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
void size(const label)
Override size to be inconsistent with allocated storage.
Definition: ListI.H:164
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:63
Abstract base class with a fat-interface to all derived classes covering all possible ways in which t...
Definition: fvPatchField.H:66
virtual void rmap(const fvPatchField< Type > &, const labelList &)
Reverse map the given fvPatchField onto this fvPatchField.
Pre-declare SubField and related Field type.
Definition: Field.H:56
Foam::fvPatchFieldMapper.
void write(std::ostream &os, const bool binary, List< floatScalar > &fField)
Write floats ascii or binary.
static const zero Zero
Definition: zero.H:97
virtual void reset(const fvPatchField< Type > &)
Reset the fvPatchField to the given fvPatchField.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:54
This boundary condition provides a jump condition, across non-conformal cyclic path-pairs, employing an arbitraryMeshInterface (AMI).
void writeEntry(Ostream &os, const HashTable< T, Key, Hash > &ht)
Definition: HashTableIO.C:96
virtual tmp< Field< Type > > jump() const
Return the "jump" across the patch.
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
volScalarField & p
A class for managing temporary objects.
Definition: PtrList.H:53
fixedJumpAMIFvPatchField(const fvPatch &, const DimensionedField< Type, volMesh > &)
Construct from patch and internal field.
virtual void write(Ostream &) const
Write.
virtual void autoMap(const fvPatchFieldMapper &)
Map (and resize as needed) from self given a mapping object.