fixedMeanFvPatchField.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 | www.openfoam.com
6 \\/ M anipulation |
7-------------------------------------------------------------------------------
8 Copyright (C) 2012-2016 OpenFOAM Foundation
9-------------------------------------------------------------------------------
10License
11 This file is part of OpenFOAM.
12
13 OpenFOAM is free software: you can redistribute it and/or modify it
14 under the terms of the GNU General Public License as published by
15 the Free Software Foundation, either version 3 of the License, or
16 (at your option) any later version.
17
18 OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21 for more details.
22
23 You should have received a copy of the GNU General Public License
24 along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25
26Class
27 Foam::fixedMeanFvPatchField
28
29Group
30 grpInletBoundaryConditions
31
32Description
33 This boundary condition extrapolates field to the patch using the near-cell
34 values and adjusts the distribution to match the specified, optionally
35 time-varying, mean value.
36
37Usage
38 \table
39 Property | Description | Required | Default value
40 meanValue | mean value Function1 | yes |
41 \endtable
42
43 Example of the boundary condition specification:
44 \verbatim
45 <patchName>
46 {
47 type fixedMean;
48 meanValue 1.0;
49 }
50 \endverbatim
51
52See also
53 Foam::fixedValueFvPatchField
54 Foam::Function1Types
55
56SourceFiles
57 fixedMeanFvPatchField.C
58
59\*---------------------------------------------------------------------------*/
60
61#ifndef fixedMeanFvPatchField_H
62#define fixedMeanFvPatchField_H
63
65#include "Function1.H"
66
67// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
68
69namespace Foam
70{
71
72/*---------------------------------------------------------------------------*\
73 Class fixedMeanFvPatchField Declaration
74\*---------------------------------------------------------------------------*/
75
76template<class Type>
77class fixedMeanFvPatchField
78:
79 public fixedValueFvPatchField<Type>
80{
81 // Private data
82
83 //- MeanValue value the field is adjusted to maintain
84 autoPtr<Function1<Type>> meanValue_;
85
87public:
88
89 //- Runtime type information
90 TypeName("fixedMean");
91
92
93 // Constructors
94
95 //- Construct from patch and internal field
97 (
98 const fvPatch&,
100 );
101
102 //- Construct from patch, internal field and dictionary
104 (
105 const fvPatch&,
107 const dictionary&
108 );
109
110 //- Construct by mapping given fixedMeanFvPatchField
111 // onto a new patch
113 (
115 const fvPatch&,
117 const fvPatchFieldMapper&
118 );
119
120 //- Construct as copy
122 (
124 );
125
126 //- Construct and return a clone
127 virtual tmp<fvPatchField<Type>> clone() const
128 {
130 (
132 );
133 }
134
135 //- Construct as copy setting internal field reference
137 (
140 );
141
142 //- Construct and return a clone setting internal field reference
144 (
146 ) const
147 {
149 (
150 new fixedMeanFvPatchField<Type>(*this, iF)
151 );
153
154
155 // Member functions
156
157 //- Update the coefficients associated with the patch field
158 virtual void updateCoeffs();
159
160 //- Write
161 virtual void write(Ostream&) const;
162};
163
164
165// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
166
167} // End namespace Foam
168
169// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
170
171#ifdef NoRepository
172 #include "fixedMeanFvPatchField.C"
173#endif
174
175// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
176
177#endif
178
179// ************************************************************************* //
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:62
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
Definition: autoPtr.H:66
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:126
This boundary condition extrapolates field to the patch using the near-cell values and adjusts the di...
TypeName("fixedMean")
Runtime type information.
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
virtual tmp< fvPatchField< Type > > clone() const
Construct and return a clone.
virtual tmp< fvPatchField< Type > > clone(const DimensionedField< Type, volMesh > &iF) const
Construct and return a clone setting internal field reference.
This boundary condition supplies a fixed value constraint, and is the base class for a number of othe...
A FieldMapper for finite-volume patch fields.
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:71
A class for managing temporary objects.
Definition: tmp.H:65
Namespace for OpenFOAM.
runTime write()
#define TypeName(TypeNameString)
Declare a ClassName() with extra virtual type info.
Definition: typeInfo.H:73