jumpCyclicAMIFvPatchField.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-2020 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 #include "transformField.H"
28 
29 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
30 
31 template<class Type>
33 (
34  const fvPatch& p,
36 )
37 :
39 {}
40 
41 
42 template<class Type>
44 (
46  const fvPatch& p,
48  const fvPatchFieldMapper& mapper
49 )
50 :
51  cyclicAMIFvPatchField<Type>(ptf, p, iF, mapper)
52 {}
53 
54 
55 template<class Type>
57 (
58  const fvPatch& p,
60  const dictionary& dict
61 )
62 :
64 {
65  // Call this evaluation in derived classes
66  // this->evaluate(Pstream::commsTypes::blocking);
67 }
68 
69 
70 template<class Type>
72 (
74 )
75 :
77 {}
78 
79 
80 template<class Type>
82 (
85 )
86 :
88 {}
89 
90 
91 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
92 
93 template<class Type>
96 {
97  const Field<Type>& iField = this->primitiveField();
98  const labelUList& nbrFaceCells =
99  this->cyclicAMIPatch().cyclicAMIPatch().nbrPatch().faceCells();
100 
101  Field<Type> pnf(iField, nbrFaceCells);
102  tmp<Field<Type>> tpnf;
103 
104  if (this->cyclicAMIPatch().applyLowWeightCorrection())
105  {
106  tpnf =
107  this->cyclicAMIPatch().interpolate
108  (
109  pnf,
110  this->patchInternalField()()
111  );
112  }
113  else
114  {
115  tpnf = this->cyclicAMIPatch().interpolate(pnf);
116  }
117 
118  this->transform().transform(tpnf.ref(), tpnf());
119 
120  tmp<Field<Type>> tjf = jump();
121  if (!this->cyclicAMIPatch().owner())
122  {
123  tjf = -tjf;
124  }
125 
126  return tpnf - tjf;
127 }
128 
129 
130 template<class Type>
132 (
133  scalarField& result,
134  const scalarField& psiInternal,
135  const scalarField& coeffs,
136  const direction cmpt,
137  const Pstream::commsTypes
138 ) const
139 {
141 }
142 
143 
144 template<class Type>
146 (
147  Field<Type>& result,
148  const Field<Type>& psiInternal,
149  const scalarField& coeffs,
150  const Pstream::commsTypes
151 ) const
152 {
153  const labelUList& nbrFaceCells =
154  this->cyclicAMIPatch().cyclicAMIPatch().nbrPatch().faceCells();
155 
156  Field<Type> pnf(psiInternal, nbrFaceCells);
157 
158  if (this->cyclicAMIPatch().applyLowWeightCorrection())
159  {
160  pnf =
161  this->cyclicAMIPatch().interpolate
162  (
163  pnf,
164  this->patchInternalField()()
165  );
166 
167  }
168  else
169  {
170  pnf = this->cyclicAMIPatch().interpolate(pnf);
171  }
172 
173  // only apply jump to original field
174  if (&psiInternal == &this->primitiveField())
175  {
176  Field<Type> jf(this->jump());
177  if (!this->cyclicAMIPatch().owner())
178  {
179  jf *= -1.0;
180  }
181 
182  pnf -= jf;
183  }
184 
185  // Transform according to the transformation tensors
186  this->transformCoupleField(pnf);
187 
188  // Multiply the field by coefficients and add into the result
189  const labelUList& faceCells = this->cyclicAMIPatch().faceCells();
190  forAll(faceCells, elemI)
191  {
192  result[faceCells[elemI]] -= coeffs[elemI]*pnf[elemI];
193  }
194 }
195 
196 
197 // ************************************************************************* //
This boundary condition provides a base class that enforces a cyclic condition with a specified &#39;jump...
dictionary dict
#define forAll(list, i)
Loop across all elements in list.
Definition: UList.H:434
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:158
commsTypes
Types of communications.
Definition: UPstream.H:64
T & ref() const
Return non-const reference or generate a fatal error.
Definition: tmpI.H:174
uint8_t direction
Definition: direction.H:45
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:61
jumpCyclicAMIFvPatchField(const fvPatch &, const DimensionedField< Type, volMesh > &)
Construct from patch and internal field.
tmp< Field< Type > > patchNeighbourField() const
Return neighbour coupled given internal cell data.
virtual void updateInterfaceMatrix(scalarField &result, const scalarField &psiInternal, const scalarField &coeffs, const direction cmpt, const Pstream::commsTypes commsType) const
Update result field based on interface functionality.
Spatial transformation functions for primitive fields.
Pre-declare SubField and related Field type.
Definition: Field.H:56
Foam::fvPatchFieldMapper.
A 1D vector of objects of type <T>, where the size of the vector is known and can be used for subscri...
Definition: HashTable.H:60
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
friend dimensionSet transform(const dimensionSet &)
Return the argument; transformations do not change the dimensions.
volScalarField & p
A class for managing temporary objects.
Definition: PtrList.H:53
#define NotImplemented
Issue a FatalErrorIn for a function not currently implemented.
Definition: error.H:366
This boundary condition enforces a cyclic condition between a pair of boundaries, whereby communicati...
dimensionSet transform(const dimensionSet &)
Definition: dimensionSet.C:477