All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
jumpCyclicFvPatchField.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-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 
26 #include "jumpCyclicFvPatchField.H"
27 
28 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
29 
30 template<class Type>
32 (
33  const fvPatch& p,
35 )
36 :
38 {}
39 
40 
41 template<class Type>
43 (
45  const fvPatch& p,
47  const fvPatchFieldMapper& mapper
48 )
49 :
50  cyclicFvPatchField<Type>(ptf, p, iF, mapper)
51 {}
52 
53 
54 template<class Type>
56 (
57  const fvPatch& p,
59  const dictionary& dict
60 )
61 :
63 {
64  // Call this evaluation in derived classes
65  // this->evaluate(Pstream::commsTypes::blocking);
66 }
67 
68 
69 template<class Type>
71 (
73 )
74 :
76 {}
77 
78 
79 template<class Type>
81 (
84 )
85 :
87 {}
88 
89 
90 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
91 
92 template<class Type>
95 {
96  const Field<Type>& iField = this->primitiveField();
97  const labelUList& nbrFaceCells =
98  this->cyclicPatch().neighbFvPatch().faceCells();
99 
100  tmp<Field<Type>> tpnf(new Field<Type>(this->size()));
101  Field<Type>& pnf = tpnf.ref();
102 
103  Field<Type> jf(this->jump());
104  if (!this->cyclicPatch().owner())
105  {
106  jf *= -1.0;
107  }
108 
109  forAll(*this, facei)
110  {
111  pnf[facei] =
112  this->transform().transform(iField[nbrFaceCells[facei]])
113  - jf[facei];
114  }
115 
116  return tpnf;
117 }
118 
119 
120 template<class Type>
122 (
123  scalarField& result,
124  const scalarField& psiInternal,
125  const scalarField& coeffs,
126  const direction cmpt,
127  const Pstream::commsTypes
128 ) const
129 {
131 }
132 
133 
134 template<class Type>
136 (
137  Field<Type>& result,
138  const Field<Type>& psiInternal,
139  const scalarField& coeffs,
140  const Pstream::commsTypes
141 ) const
142 {
143  Field<Type> pnf(this->size());
144 
145  const labelUList& nbrFaceCells =
146  this->cyclicPatch().neighbFvPatch().faceCells();
147 
148  // only apply jump to original field
149  if (&psiInternal == &this->primitiveField())
150  {
151  Field<Type> jf(this->jump());
152 
153  if (!this->cyclicPatch().owner())
154  {
155  jf *= -1.0;
156  }
157 
158  forAll(*this, facei)
159  {
160  pnf[facei] = psiInternal[nbrFaceCells[facei]] - jf[facei];
161  }
162  }
163  else
164  {
165  forAll(*this, facei)
166  {
167  pnf[facei] = psiInternal[nbrFaceCells[facei]];
168  }
169  }
170 
171  // Transform according to the transformation tensors
172  this->transformCoupleField(pnf);
173 
174  // Multiply the field by coefficients and add into the result
175  const labelUList& faceCells = this->cyclicPatch().faceCells();
176  forAll(faceCells, elemI)
177  {
178  result[faceCells[elemI]] -= coeffs[elemI]*pnf[elemI];
179  }
180 }
181 
182 
183 // ************************************************************************* //
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
Pre-declare SubField and related Field type.
Definition: Field.H:56
jumpCyclicFvPatchField(const fvPatch &, const DimensionedField< Type, volMesh > &)
Construct from patch and internal field.
Foam::fvPatchFieldMapper.
This boundary condition provides a base class for coupled-cyclic conditions with a specified &#39;jump&#39; (...
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.
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
This boundary condition enforces a cyclic condition between a pair of boundaries. ...
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
tmp< Field< Type > > patchNeighbourField() const
Return neighbour coupled given internal cell data.
#define NotImplemented
Issue a FatalErrorIn for a function not currently implemented.
Definition: error.H:366
dimensionSet transform(const dimensionSet &)
Definition: dimensionSet.C:477