cyclicAMIPointPatchField.C
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2011-2016 OpenFOAM Foundation
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 \*---------------------------------------------------------------------------*/
27 
29 #include "Swap.H"
30 #include "transformField.H"
31 #include "pointFields.H"
32 
33 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
34 
35 template<class Type>
37 (
38  const pointPatch& p,
40 )
41 :
43  cyclicAMIPatch_(refCast<const cyclicAMIPointPatch>(p)),
44  ppiPtr_(nullptr),
45  nbrPpiPtr_(nullptr)
46 {}
47 
48 
49 template<class Type>
51 (
52  const pointPatch& p,
54  const dictionary& dict
55 )
56 :
58  cyclicAMIPatch_(refCast<const cyclicAMIPointPatch>(p, dict)),
59  ppiPtr_(nullptr),
60  nbrPpiPtr_(nullptr)
61 {
62  if (!isType<cyclicAMIPointPatch>(p))
63  {
65  << "patch " << this->patch().index() << " not cyclicAMI type. "
66  << "Patch type = " << p.type()
67  << exit(FatalIOError);
68  }
69 }
70 
71 
72 template<class Type>
74 (
76  const pointPatch& p,
78  const pointPatchFieldMapper& mapper
79 )
80 :
81  coupledPointPatchField<Type>(ptf, p, iF, mapper),
82  cyclicAMIPatch_(refCast<const cyclicAMIPointPatch>(p)),
83  ppiPtr_(nullptr),
84  nbrPpiPtr_(nullptr)
85 {
86  if (!isType<cyclicAMIPointPatch>(this->patch()))
87  {
89  << "Field type does not correspond to patch type for patch "
90  << this->patch().index() << "." << endl
91  << "Field type: " << typeName << endl
92  << "Patch type: " << this->patch().type()
93  << exit(FatalError);
94  }
95 }
96 
97 
98 template<class Type>
100 (
103 )
104 :
106  cyclicAMIPatch_(ptf.cyclicAMIPatch_),
107  ppiPtr_(nullptr),
108  nbrPpiPtr_(nullptr)
109 {}
110 
111 
112 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
113 
114 template<class Type>
116 {
117  return cyclicAMIPatch_.coupled();
118 }
119 
120 
121 template<class Type>
123 (
124  const Pstream::commsTypes,
125  Field<Type>& pField
126 ) const
127 {
128  if (cyclicAMIPatch_.cyclicAMIPatch().owner())
129  {
130  // We inplace modify pField. To prevent the other side (which gets
131  // evaluated at a later date) using already changed values we do
132  // all swaps on the side that gets evaluated first.
133 
134  // Get neighbouring pointPatch
135  const cyclicAMIPointPatch& nbrPatch = cyclicAMIPatch_.neighbPatch();
136 
137  // Get neighbouring pointPatchField
139  refCast<const GeometricField<Type, pointPatchField, pointMesh>>
140  (
141  this->internalField()
142  );
143 
144  const cyclicAMIPointPatchField<Type>& nbr =
145  refCast<const cyclicAMIPointPatchField<Type>>
146  (
147  fld.boundaryField()[nbrPatch.index()]
148  );
149 
150 
151  Field<Type> ptFld(this->patchInternalField(pField));
152  Field<Type> nbrPtFld(nbr.patchInternalField(pField));
153 
154 
155  if (doTransform())
156  {
157  const tensor& forwardT = this->forwardT()[0];
158  const tensor& reverseT = this->reverseT()[0];
159 
160  transform(ptFld, reverseT, ptFld);
161  transform(nbrPtFld, forwardT, nbrPtFld);
162  }
163 
164  // convert point field to face field, AMI interpolate, then
165  // face back to point
166  {
167  // add neighbour side contribution to owner
168  Field<Type> nbrFcFld(nbrPpi().pointToFaceInterpolate(nbrPtFld));
169 
170  // interpolate to owner
171  if (cyclicAMIPatch_.cyclicAMIPatch().applyLowWeightCorrection())
172  {
173  Field<Type> fcFld(ppi().pointToFaceInterpolate(ptFld));
174 
175  nbrFcFld =
176  cyclicAMIPatch_.cyclicAMIPatch().interpolate
177  (
178  nbrFcFld,
179  fcFld
180  );
181  }
182  else
183  {
184  nbrFcFld =
185  cyclicAMIPatch_.cyclicAMIPatch().interpolate(nbrFcFld);
186  }
187 
188  // add to internal field
189  this->addToInternalField
190  (
191  pField,
192  ppi().faceToPointInterpolate(nbrFcFld)()
193  );
194  }
195 
196  {
197  // add owner side contribution to neighbour
198  Field<Type> fcFld(ppi().pointToFaceInterpolate(ptFld));
199 
200  // interpolate to neighbour
201  if (cyclicAMIPatch_.cyclicAMIPatch().applyLowWeightCorrection())
202  {
203  Field<Type> nbrFcFld(nbrPpi().pointToFaceInterpolate(nbrPtFld));
204 
205  fcFld =
206  cyclicAMIPatch_.cyclicAMIPatch().neighbPatch().interpolate
207  (
208  fcFld,
209  nbrFcFld
210  );
211  }
212  else
213  {
214  fcFld =
215  cyclicAMIPatch_.cyclicAMIPatch().neighbPatch().interpolate
216  (
217  fcFld
218  );
219  }
220 
221  // add to internal field
222  nbr.addToInternalField
223  (
224  pField,
225  nbrPpi().faceToPointInterpolate(fcFld)()
226  );
227  }
228  }
229 }
230 
231 
232 // ************************************************************************* //
Foam::cyclicAMIPointPatchField
Cyclic AMI front and back plane patch field.
Definition: cyclicAMIPointPatchField.H:54
Foam::Tensor< scalar >
p
volScalarField & p
Definition: createFieldRefs.H:8
Foam::coupledPointPatchField
A Coupled boundary condition for pointField.
Definition: coupledPointPatchField.H:52
cyclicAMIPointPatchField.H
Foam::cyclicAMIPointPatch
Cyclic AMI point patch - place holder only.
Definition: cyclicAMIPointPatch.H:52
Foam::FatalIOError
IOerror FatalIOError
Foam::endl
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:369
Foam::pointPatch
Basic pointPatch represents a set of points from the mesh.
Definition: pointPatch.H:58
Foam::transform
dimensionSet transform(const dimensionSet &ds)
Return the argument; transformations do not change the dimensions.
Definition: dimensionSet.C:521
transformField.H
Spatial transformation functions for primitive fields.
Foam::pointPatchFieldMapper
Foam::pointPatchFieldMapper.
Definition: pointPatchFieldMapper.H:48
Foam::facePointPatch::index
virtual label index() const
Return the index of this patch in the pointBoundaryMesh.
Definition: facePointPatch.H:166
Swap.H
Swap arguments as per std::swap, but in Foam namespace.
Foam::Field
Generic templated field type.
Definition: Field.H:63
fld
gmvFile<< "tracers "<< particles.size()<< nl;for(const passiveParticle &p :particles){ gmvFile<< p.position().x()<< ' ';}gmvFile<< nl;for(const passiveParticle &p :particles){ gmvFile<< p.position().y()<< ' ';}gmvFile<< nl;for(const passiveParticle &p :particles){ gmvFile<< p.position().z()<< ' ';}gmvFile<< nl;for(const word &name :lagrangianScalarNames){ IOField< scalar > fld(IOobject(name, runTime.timeName(), cloud::prefix, mesh, IOobject::MUST_READ, IOobject::NO_WRITE))
Definition: gmvOutputLagrangian.H:23
dict
dictionary dict
Definition: searchingEngine.H:14
Foam::cyclicAMIPointPatchField::swapAddSeparated
virtual void swapAddSeparated(const Pstream::commsTypes commsType, Field< Type > &) const
Complete swap of patch point values and add to local values.
Definition: cyclicAMIPointPatchField.C:123
Foam::cyclicAMIPointPatch::neighbPatch
const cyclicAMIPointPatch & neighbPatch() const
Return neighbour point patch.
Definition: cyclicAMIPointPatch.H:132
Foam::FatalError
error FatalError
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:123
Foam::exit
errorManipArg< error, int > exit(error &err, const int errNo=1)
Definition: errorManip.H:130
Foam::UPstream::commsTypes
commsTypes
Types of communications.
Definition: UPstream.H:69
FatalErrorInFunction
#define FatalErrorInFunction
Report an error message using Foam::FatalError.
Definition: error.H:453
Foam::foamVersion::patch
const std::string patch
OpenFOAM patch number as a std::string.
Foam::cyclicAMIPointPatchField::coupled
virtual bool coupled() const
Definition: cyclicAMIPointPatchField.C:115
FatalIOErrorInFunction
#define FatalIOErrorInFunction(ios)
Report an error message using Foam::FatalIOError.
Definition: error.H:473
Foam::GeometricField
Generic GeometricField class.
Definition: areaFieldsFwd.H:53
Foam::cyclicAMIPointPatchField::cyclicAMIPointPatchField
cyclicAMIPointPatchField(const pointPatch &, const DimensionedField< Type, pointMesh > &)
Construct from patch and internal field.
Definition: cyclicAMIPointPatchField.C:37
pointFields.H
Foam::DimensionedField
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
Definition: DimensionedField.H:54