atmBoundaryLayerInletVelocityFvPatchVectorField.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-2020 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::atmBoundaryLayerInletVelocityFvPatchVectorField
26 
27 Description
28  This boundary condition specifies a velocity inlet profile appropriate
29  for atmospheric boundary layers (ABL).
30 
31  See Foam::atmBoundaryLayer for details.
32 
33  Example of the boundary condition specification:
34  \verbatim
35  ground
36  {
37  type atmBoundaryLayerInletVelocity;
38  n (1 0 0);
39  z (0 0 1);
40  Uref 10.0;
41  Zref 20.0;
42  z0 uniform 0.1;
43  zGround uniform 0.0;
44  }
45  \endverbatim
46 
47 See also
48  Foam::atmBoundaryLayer,
49  Foam::atmBoundaryLayerInletKFvPatchScalarField,
50  Foam::atmBoundaryLayerInletEpsilonFvPatchScalarField
51 
52 SourceFiles
53  atmBoundaryLayerInletVelocityFvPatchVectorField.C
54 
55 \*---------------------------------------------------------------------------*/
56 
57 #ifndef atmBoundaryLayerInletVelocityFvPatchVectorField_H
58 #define atmBoundaryLayerInletVelocityFvPatchVectorField_H
59 
60 #include "fvPatchFields.H"
62 #include "atmBoundaryLayer.H"
63 
64 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
65 
66 namespace Foam
67 {
68 
69 /*---------------------------------------------------------------------------*\
70  Class atmBoundaryLayerInletVelocityFvPatchVectorField Declaration
71 \*---------------------------------------------------------------------------*/
72 
74 :
75  public inletOutletFvPatchVectorField,
76  public atmBoundaryLayer
77 {
78 
79 public:
80 
81  //- Runtime type information
82  TypeName("atmBoundaryLayerInletVelocity");
83 
84 
85  // Constructors
86 
87  //- Construct from patch and internal field
89  (
90  const fvPatch&,
92  );
93 
94  //- Construct from patch, internal field and dictionary
96  (
97  const fvPatch&,
99  const dictionary&
100  );
101 
102  //- Construct by mapping given
103  // atmBoundaryLayerInletVelocityFvPatchVectorField onto a new patch
105  (
107  const fvPatch&,
109  const fvPatchFieldMapper&
110  );
111 
112  //- Construct as copy setting internal field reference
114  (
117  );
118 
119  //- Construct and return a clone setting internal field reference
121  (
123  ) const
124  {
126  (
128  );
129  }
130 
131 
132  // Member Functions
133 
134  // Mapping functions
135 
136  //- Map (and resize as needed) from self given a mapping object
137  // Used to update fields following mesh topology change
138  virtual void autoMap(const fvPatchFieldMapper&);
139 
140  //- Reverse map the given fvPatchField onto this fvPatchField
141  // Used to reconstruct fields
142  virtual void rmap(const fvPatchVectorField&, const labelList&);
143 
144 
145  //- Write
146  virtual void write(Ostream&) const;
147 };
148 
149 
150 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
151 
152 } // End namespace Foam
153 
154 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
155 
156 #endif
157 
158 // ************************************************************************* //
This class provides functions to evaluate the velocity and turbulence distributions appropriate for a...
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:62
Abstract base class with a fat-interface to all derived classes covering all possible ways in which t...
Definition: fvPatchField.H:66
virtual tmp< fvPatchVectorField > clone(const DimensionedField< vector, volMesh > &iF) const
Construct and return a clone setting internal field reference.
virtual void rmap(const fvPatchVectorField &, const labelList &)
Reverse map the given fvPatchField onto this fvPatchField.
Foam::fvPatchFieldMapper.
TypeName("atmBoundaryLayerInletVelocity")
Runtime type information.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:54
atmBoundaryLayerInletVelocityFvPatchVectorField(const fvPatch &, const DimensionedField< vector, volMesh > &)
Construct from patch and internal field.
This boundary condition specifies a velocity inlet profile appropriate for atmospheric boundary layer...
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
virtual void autoMap(const fvPatchFieldMapper &)
Map (and resize as needed) from self given a mapping object.
A class for managing temporary objects.
Definition: PtrList.H:53
Namespace for OpenFOAM.