uniformFixedValueFvPatchField.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::uniformFixedValueFvPatchField
26 
27 Description
28  This boundary condition provides a uniform fixed value condition.
29 
30 Usage
31  \table
32  Property | Description | Required | Default value
33  uniformValue | uniform value | yes |
34  \endtable
35 
36  Example of the boundary condition specification:
37  \verbatim
38  <patchName>
39  {
40  type uniformFixedValue;
41  uniformValue constant 0.2;
42  }
43  \endverbatim
44 
45 Note
46  The uniformValue entry is a Function1 type, able to describe time
47  varying functions. The example above gives the usage for supplying a
48  constant value.
49 
50 See also
51  Foam::Function1s
52  Foam::fixedValueFvPatchField
53 
54 SourceFiles
55  uniformFixedValueFvPatchField.C
56 
57 \*---------------------------------------------------------------------------*/
58 
59 #ifndef uniformFixedValueFvPatchField_H
60 #define uniformFixedValueFvPatchField_H
61 
63 #include "Function1.H"
64 
65 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
66 
67 namespace Foam
68 {
69 
70 /*---------------------------------------------------------------------------*\
71  Class uniformFixedValueFvPatchField Declaration
72 \*---------------------------------------------------------------------------*/
73 
74 template<class Type>
75 class uniformFixedValueFvPatchField
76 :
77  public fixedValueFvPatchField<Type>
78 {
79  // Private Data
80 
81  autoPtr<Function1<Type>> uniformValue_;
82 
83 
84 public:
85 
86  //- Runtime type information
87  TypeName("uniformFixedValue");
88 
89 
90  // Constructors
91 
92  //- Construct from patch and internal field
94  (
95  const fvPatch&,
97  );
98 
99  //- Construct from patch and internal field and patch field
101  (
102  const fvPatch&,
104  const Field<Type>& fld
105  );
106 
107  //- Construct from patch, internal field and dictionary
109  (
110  const fvPatch&,
112  const dictionary&
113  );
114 
115  //- Construct by mapping given uniformFixedValueFvPatchField
116  // onto a new patch
118  (
120  const fvPatch&,
122  const fvPatchFieldMapper&
123  );
124 
125  //- Copy constructor
127  (
129  );
130 
131  //- Construct and return a clone
132  virtual tmp<fvPatchField<Type>> clone() const
133  {
134  return tmp<fvPatchField<Type>>
135  (
137  );
138  }
139 
140  //- Copy constructor setting internal field reference
142  (
145  );
146 
147  //- Construct and return a clone setting internal field reference
149  (
151  ) const
152  {
153  return tmp<fvPatchField<Type>>
154  (
156  );
157  }
159 
160  // Member Functions
161 
162  //- Update the coefficients associated with the patch field
163  virtual void updateCoeffs();
164 
165  //- Write
166  virtual void write(Ostream&) const;
167 };
168 
169 
170 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
171 
172 } // End namespace Foam
173 
174 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
175 
176 #ifdef NoRepository
178 #endif
179 
180 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
181 
182 #endif
183 
184 // ************************************************************************* //
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:158
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:61
This boundary condition provides a uniform fixed value condition.
gmvFile<< "tracers "<< particles.size()<< nl;forAllConstIter(Cloud< passiveParticle >, particles, iter){ gmvFile<< iter().position().x()<< ' ';}gmvFile<< nl;forAllConstIter(Cloud< passiveParticle >, particles, iter){ gmvFile<< iter().position().y()<< ' ';}gmvFile<< nl;forAllConstIter(Cloud< passiveParticle >, particles, iter){ gmvFile<< iter().position().z()<< ' ';}gmvFile<< nl;forAll(lagrangianScalarNames, i){ const word &name=lagrangianScalarNames[i];IOField< scalar > fld(IOobject(name, runTime.timeName(), cloud::prefix, mesh, IOobject::MUST_READ, IOobject::NO_WRITE))
Pre-declare SubField and related Field type.
Definition: Field.H:56
Foam::fvPatchFieldMapper.
uniformFixedValueFvPatchField(const fvPatch &, const DimensionedField< Type, volMesh > &)
Construct from patch and internal field.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:54
virtual void write(Ostream &) const
Write.
TypeName("uniformFixedValue")
Runtime type information.
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
virtual tmp< fvPatchField< Type > > clone() const
Construct and return a clone.
A class for managing temporary objects.
Definition: PtrList.H:53
Namespace for OpenFOAM.