processorCyclicPointPatchField.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 2011-2015 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 and return a clone
97  virtual autoPtr<pointPatchField<Type> > clone() const
98  {
100  (
102  (
103  *this
104  )
105  );
106  }
107 
108  //- Construct as copy setting internal field reference
110  (
113  );
114 
115  //- Construct and return a clone setting internal field reference
117  (
119  ) const
120  {
122  (
124  (
125  *this,
126  iF
127  )
128  );
129  }
130 
131 
132  //- Destructor
134 
135 
136  // Member functions
137 
138  // Access
139 
140  //- Return true if running parallel
141  virtual bool coupled() const
142  {
143  if (Pstream::parRun())
144  {
145  return true;
146  }
147  else
148  {
149  return false;
150  }
151  }
152 
153  //- Does the patch field perform the transfromation
154  virtual bool doTransform() const
155  {
156  return
157  !(
159  || procPatch_.procPolyPatch().parallel()
160  );
161  }
162 
163 
164  // Evaluation functions
165 
166  //- Evaluate the patch field
167  virtual void evaluate
168  (
169  const Pstream::commsTypes commsType=Pstream::blocking
170  )
171  {}
172 
173  //- Initialise swap of non-collocated patch point values
174  virtual void initSwapAddSeparated
175  (
176  const Pstream::commsTypes commsType,
177  Field<Type>&
178  ) const;
179 
180  //- Complete swap of patch point values and add to local values
181  virtual void swapAddSeparated
182  (
183  const Pstream::commsTypes commsType,
184  Field<Type>&
185  ) const;
186 };
187 
188 
189 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
190 
191 } // End namespace Foam
192 
193 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
194 
195 #ifdef NoRepository
197 #endif
198 
199 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
200 
201 #endif
202 
203 // ************************************************************************* //
processorCyclicPointPatchField(const pointPatch &, const DimensionedField< Type, pointMesh > &)
Construct from patch and internal field.
static bool & parRun()
Is this a parallel run?
Definition: UPstream.H:380
virtual autoPtr< pointPatchField< Type > > clone() const
Construct and return a clone.
Basic pointPatch represents a set of points from the mesh.
Definition: pointPatch.H:56
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
A Coupled boundary condition for pointField.
TypeName(processorCyclicPointPatch::typeName_())
Runtime type information.
Processor patch boundary needs to be such that the ordering of points in the patch is the same on bot...
const processorPolyPatch & procPolyPatch() const
Return the underlying processorPolyPatch.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
Namespace for OpenFOAM.
virtual void initSwapAddSeparated(const Pstream::commsTypes commsType, Field< Type > &) const
Initialise swap of non-collocated patch point values.
virtual bool parallel() const
Are the cyclic planes parallel.
commsTypes
Types of communications.
Definition: UPstream.H:64
virtual bool doTransform() const
Does the patch field perform the transfromation.
virtual void evaluate(const Pstream::commsTypes commsType=Pstream::blocking)
Evaluate the patch field.
Pre-declare SubField and related Field type.
Definition: Field.H:57
virtual void swapAddSeparated(const Pstream::commsTypes commsType, Field< Type > &) const
Complete swap of patch point values and add to local values.
Foam::pointPatchFieldMapper.
Traits class for primitives.
Definition: pTraits.H:50
virtual bool coupled() const
Return true if running parallel.
Foam::processorCyclicPointPatchField.
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:117