processorCyclicPointPatchField.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::processorCyclicPointPatchField
26 
27 Description
28  Foam::processorCyclicPointPatchField
29 
30 SourceFiles
31  processorCyclicPointPatchField.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef processorCyclicPointPatchField_H
36 #define processorCyclicPointPatchField_H
37 
38 #include "coupledPointPatchField.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class processorCyclicPointPatchField Declaration
48 \*---------------------------------------------------------------------------*/
49 
50 template<class Type>
52 :
53  public coupledPointPatchField<Type>
54 {
55  // Private Data
56 
57  //- Local reference to processor patch
58  const processorCyclicPointPatch& 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(processorCyclicPointPatch::typeName_());
68 
69 
70  // Constructors
71 
72  //- Construct from patch and internal field
74  (
75  const pointPatch&,
77  );
78 
79  //- Construct from patch, internal field and dictionary
81  (
82  const pointPatch&,
84  const dictionary&
85  );
86 
87  //- Construct by mapping given patchField<Type> onto a new patch
89  (
91  const pointPatch&,
94  );
95 
96  //- Construct as copy setting internal field reference
98  (
101  );
102 
103  //- Construct and return a clone setting internal field reference
105  (
107  ) const
108  {
110  (
112  (
113  *this,
114  iF
115  )
116  );
117  }
118 
119 
120  //- Destructor
122 
123 
124  // Member Functions
125 
126  // Access
127 
128  //- Return true if running parallel
129  virtual bool coupled() const
130  {
131  if (Pstream::parRun())
132  {
133  return true;
134  }
135  else
136  {
137  return false;
138  }
139  }
140 
141 
142  // Evaluation functions
143 
144  //- Evaluate the patch field
145  virtual void evaluate
146  (
147  const Pstream::commsTypes commsType =
149  )
150  {}
151 };
152 
153 
154 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
155 
156 } // End namespace Foam
157 
158 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
159 
160 #ifdef NoRepository
162 #endif
163 
164 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
165 
166 #endif
167 
168 // ************************************************************************* //
Foam::processorCyclicPointPatchField.
processorCyclicPointPatchField(const pointPatch &, const DimensionedField< Type, pointMesh > &)
Construct from patch and internal field.
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
Processor patch boundary needs to be such that the ordering of points in the patch is the same on bot...
Foam::pointPatchFieldMapper.
virtual void evaluate(const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)
Evaluate the patch field.
Pre-declare SubField and related Field type.
Definition: Field.H:56
virtual bool coupled() const
Return true if running parallel.
static bool & parRun()
Is this a parallel run?
Definition: UPstream.H:399
TypeName(processorCyclicPointPatch::typeName_())
Runtime type information.
Basic pointPatch represents a set of points from the mesh.
Definition: pointPatch.H:56
A Coupled boundary condition for pointField.
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:52
autoPtr< pointPatchField< Type > > clone() const
Disallow clone without setting internal field reference.
Namespace for OpenFOAM.