uniformFixedValueFvPatchField.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-2012 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 Group
28  grpGenericBoundaryConditions
29 
30 Description
31  This boundary condition provides a uniform fixed value condition.
32 
33  \heading Patch usage
34 
35  \table
36  Property | Description | Required | Default value
37  uniformValue | uniform value | yes |
38  \endtable
39 
40  Example of the boundary condition specification:
41  \verbatim
42  myPatch
43  {
44  type uniformFixedValue;
45  uniformValue constant 0.2;
46  }
47  \endverbatim
48 
49 Note
50  The uniformValue entry is a DataEntry type, able to describe time
51  varying functions. The example above gives the usage for supplying a
52  constant value.
53 
54 SeeAlso
55  Foam::DataEntry
56  Foam::fixedValueFvPatchField
57 
58 SourceFiles
59  uniformFixedValueFvPatchField.C
60 
61 \*---------------------------------------------------------------------------*/
62 
63 #ifndef uniformFixedValueFvPatchField_H
64 #define uniformFixedValueFvPatchField_H
65 
67 #include "DataEntry.H"
68 
69 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
70 
71 namespace Foam
72 {
73 
74 /*---------------------------------------------------------------------------*\
75  Class uniformFixedValueFvPatchField Declaration
76 \*---------------------------------------------------------------------------*/
77 
78 template<class Type>
79 class uniformFixedValueFvPatchField
80 :
81  public fixedValueFvPatchField<Type>
82 {
83  // Private data
84 
85  autoPtr<DataEntry<Type> > uniformValue_;
86 
87 
88 public:
89 
90  //- Runtime type information
91  TypeName("uniformFixedValue");
92 
93 
94  // Constructors
95 
96  //- Construct from patch and internal field
98  (
99  const fvPatch&,
101  );
102 
103  //- Construct from patch and internal field and patch field
105  (
106  const fvPatch&,
108  const Field<Type>& fld
109  );
110 
111  //- Construct from patch, internal field and dictionary
113  (
114  const fvPatch&,
116  const dictionary&
117  );
118 
119  //- Construct by mapping given uniformFixedValueFvPatchField
120  // onto a new patch
122  (
124  const fvPatch&,
126  const fvPatchFieldMapper&
127  );
128 
129  //- Construct as copy
131  (
133  );
134 
135  //- Construct and return a clone
136  virtual tmp<fvPatchField<Type> > clone() const
137  {
138  return tmp<fvPatchField<Type> >
139  (
141  );
142  }
143 
144  //- Construct as copy setting internal field reference
146  (
149  );
150 
151  //- Construct and return a clone setting internal field reference
152  virtual tmp<fvPatchField<Type> > clone
153  (
155  ) const
156  {
157  return tmp<fvPatchField<Type> >
158  (
160  );
161  }
163 
164  // Member functions
165 
166 
167  // Evaluation functions
168 
169  //- Update the coefficients associated with the patch field
170  virtual void updateCoeffs();
171 
172 
173  //- Write
174  virtual void write(Ostream&) const;
175 };
176 
177 
178 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
179 
180 } // End namespace Foam
181 
182 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
183 
184 #ifdef NoRepository
186 #endif
187 
188 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
189 
190 #endif
191 
192 // ************************************************************************* //
TypeName("uniformFixedValue")
Runtime type information.
virtual tmp< fvPatchField< Type > > clone() const
Construct and return a clone.
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
Foam::fvPatchFieldMapper.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
Namespace for OpenFOAM.
uniformFixedValueFvPatchField(const fvPatch &, const DimensionedField< Type, volMesh > &)
Construct from patch and internal field.
Pre-declare SubField and related Field type.
Definition: Field.H:57
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 ))
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:53
virtual void write(Ostream &) const
Write.
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:61
This boundary condition provides a uniform fixed value condition.
A class for managing temporary objects.
Definition: PtrList.H:118