interstitialInletVelocityFvPatchVectorField.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) 2013-2016 OpenFOAM Foundation
9  Copyright (C) 2020 OpenCFD Ltd.
10 -------------------------------------------------------------------------------
11 License
12  This file is part of OpenFOAM.
13 
14  OpenFOAM is free software: you can redistribute it and/or modify it
15  under the terms of the GNU General Public License as published by
16  the Free Software Foundation, either version 3 of the License, or
17  (at your option) any later version.
18 
19  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
20  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
21  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22  for more details.
23 
24  You should have received a copy of the GNU General Public License
25  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
26 
27 \*---------------------------------------------------------------------------*/
28 
30 #include "volFields.H"
32 #include "fvPatchFieldMapper.H"
33 #include "surfaceFields.H"
34 
35 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
36 
39 (
40  const fvPatch& p,
42 )
43 :
44  fixedValueFvPatchVectorField(p, iF),
45  inletVelocity_(p.size(), Zero),
46  alphaName_("alpha")
47 {}
48 
49 
52 (
54  const fvPatch& p,
56  const fvPatchFieldMapper& mapper
57 )
58 :
59  fixedValueFvPatchVectorField(ptf, p, iF, mapper),
60  inletVelocity_(ptf.inletVelocity_, mapper),
61  alphaName_(ptf.alphaName_)
62 {}
63 
64 
67 (
68  const fvPatch& p,
70  const dictionary& dict
71 )
72 :
73  fixedValueFvPatchVectorField(p, iF, dict),
74  inletVelocity_("inletVelocity", dict, p.size()),
75  alphaName_(dict.getOrDefault<word>("alpha", "alpha"))
76 {}
77 
78 
81 (
83 )
84 :
85  fixedValueFvPatchVectorField(ptf),
86  inletVelocity_(ptf.inletVelocity_),
87  alphaName_(ptf.alphaName_)
88 {}
89 
90 
93 (
96 )
97 :
98  fixedValueFvPatchVectorField(ptf, iF),
99  inletVelocity_(ptf.inletVelocity_),
100  alphaName_(ptf.alphaName_)
101 {}
102 
103 
104 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
105 
107 (
108  const fvPatchFieldMapper& m
109 )
110 {
111  fixedValueFvPatchVectorField::autoMap(m);
112  inletVelocity_.autoMap(m);
113 }
114 
115 
117 (
118  const fvPatchVectorField& ptf,
119  const labelList& addr
120 )
121 {
122  fixedValueFvPatchVectorField::rmap(ptf, addr);
123 
125  refCast<const interstitialInletVelocityFvPatchVectorField>(ptf);
126 
127  inletVelocity_.rmap(tiptf.inletVelocity_, addr);
128 }
129 
130 
132 {
133  if (updated())
134  {
135  return;
136  }
137 
138  const fvPatchField<scalar>& alphap =
139  patch().lookupPatchField<volScalarField, scalar>(alphaName_);
140 
141  operator==(inletVelocity_/alphap);
142  fixedValueFvPatchVectorField::updateCoeffs();
143 }
144 
145 
147 {
149  os.writeEntryIfDifferent<word>("alpha", "alpha", alphaName_);
150  inletVelocity_.writeEntry("inletVelocity", os);
151  writeEntry("value", os);
152 }
153 
154 
155 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
156 
157 namespace Foam
158 {
160  (
163  );
164 }
165 
166 
167 // ************************************************************************* //
Foam::fvPatchField< vector >
volFields.H
Foam::fvPatchField::write
virtual void write(Ostream &) const
Write.
Definition: fvPatchField.C:384
Foam::Ostream::writeEntryIfDifferent
Ostream & writeEntryIfDifferent(const word &key, const T &value1, const T &value2)
Write a keyword/value entry only when the two values differ.
Definition: Ostream.H:248
p
volScalarField & p
Definition: createFieldRefs.H:8
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:65
Foam::Zero
static constexpr const zero Zero
Global zero (0)
Definition: zero.H:131
interstitialInletVelocityFvPatchVectorField.H
surfaceFields.H
Foam::surfaceFields.
fvPatchFieldMapper.H
Foam::interstitialInletVelocityFvPatchVectorField::rmap
virtual void rmap(const fvPatchVectorField &, const labelList &)
Reverse map the given fvPatchField onto this fvPatchField.
Definition: interstitialInletVelocityFvPatchVectorField.C:117
Foam::operator==
tmp< faMatrix< Type > > operator==(const faMatrix< Type > &, const faMatrix< Type > &)
Foam::fvPatch
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:65
Foam::volScalarField
GeometricField< scalar, fvPatchField, volMesh > volScalarField
Definition: volFieldsFwd.H:57
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
Foam::interstitialInletVelocityFvPatchVectorField::autoMap
virtual void autoMap(const fvPatchFieldMapper &)
Map (and resize as needed) from self given a mapping object.
Definition: interstitialInletVelocityFvPatchVectorField.C:107
os
OBJstream os(runTime.globalPath()/outputName)
addToRunTimeSelectionTable.H
Macros for easy insertion into run-time selection tables.
Foam::interstitialInletVelocityFvPatchVectorField
Inlet velocity in which the actual interstitial velocity is calculated by dividing the specified inle...
Definition: interstitialInletVelocityFvPatchVectorField.H:61
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::foamVersion::patch
const std::string patch
OpenFOAM patch number as a std::string.
Foam::List< label >
Foam::fvPatchFieldMapper
Foam::fvPatchFieldMapper.
Definition: fvPatchFieldMapper.H:47
Foam::interstitialInletVelocityFvPatchVectorField::updateCoeffs
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
Definition: interstitialInletVelocityFvPatchVectorField.C:131
Foam::Ostream
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:56
Foam::interstitialInletVelocityFvPatchVectorField::write
virtual void write(Ostream &) const
Write.
Definition: interstitialInletVelocityFvPatchVectorField.C:146
Foam::makePatchTypeField
makePatchTypeField(fvPatchScalarField, atmBoundaryLayerInletEpsilonFvPatchScalarField)
Foam::DimensionedField
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
Definition: DimensionedField.H:54
Foam::interstitialInletVelocityFvPatchVectorField::interstitialInletVelocityFvPatchVectorField
interstitialInletVelocityFvPatchVectorField(const fvPatch &, const DimensionedField< vector, volMesh > &)
Construct from patch and internal field.
Definition: interstitialInletVelocityFvPatchVectorField.C:39