valuePointPatchField.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-2016 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  //- Construct and return a clone setting internal field reference
114  (
116  ) const
117  {
119  (
121  (
122  *this,
123  iF
124  )
125  );
126  }
127 
128 
129  // Member functions
130 
131  // Access
132 
133  //- Return size
134  label size() const
135  {
136  return Field<Type>::size();
137  }
138 
139 
140  // Mapping functions
141 
142  //- Map (and resize as needed) from self given a mapping object
143  virtual void autoMap
144  (
145  const pointPatchFieldMapper&
146  );
147 
148  //- Reverse map the given PointPatchField onto
149  // this PointPatchField
150  virtual void rmap
151  (
152  const pointPatchField<Type>&,
153  const labelList&
154  );
155 
156 
157  // Evaluation functions
158 
159  //- Update the coefficients associated with the patch field
160  virtual void updateCoeffs();
161 
162  //- Evaluate the patch field
163  virtual void evaluate
164  (
165  const Pstream::commsTypes commsType=Pstream::blocking
166  );
167 
168 
169  //- Write
170  virtual void write(Ostream&) const;
171 
172 
173  // Member operators
174 
175  // Assignment operators
176 
177  virtual void operator=
178  (
180  );
181 
182  virtual void operator=
183  (
184  const pointPatchField<Type>&
185  );
186 
187  virtual void operator=(const Field<Type>&);
188  virtual void operator=(const Type&);
189 
190 
191  // Force an assignment irrespective of form of patch
192 
193  virtual void operator==
194  (
196  );
197 
198  virtual void operator==
199  (
200  const pointPatchField<Type>&
201  );
202 
203  virtual void operator==(const Field<Type>&);
204  virtual void operator==(const Type&);
205 };
206 
207 
208 // This function is added to overide the hack in pointPatchField.H
209 // which enables simple backward compatability with verions using
210 // referenceLevel in GeometicField
211 template<class Type>
212 tmp<Field<Type>> operator+
213 (
214  const valuePointPatchField<Type>& vsppf,
215  const Type& t
216 )
217 {
218  return static_cast<const Field<Type>&>(vsppf) + t;
219 }
220 
221 
222 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
223 
224 } // End namespace Foam
225 
226 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
227 
228 #ifdef NoRepository
229  #include "valuePointPatchField.C"
230 #endif
231 
232 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
233 
234 #endif
235 
236 // ************************************************************************* //
valuePointPatchField(const pointPatch &, const DimensionedField< Type, pointMesh > &)
Construct from patch and internal field.
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:137
commsTypes
Types of communications.
Definition: UPstream.H:64
Foam::pointPatchFieldMapper.
virtual void operator=(const valuePointPatchField< Type > &)
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
Abstract base class for point-mesh patch fields.
Pre-declare SubField and related Field type.
Definition: Field.H:57
virtual void evaluate(const Pstream::commsTypes commsType=Pstream::blocking)
Evaluate the patch field.
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:53
TypeName("value")
Runtime type information.
label size() const
Return the number of elements in the UList.
virtual void operator==(const valuePointPatchField< Type > &)
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...
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:53
A class for managing temporary objects.
Definition: PtrList.H:54
virtual void write(Ostream &) const
Write.
virtual void rmap(const pointPatchField< Type > &, const labelList &)
Reverse map the given PointPatchField onto.
Namespace for OpenFOAM.
label size() const
Return size.