uniformFixedValuePointPatchField.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-2018 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::uniformFixedValuePointPatchField
26 
27 Description
28  Enables the specification of a uniform fixed value boundary condition.
29 
30  Example of the boundary condition specification:
31  \verbatim
32  inlet
33  {
34  type uniformFixedValue;
35  uniformValue constant 0.2;
36  }
37  \endverbatim
38 
39  The uniformValue entry is a Function1 type, able to describe time
40  varying functions. The example above gives the usage for supplying a
41  constant value.
42 
43 SourceFiles
44  uniformFixedValuePointPatchField.C
45 
46 \*---------------------------------------------------------------------------*/
47 
48 #ifndef uniformFixedValuePointPatchField_H
49 #define uniformFixedValuePointPatchField_H
50 
52 #include "Function1.H"
53 
54 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
55 
56 namespace Foam
57 {
58 
59 /*---------------------------------------------------------------------------*\
60  Class uniformFixedValuePointPatchField Declaration
61 \*---------------------------------------------------------------------------*/
62 
63 template<class Type>
65 :
66  public fixedValuePointPatchField<Type>
67 {
68  // Private data
69 
70  autoPtr<Function1<Type>> uniformValue_;
71 
72 
73 public:
74 
75  //- Runtime type information
76  TypeName("uniformFixedValue");
77 
78 
79  // Constructors
80 
81  //- Construct from patch and internal field
83  (
84  const pointPatch&,
86  );
87 
88  //- Construct from patch, internal field and dictionary
90  (
91  const pointPatch&,
93  const dictionary&
94  );
95 
96  //- Construct by mapping given patchField<Type> onto a new patch
98  (
100  const pointPatch&,
102  const pointPatchFieldMapper&
103  );
104 
105  //- Construct as copy
107  (
109  );
110 
111  //- Construct and return a clone
112  virtual autoPtr<pointPatchField<Type>> clone() const
113  {
115  (
117  (
118  *this
119  )
120  );
121  }
122 
123  //- Construct as copy setting internal field reference
125  (
128  );
129 
130 
131  //- Construct and return a clone setting internal field reference
133  (
135  ) const
136  {
138  (
140  (
141  *this,
142  iF
143  )
144  );
145  }
146 
147 
148  // Member functions
149 
150  // Access
151 
152  //- Return the fluctuation scale
153  const Function1<Type>& uniformValue() const
154  {
155  return uniformValue_;
156  }
157 
158  // Evaluation functions
159 
160  //- Update the coefficients associated with the patch field
161  virtual void updateCoeffs();
162 
163 
164  //- Write
165  virtual void write(Ostream&) const;
166 };
167 
168 
169 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
170 
171 } // End namespace Foam
172 
173 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
174 
175 #ifdef NoRepository
177 #endif
178 
179 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
180 
181 #endif
182 
183 // ************************************************************************* //
Top level data entry class for use in dictionaries. Provides a mechanism to specify a variable as a c...
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
A FixedValue boundary condition for pointField.
const Function1< Type > & uniformValue() const
Return the fluctuation scale.
Foam::pointPatchFieldMapper.
virtual autoPtr< pointPatchField< Type > > clone() const
Construct and return a clone.
TypeName("uniformFixedValue")
Runtime type information.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:53
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
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
Enables the specification of a uniform fixed value boundary condition.
uniformFixedValuePointPatchField(const pointPatch &, const DimensionedField< Type, pointMesh > &)
Construct from patch and internal field.
Namespace for OpenFOAM.