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-2019 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 and return a clone
94  virtual autoPtr<pointPatchField<Type>> clone() const
95  {
97  (
99  (
100  *this
101  )
102  );
103  }
104 
105  //- Construct as copy setting internal field reference
107  (
110  );
111 
112  //- Copy constructor
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  // Member Functions
133 
134  // Access
135 
136  //- Return size
137  label size() const
138  {
139  return Field<Type>::size();
140  }
141 
142 
143  // Mapping functions
144 
145  //- Map (and resize as needed) from self given a mapping object
146  // Used to update fields following mesh topology change
147  virtual void autoMap(const pointPatchFieldMapper&);
148 
149  //- Reverse map the given pointPatchField onto this pointPatchField
150  // Used to reconstruct fields
151  virtual void rmap(const pointPatchField<Type>&, const labelList&);
152 
153 
154  // Evaluation functions
155 
156  //- Update the coefficients associated with the patch field
157  virtual void updateCoeffs();
158 
159  //- Evaluate the patch field
160  virtual void evaluate
161  (
162  const Pstream::commsTypes commsType =
164  );
165 
166 
167  //- Write
168  virtual void write(Ostream&) const;
169 
170 
171  // Member Operators
172 
173  // Assignment operators
174 
175  virtual void operator=
176  (
178  );
179 
180  virtual void operator=
181  (
182  const pointPatchField<Type>&
183  );
184 
185  virtual void operator=(const Field<Type>&);
186  virtual void operator=(const Type&);
187 
188 
189  // Force an assignment irrespective of form of patch
190 
191  virtual void operator==
192  (
194  );
195 
196  virtual void operator==
197  (
198  const pointPatchField<Type>&
199  );
200 
201  virtual void operator==(const Field<Type>&);
202  virtual void operator==(const Type&);
203 };
204 
205 
206 // This function is added to override the hack in pointPatchField.H
207 // which enables simple backward compatibility with versions using
208 // referenceLevel in GeometicField
209 template<class Type>
210 tmp<Field<Type>> operator+
211 (
212  const valuePointPatchField<Type>& vsppf,
213  const Type& t
214 )
215 {
216  return static_cast<const Field<Type>&>(vsppf) + t;
217 }
218 
219 
220 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
221 
222 } // End namespace Foam
223 
224 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
225 
226 #ifdef NoRepository
227  #include "valuePointPatchField.C"
228 #endif
229 
230 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
231 
232 #endif
233 
234 // ************************************************************************* //
valuePointPatchField(const pointPatch &, const DimensionedField< Type, pointMesh > &)
Construct from patch and internal field.
virtual autoPtr< pointPatchField< Type > > clone() const
Construct and return a clone.
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
Foam::valuePointPatchField.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:158
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
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
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.