valuePointPatchField.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::valuePointPatchField
26 
27 Description
28  Foam::valuePointPatchField
29 
30 SourceFiles
31  valuePointPatchField.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef valuePointPatchField_H
36 #define valuePointPatchField_H
37 
38 #include "pointPatchField.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 /*---------------------------------------------------------------------------*\
46  Class valuePointPatchField Declaration
47 \*---------------------------------------------------------------------------*/
48 
49 template<class Type>
51 :
52  public pointPatchField<Type>,
53  public Field<Type>
54 {
55  // Private Member Functions
56 
57  void checkFieldSize() const;
58 
59 
60 public:
61 
62  //- Runtime type information
63  TypeName("value");
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  const bool valueRequired=true
82  );
83 
84  //- Construct by mapping given patchField<Type> onto a new patch
86  (
88  const pointPatch&,
91  );
92 
93  //- Construct as copy setting internal field reference
95  (
98  );
99 
100  //- Disallow copy without setting internal field reference
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  // Member Functions
121 
122  // Access
123 
124  //- Return size
125  label size() const
126  {
127  return Field<Type>::size();
128  }
129 
130 
131  // Mapping functions
132 
133  //- Map (and resize as needed) from self given a mapping object
134  // Used to update fields following mesh topology change
135  virtual void autoMap(const pointPatchFieldMapper&);
136 
137  //- Reverse map the given pointPatchField onto this pointPatchField
138  // Used to reconstruct fields
139  virtual void rmap(const pointPatchField<Type>&, const labelList&);
140 
141  //- Reset the pointPatchField to the given pointPatchField
142  // Used for mesh to mesh mapping
143  virtual void reset(const pointPatchField<Type>&);
144 
145 
146  // Evaluation functions
147 
148  //- Update the coefficients associated with the patch field
149  virtual void updateCoeffs();
150 
151  //- Evaluate the patch field
152  virtual void evaluate
153  (
154  const Pstream::commsTypes commsType =
156  );
157 
158 
159  //- Write
160  virtual void write(Ostream&) const;
161 
162 
163  // Member Operators
164 
165  // Assignment operators
166 
167  virtual void operator=
168  (
170  );
171 
172  virtual void operator=
173  (
174  const pointPatchField<Type>&
175  );
176 
177  virtual void operator=(const Field<Type>&);
178  virtual void operator=(const Type&);
179 
180 
181  // Force an assignment irrespective of form of patch
182 
183  virtual void operator==
184  (
186  );
187 
188  virtual void operator==
189  (
190  const pointPatchField<Type>&
191  );
192 
193  virtual void operator==(const Field<Type>&);
194  virtual void operator==(const Type&);
195 };
196 
197 
198 // This function is added to override the hack in pointPatchField.H
199 // which enables simple backward compatibility with versions using
200 // referenceLevel in GeometicField
201 template<class Type>
202 tmp<Field<Type>> operator+
203 (
204  const valuePointPatchField<Type>& vsppf,
205  const Type& t
206 )
207 {
208  return static_cast<const Field<Type>&>(vsppf) + t;
209 }
210 
211 
212 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
213 
214 } // End namespace Foam
215 
216 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
217 
218 #ifdef NoRepository
219  #include "valuePointPatchField.C"
220 #endif
221 
222 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
223 
224 #endif
225 
226 // ************************************************************************* //
valuePointPatchField(const pointPatch &, const DimensionedField< Type, pointMesh > &)
Construct from patch and internal field.
Foam::valuePointPatchField.
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
Foam::pointPatchFieldMapper.
virtual void operator=(const valuePointPatchField< Type > &)
label size() const
Return size.
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
virtual void write(Ostream &) const
Write.
Abstract base class for point-mesh patch fields.
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
tmp< Field< Type > > clone() const
Clone.
Definition: Field.C:240
virtual void autoMap(const pointPatchFieldMapper &)
Map (and resize as needed) from self given a mapping object.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:54
TypeName("value")
Runtime type information.
virtual void operator==(const valuePointPatchField< Type > &)
Basic pointPatch represents a set of points from the mesh.
Definition: pointPatch.H:56
virtual void reset(const pointPatchField< Type > &)
Reset the pointPatchField to the given pointPatchField.
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
A class for managing temporary objects.
Definition: PtrList.H:53
virtual void rmap(const pointPatchField< Type > &, const labelList &)
Reverse map the given pointPatchField onto this pointPatchField.
label size() const
Return the number of elements in the UList.
Definition: ListI.H:171
Namespace for OpenFOAM.