processorFvsPatchField.H
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-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 Class
25  Foam::processorFvsPatchField
26 
27 Description
28  Foam::processorFvsPatchField
29 
30 SourceFiles
31  processorFvsPatchField.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef processorFvsPatchField_H
36 #define processorFvsPatchField_H
37 
38 #include "coupledFvsPatchField.H"
39 #include "processorFvPatch.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class processorFvsPatch Declaration
48 \*---------------------------------------------------------------------------*/
49 
50 template<class Type>
52 :
53  public coupledFvsPatchField<Type>
54 {
55  // Private Data
56 
57  //- Local reference cast into the processor patch
58  const processorFvPatch& procPatch_;
59 
60  //- Receive buffer for non-blocking communication
61  mutable Field<Type> receiveBuf_;
62 
63 
64 public:
65 
66  //- Runtime type information
67  TypeName(processorFvPatch::typeName_());
68 
69 
70  // Constructors
71 
72  //- Construct from patch and internal field
74  (
75  const fvPatch&,
77  );
78 
79  //- Construct from patch and internal field and patch field
81  (
82  const fvPatch&,
84  const Field<Type>&
85  );
86 
87  //- Construct from patch, internal field and dictionary
89  (
90  const fvPatch&,
92  const dictionary&
93  );
94 
95  //- Construct by mapping given processorFvsPatchField onto a new patch
97  (
99  const fvPatch&,
101  const fvPatchFieldMapper&
102  );
103 
104  //- Disallow copy without setting internal field reference
106 
107  //- Copy constructor setting internal field reference
109  (
112  );
113 
114  //- Construct and return a clone setting internal field reference
116  (
118  ) const
119  {
121  (
122  new processorFvsPatchField<Type>(*this, iF)
123  );
124  }
125 
126  //- Construct and return a clone onto a new patch
127  // setting internal field reference
129  (
130  const fvPatch& patch,
132  ) const
133  {
135  (
136  new processorFvsPatchField<Type>(patch, iF, *this)
137  );
138  }
139 
140 
141  //- Destructor
142  virtual ~processorFvsPatchField();
143 
144 
145  // Member Functions
146 
147  // Access
148 
149  //- Return true if running parallel
150  virtual bool coupled() const
151  {
152  if (Pstream::parRun())
153  {
154  return true;
155  }
156  else
157  {
158  return false;
159  }
160  }
161 
162 
163  // Evaluation functions
164 
165  //- Initialise return of the patchField on the opposite patch of a
166  // coupled patch
167  virtual void initPatchNeighbourField
168  (
169  const Pstream::commsTypes commsType
170  ) const;
171 
172  //- Return patchField on the opposite patch of a coupled patch
174  (
175  const Pstream::commsTypes commsType
176  ) const;
177 };
178 
179 
180 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
181 
182 } // End namespace Foam
183 
184 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
185 
186 #ifdef NoRepository
187  #include "processorFvsPatchField.C"
188 #endif
189 
190 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
191 
192 #endif
193 
194 // ************************************************************************* //
TypeName(processorFvPatch::typeName_())
Runtime type information.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
commsTypes
Types of communications.
Definition: UPstream.H:64
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:63
virtual void initPatchNeighbourField(const Pstream::commsTypes commsType) const
Initialise return of the patchField on the opposite patch of a.
Foam::processorFvsPatchField.
Pre-declare SubField and related Field type.
Definition: Field.H:56
tmp< fvsPatchField< Type > > clone() const
Disallow clone without setting internal field reference.
Foam::fvPatchFieldMapper.
Processor patch.
virtual tmp< Field< Type > > patchNeighbourField(const Pstream::commsTypes commsType) const
Return patchField on the opposite patch of a coupled patch.
const fvPatch & patch() const
Return patch.
static bool & parRun()
Is this a parallel run?
Definition: UPstream.H:399
Foam::coupledFvsPatchField.
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
processorFvsPatchField(const fvPatch &, const DimensionedField< Type, surfaceMesh > &)
Construct from patch and internal field.
virtual ~processorFvsPatchField()
Destructor.
virtual bool coupled() const
Return true if running parallel.
A class for managing temporary objects.
Definition: PtrList.H:53
Namespace for OpenFOAM.