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-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::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 public:
61 
62  //- Runtime type information
63  TypeName(processorPointPatch::typeName_());
64 
65 
66  // Constructors
67 
68  //- Construct from patch and internal field
70  (
71  const pointPatch&,
73  );
74 
75  //- Construct from patch, internal field and dictionary
77  (
78  const pointPatch&,
80  const dictionary&
81  );
82 
83  //- Construct by mapping given patchField<Type> onto a new patch
85  (
87  const pointPatch&,
90  );
91 
92  //- Construct as copy setting internal field reference
94  (
97  );
98 
99  //- Construct and return a clone setting internal field reference
101  (
103  ) const
104  {
106  (
108  (
109  *this,
110  iF
111  )
112  );
113  }
114 
115  //- Construct and return a clone setting internal field reference
117  (
118  const pointPatch& patch,
120  ) const
121  {
123  (
125  (
126  patch,
127  iF
128  )
129  );
130  }
131 
132 
133  //- Destructor
134  virtual ~processorPointPatchField();
135 
136 
137  // Member Functions
138 
139  // Access
140 
141  //- Return true if running parallel
142  virtual bool coupled() const
143  {
144  if (Pstream::parRun())
145  {
146  return true;
147  }
148  else
149  {
150  return false;
151  }
152  }
153 
154 
155  // Evaluation functions
156 
157  //- Evaluate the patch field
158  virtual void evaluate
159  (
160  const Pstream::commsTypes commsType =
162  )
163  {}
164 };
165 
166 
167 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
168 
169 } // End namespace Foam
170 
171 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
172 
173 #ifdef NoRepository
174  #include "processorPointPatchField.C"
175 #endif
176 
177 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
178 
179 #endif
180 
181 // ************************************************************************* //
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
TypeName(processorPointPatch::typeName_())
Runtime type information.
Foam::pointPatchFieldMapper.
Processor patch boundary needs to be such that the ordering of points in the patch is the same on bot...
virtual ~processorPointPatchField()
Destructor.
virtual void evaluate(const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)
Evaluate the patch field.
const pointPatch & patch() const
Return patch.
processorPointPatchField(const pointPatch &, const DimensionedField< Type, pointMesh > &)
Construct from patch and internal field.
virtual bool coupled() const
Return true if running parallel.
static bool & parRun()
Is this a parallel run?
Definition: UPstream.H:399
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...
Foam::processorPointPatchField.
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.