atmBoundaryLayerInletOmegaFvPatchScalarField.C
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) 2020 OpenCFD Ltd.
9 -------------------------------------------------------------------------------
10 License
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 
26 \*---------------------------------------------------------------------------*/
27 
30 #include "fvPatchFieldMapper.H"
31 #include "volFields.H"
32 #include "surfaceFields.H"
33 
34 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
35 
36 namespace Foam
37 {
38 
39 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
40 
43 (
44  const fvPatch& p,
46 )
47 :
48  inletOutletFvPatchScalarField(p, iF),
49  atmBoundaryLayer(iF.time(), p.patch())
50 {}
51 
52 
55 (
56  const fvPatch& p,
58  const dictionary& dict
59 )
60 :
61  inletOutletFvPatchScalarField(p, iF),
62  atmBoundaryLayer(iF.time(), p.patch(), dict)
63 {
64  phiName_ = dict.getOrDefault<word>("phi", "phi");
65 
66  refValue() = omega(patch().Cf());
67  refGrad() = 0;
68  valueFraction() = 1;
69 
70  if (!initABL_)
71  {
72  scalarField::operator=(scalarField("value", dict, p.size()));
73  }
74  else
75  {
76  scalarField::operator=(refValue());
77  initABL_ = false;
78  }
79 }
80 
81 
84 (
86  const fvPatch& p,
88  const fvPatchFieldMapper& mapper
89 )
90 :
91  inletOutletFvPatchScalarField(psf, p, iF, mapper),
92  atmBoundaryLayer(psf, p, mapper)
93 {}
94 
95 
98 (
101 )
102 :
103  inletOutletFvPatchScalarField(psf, iF),
104  atmBoundaryLayer(psf)
105 {}
106 
107 
108 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
109 
111 {
112  if (updated())
113  {
114  return;
115  }
116 
117  refValue() = omega(patch().Cf());
118 
119  inletOutletFvPatchScalarField::updateCoeffs();
120 }
121 
122 
124 (
125  const fvPatchFieldMapper& m
126 )
127 {
128  inletOutletFvPatchScalarField::autoMap(m);
130 }
131 
132 
134 (
135  const fvPatchScalarField& psf,
136  const labelList& addr
137 )
138 {
139  inletOutletFvPatchScalarField::rmap(psf, addr);
140 
142  refCast<const atmBoundaryLayerInletOmegaFvPatchScalarField>(psf);
143 
144  atmBoundaryLayer::rmap(blpsf, addr);
145 }
146 
147 
149 {
151  os.writeEntryIfDifferent<word>("phi", "phi", phiName_);
153  writeEntry("value", os);
154 }
155 
156 
157 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
158 
160 (
163 );
164 
165 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
166 
167 } // End namespace Foam
168 
169 // ************************************************************************* //
Foam::fvPatchField< scalar >
volFields.H
Foam::fvPatchField< scalar >::write
virtual void write(Ostream &) const
Write.
Definition: fvPatchField.C:384
Foam::scalarField
Field< scalar > scalarField
Specialisation of Field<T> for scalar.
Definition: primitiveFieldsFwd.H:52
p
volScalarField & p
Definition: createFieldRefs.H:8
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:65
Foam::atmBoundaryLayerInletOmegaFvPatchScalarField::write
virtual void write(Ostream &) const
Write.
Definition: atmBoundaryLayerInletOmegaFvPatchScalarField.C:148
Foam::atmBoundaryLayer
Base class to set log-law type ground-normal inlet boundary conditions for wind velocity and turbulen...
Definition: atmBoundaryLayer.H:393
surfaceFields.H
Foam::surfaceFields.
fvPatchFieldMapper.H
Foam::atmBoundaryLayerInletOmegaFvPatchScalarField::atmBoundaryLayerInletOmegaFvPatchScalarField
atmBoundaryLayerInletOmegaFvPatchScalarField(const fvPatch &, const DimensionedField< scalar, volMesh > &)
Construct from patch and internal field.
Definition: atmBoundaryLayerInletOmegaFvPatchScalarField.C:43
atmBoundaryLayerInletOmegaFvPatchScalarField.H
Foam::atmBoundaryLayer::write
void write(Ostream &) const
Write.
Definition: atmBoundaryLayer.C:270
Foam::atmBoundaryLayerInletOmegaFvPatchScalarField::autoMap
virtual void autoMap(const fvPatchFieldMapper &)
Map (and resize as needed) from self given a mapping object.
Definition: atmBoundaryLayerInletOmegaFvPatchScalarField.C:124
Foam::fvPatch
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:65
Foam::atmBoundaryLayerInletOmegaFvPatchScalarField
Definition: atmBoundaryLayerInletOmegaFvPatchScalarField.H:149
Foam::atmBoundaryLayer::omega
tmp< scalarField > omega(const vectorField &pCf) const
Return the specific dissipation rate distribution for the ATM.
Definition: atmBoundaryLayer.C:258
dict
dictionary dict
Definition: searchingEngine.H:14
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:123
os
OBJstream os(runTime.globalPath()/outputName)
addToRunTimeSelectionTable.H
Macros for easy insertion into run-time selection tables.
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::Field< scalar >::operator=
void operator=(const Field< scalar > &)
Copy assignment.
Definition: Field.C:635
Foam::atmBoundaryLayerInletOmegaFvPatchScalarField::updateCoeffs
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
Definition: atmBoundaryLayerInletOmegaFvPatchScalarField.C:110
Foam::foamVersion::patch
const std::string patch
OpenFOAM patch number as a std::string.
Foam::atmBoundaryLayer::autoMap
void autoMap(const fvPatchFieldMapper &)
Map (and resize as needed) from self given a mapping object.
Definition: atmBoundaryLayer.C:183
Foam::List< label >
Foam::atmBoundaryLayer::rmap
void rmap(const atmBoundaryLayer &, const labelList &)
Reverse map the given fvPatchField onto this fvPatchField.
Definition: atmBoundaryLayer.C:197
Foam::fvPatchFieldMapper
Foam::fvPatchFieldMapper.
Definition: fvPatchFieldMapper.H:47
Foam::Ostream
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:56
Foam::makePatchTypeField
makePatchTypeField(fvPatchScalarField, atmBoundaryLayerInletEpsilonFvPatchScalarField)
Foam::dictionary::getOrDefault
T getOrDefault(const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) const
Definition: dictionaryTemplates.C:148
Foam::atmBoundaryLayerInletOmegaFvPatchScalarField::rmap
virtual void rmap(const fvPatchScalarField &, const labelList &)
Reverse map the given fvPatchField onto this fvPatchField.
Definition: atmBoundaryLayerInletOmegaFvPatchScalarField.C:134
Foam::DimensionedField
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
Definition: DimensionedField.H:54