atmBoundaryLayerInletEpsilonFvPatchScalarField.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::atmBoundaryLayerInletEpsilonFvPatchScalarField
26 
27 Group
28  grpRASBoundaryConditions grpInletBoundaryConditions
29 
30 Description
31  This boundary condition specifies an inlet value for the turbulence
32  dissipation, \f$\epsilon\f$, appropriate for atmospheric boundary layers.
33 
34  See Foam::atmBoundaryLayer for details.
35 
36  Example of the boundary condition specification:
37  \verbatim
38  ground
39  {
40  type atmBoundaryLayerInletEpsilon;
41  z (0 0 1);
42  Uref 10.0;
43  Zref 20.0;
44  z0 uniform 0.1;
45  zGround uniform 0.0;
46  }
47  \endverbatim
48 
49 See also
50  Foam::atmBoundaryLayer,
51  Foam::atmBoundaryLayerInletVelocityFvPatchVectorField,
52  Foam::atmBoundaryLayerInletKFvPatchScalarField
53 
54 SourceFiles
55  atmBoundaryLayerInletEpsilonFvPatchScalarField.C
56 
57 \*---------------------------------------------------------------------------*/
58 
59 #ifndef atmBoundaryLayerInletEpsilonFvPatchScalarField_H
60 #define atmBoundaryLayerInletEpsilonFvPatchScalarField_H
61 
62 #include "fvPatchFields.H"
64 #include "atmBoundaryLayer.H"
65 
66 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
67 
68 namespace Foam
69 {
70 
71 /*---------------------------------------------------------------------------*\
72  Class atmBoundaryLayerInletEpsilonFvPatchScalarField Declaration
73 \*---------------------------------------------------------------------------*/
74 
76 :
77  public fixedValueFvPatchScalarField,
78  public atmBoundaryLayer
79 {
80 
81 public:
82 
83  //- Runtime type information
84  TypeName("atmBoundaryLayerInletEpsilon");
85 
86 
87  // Constructors
88 
89  //- Construct from patch and internal field
91  (
92  const fvPatch&,
94  );
95 
96  //- Construct from patch, internal field and dictionary
98  (
99  const fvPatch&,
101  const dictionary&
102  );
103 
104  //- Construct by mapping given
105  // atmBoundaryLayerInletEpsilonFvPatchScalarField onto a new patch
107  (
109  const fvPatch&,
111  const fvPatchFieldMapper&
112  );
113 
114  //- Construct and return a clone
115  virtual tmp<fvPatchScalarField> clone() const
116  {
118  (
120  );
121  }
122 
123  //- Construct as copy setting internal field reference
125  (
128  );
129 
130  //- Construct and return a clone setting internal field reference
132  (
134  ) const
135  {
137  (
139  );
140  }
141 
142 
143  // Member functions
144 
145  // Mapping functions
146 
147  //- Map (and resize as needed) from self given a mapping object
148  virtual void autoMap
149  (
150  const fvPatchFieldMapper&
151  );
152 
153  //- Reverse map the given fvPatchField onto this fvPatchField
154  virtual void rmap
155  (
156  const fvPatchScalarField&,
157  const labelList&
158  );
159 
160 
161  //- Write
162  virtual void write(Ostream&) const;
163 };
164 
165 
166 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
167 
168 } // End namespace Foam
169 
170 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
171 
172 #endif
173 
174 // ************************************************************************* //
This class provides functions to evaluate the velocity and turbulence distributions appropriate for a...
virtual tmp< fvPatchScalarField > clone() const
Construct and return a clone.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:61
Abstract base class with a fat-interface to all derived classes covering all possible ways in which t...
Definition: fvPatchField.H:65
virtual void rmap(const fvPatchScalarField &, const labelList &)
Reverse map the given fvPatchField onto this fvPatchField.
Foam::fvPatchFieldMapper.
TypeName("atmBoundaryLayerInletEpsilon")
Runtime type information.
virtual void autoMap(const fvPatchFieldMapper &)
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
This boundary condition specifies an inlet value for the turbulence dissipation, , appropriate for atmospheric boundary layers.
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
atmBoundaryLayerInletEpsilonFvPatchScalarField(const fvPatch &, const DimensionedField< scalar, volMesh > &)
Construct from patch and internal field.
A class for managing temporary objects.
Definition: PtrList.H:54
Namespace for OpenFOAM.