processorPointPatchField.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-2023 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::processorPointPatchField
26 
27 Description
28  Foam::processorPointPatchField
29 
30 SourceFiles
31  processorPointPatchField.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef processorPointPatchField_H
36 #define processorPointPatchField_H
37 
38 #include "coupledPointPatchField.H"
39 #include "processorPointPatch.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class processorPointPatchField 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 processorPointPatch& procPatch_;
59 
60 
61 public:
62 
63  //- Runtime type information
64  TypeName(processorPointPatch::typeName_());
65 
66 
67  // Constructors
68 
69  //- Construct from patch and internal field
71  (
72  const pointPatch&,
74  );
75 
76  //- Construct from patch, internal field and dictionary
78  (
79  const pointPatch&,
81  const dictionary&
82  );
83 
84  //- Construct by mapping given patchField<Type> onto a new patch
86  (
88  const pointPatch&,
90  const fieldMapper&
91  );
92 
93  //- Construct as copy setting internal field reference
95  (
98  );
99 
100  //- Construct and return a clone setting internal field reference
102  (
104  ) const
105  {
107  (
109  (
110  *this,
111  iF
112  )
113  );
114  }
115 
116  //- Construct and return a clone onto a new patch
117  // setting internal field reference
119  (
120  const pointPatch& patch,
122  ) const
123  {
125  (
127  (
128  patch,
129  iF
130  )
131  );
132  }
133 
134 
135  //- Destructor
136  virtual ~processorPointPatchField();
137 
138 
139  // Member Functions
140 
141  // Access
142 
143  //- Return true if running parallel
144  virtual bool coupled() const
145  {
146  if (Pstream::parRun())
147  {
148  return true;
149  }
150  else
151  {
152  return false;
153  }
154  }
155 
156 
157  // Evaluation functions
158 
159  //- Evaluate the patch field
160  virtual void evaluate
161  (
162  const Pstream::commsTypes commsType =
164  )
165  {}
166 };
167 
168 
169 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
170 
171 } // End namespace Foam
172 
173 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
174 
175 #ifdef NoRepository
176  #include "processorPointPatchField.C"
177 #endif
178 
179 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
180 
181 #endif
182 
183 // ************************************************************************* //
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
commsTypes
Types of communications.
Definition: UPstream.H:65
static bool & parRun()
Is this a parallel run?
Definition: UPstream.H:399
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: autoPtr.H:51
A Coupled boundary condition for pointField.
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:162
Abstract base class for field mapping.
Definition: fieldMapper.H:48
autoPtr< pointPatchField< Type > > clone() const
Disallow clone without setting internal field reference.
const pointPatch & patch() const
Return patch.
Basic pointPatch represents a set of points from the mesh.
Definition: pointPatch.H:57
Foam::processorPointPatchField.
virtual void evaluate(const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)
Evaluate the patch field.
virtual bool coupled() const
Return true if running parallel.
processorPointPatchField(const pointPatch &, const DimensionedField< Type, pointMesh > &)
Construct from patch and internal field.
virtual ~processorPointPatchField()
Destructor.
TypeName(processorPointPatch::typeName_())
Runtime type information.
Processor patch boundary needs to be such that the ordering of points in the patch is the same on bot...
Namespace for OpenFOAM.