processorFvsPatchField.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-2026 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 "processorFvsPatchField.H"
27 
28 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
29 
30 template<class Type>
32 (
33  const fvPatch& p,
35 )
36 :
37  coupledFvsPatchField<Type>(p, iF),
38  procPatch_(refCast<const processorFvPatch>(p))
39 {}
40 
41 
42 template<class Type>
44 (
45  const fvPatch& p,
47  const Field<Type>& f
48 )
49 :
50  coupledFvsPatchField<Type>(p, iF, f),
51  procPatch_(refCast<const processorFvPatch>(p))
52 {}
53 
54 
55 template<class Type>
57 (
58  const fvPatch& p,
60  const dictionary& dict
61 )
62 :
63  coupledFvsPatchField<Type>(p, iF, dict),
64  procPatch_(refCast<const processorFvPatch>(p))
65 {
66  if (!isA<processorFvPatch>(p))
67  {
69  (
70  dict
71  ) << "patch " << this->patch().index() << " not processor type. "
72  << "Patch type = " << p.type()
73  << exit(FatalIOError);
74  }
75 }
76 
77 
78 template<class Type>
80 (
82  const fvPatch& p,
84  const fieldMapper& mapper
85 )
86 :
87  coupledFvsPatchField<Type>(ptf, p, iF, mapper),
88  procPatch_(refCast<const processorFvPatch>(p))
89 {
90  if (!isA<processorFvPatch>(this->patch()))
91  {
93  << "Field type does not correspond to patch type for patch "
94  << this->patch().index() << "." << endl
95  << "Field type: " << typeName << endl
96  << "Patch type: " << this->patch().type()
97  << exit(FatalError);
98  }
99 }
100 
101 
102 template<class Type>
104 (
105  const processorFvsPatchField<Type>& ptf,
107 )
108 :
109  coupledFvsPatchField<Type>(ptf, iF),
110  procPatch_(refCast<const processorFvPatch>(ptf.patch()))
111 {}
112 
113 
114 // * * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * //
115 
116 template<class Type>
118 {}
119 
120 
121 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
122 
123 template<class Type>
125 (
126  const Pstream::commsTypes commsType
127 ) const
128 {
129  if (Pstream::parRun())
130  {
131  if (commsType == Pstream::commsTypes::nonBlocking)
132  {
133  receiveBuf_.setSize(this->size());
134 
136  (
137  commsType,
138  procPatch_.neighbProcNo(),
139  reinterpret_cast<char*>(receiveBuf_.begin()),
140  receiveBuf_.byteSize(),
141  procPatch_.tag(),
142  procPatch_.comm()
143  );
144  }
145 
147  (
148  commsType,
149  procPatch_.neighbProcNo(),
150  reinterpret_cast<const char*>(this->begin()),
151  this->byteSize(),
152  procPatch_.tag(),
153  procPatch_.comm()
154  );
155  }
156 }
157 
158 
159 template<class Type>
162 (
163  const Pstream::commsTypes commsType
164 ) const
165 {
166  if (Pstream::parRun())
167  {
168  if (commsType != Pstream::commsTypes::nonBlocking)
169  {
170  receiveBuf_.setSize(this->size());
171 
173  (
174  commsType,
175  procPatch_.neighbProcNo(),
176  reinterpret_cast<char*>(receiveBuf_.begin()),
177  receiveBuf_.byteSize(),
178  procPatch_.tag(),
179  procPatch_.comm()
180  );
181  }
182 
183  procPatch_.transform().transform(receiveBuf_, receiveBuf_);
184 
185  return receiveBuf_;
186  }
187  else
188  {
189  return tmp<Field<Type>>(new Field<Type>());
190  }
191 }
192 
193 
194 // ************************************************************************* //
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:83
static label read(const commsTypes commsType, const int fromProcNo, char *buf, const std::streamsize bufSize, const int tag=UPstream::msgType(), const label communicator=0)
Read into given buffer from given processor and return the.
Definition: UIPread.C:80
virtual Ostream & write(const token &)
Write token.
Definition: Ostream.C:51
commsTypes
Types of communications.
Definition: UPstream.H:65
static bool & parRun()
Is this a parallel run?
Definition: UPstream.H:399
Foam::coupledFvsPatchField.
A list of keywords followed by any number of values (e.g. words and numbers) or sub-dictionaries.
Definition: dictionary.H:162
Abstract base class for field mapping.
Definition: fieldMapper.H:48
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:58
label index() const
Return the index of this patch in the fvBoundaryMesh.
Definition: fvPatch.H:165
const fvPatch & patch() const
Return patch.
Foam::processorFvsPatchField.
processorFvsPatchField(const fvPatch &, const DimensionedField< Type, surfaceMesh > &)
Construct from patch and internal field.
virtual tmp< Field< Type > > patchNeighbourField(const Pstream::commsTypes commsType) const
Return patchField on the opposite patch of a coupled patch.
virtual ~processorFvsPatchField()
Destructor.
virtual void initPatchNeighbourField(const Pstream::commsTypes commsType) const
Initialise return of the patchField on the opposite patch of a.
A class for managing temporary objects.
Definition: tmp.H:55
Template function which returns the un-mangled name of a given type. Useful for types which do not ha...
#define FatalIOErrorInFunction(ios)
Report an error message using Foam::FatalIOError.
Definition: error.H:346
#define FatalErrorInFunction
Report an error message using Foam::FatalError.
Definition: error.H:334
errorManipArg< error, int > exit(error &err, const int errNo=1)
Definition: errorManip.H:124
To & refCast(From &r)
Reference type cast template function.
Definition: typeInfo.H:141
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:288
IOerror FatalIOError
error FatalError
labelList f(nPoints)
dictionary dict
volScalarField & p