pressureDirectedInletVelocityFvPatchVectorField.C
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-2023 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 \*---------------------------------------------------------------------------*/
25 
28 #include "fvPatchFieldMapper.H"
29 #include "volFields.H"
30 #include "surfaceFields.H"
31 
32 
33 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
34 
37 (
38  const fvPatch& p,
40  const dictionary& dict
41 )
42 :
43  fixedValueFvPatchVectorField(p, iF, dict),
44  phiName_(dict.lookupOrDefault<word>("phi", "phi")),
45  rhoName_(dict.lookupOrDefault<word>("rho", "rho")),
46  inletDir_("inletDirection", dict, p.size())
47 {}
48 
49 
52 (
54  const fvPatch& p,
56  const fvPatchFieldMapper& mapper
57 )
58 :
59  fixedValueFvPatchVectorField(ptf, p, iF, mapper),
60  phiName_(ptf.phiName_),
61  rhoName_(ptf.rhoName_),
62  inletDir_(mapper(ptf.inletDir_))
63 {}
64 
65 
68 (
71 )
72 :
73  fixedValueFvPatchVectorField(pivpvf, iF),
74  phiName_(pivpvf.phiName_),
75  rhoName_(pivpvf.rhoName_),
76  inletDir_(pivpvf.inletDir_)
77 {}
78 
79 
80 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
81 
83 (
84  const fvPatchVectorField& ptf,
85  const fvPatchFieldMapper& mapper
86 )
87 {
88  fixedValueFvPatchVectorField::map(ptf, mapper);
89 
91  refCast<const pressureDirectedInletVelocityFvPatchVectorField>(ptf);
92 
93  mapper(inletDir_, tiptf.inletDir_);
94 }
95 
96 
98 (
99  const fvPatchVectorField& ptf
100 )
101 {
102  fixedValueFvPatchVectorField::reset(ptf);
103 
105  refCast<const pressureDirectedInletVelocityFvPatchVectorField>(ptf);
106 
107  inletDir_.reset(tiptf.inletDir_);
108 }
109 
110 
112 {
113  if (updated())
114  {
115  return;
116  }
117 
118  const surfaceScalarField& phi =
119  db().lookupObject<surfaceScalarField>(phiName_);
120 
121  const fvsPatchField<scalar>& phip =
122  patch().patchField<surfaceScalarField, scalar>(phi);
123 
124  tmp<vectorField> n = patch().nf();
125  tmp<scalarField> ndmagS = (n & inletDir_)*patch().magSf();
126 
127  if (phi.dimensions() == dimFlux)
128  {
129  operator==(inletDir_*phip/ndmagS);
130  }
131  else if (phi.dimensions() == dimMassFlux)
132  {
133  const fvPatchField<scalar>& rhop =
134  patch().lookupPatchField<volScalarField, scalar>(rhoName_);
135 
136  operator==(inletDir_*phip/(rhop*ndmagS));
137  }
138  else
139  {
141  << "dimensions of phi are not correct"
142  << "\n on patch " << this->patch().name()
143  << " of field " << this->internalField().name()
144  << " in file " << this->internalField().objectPath()
145  << exit(FatalError);
146  }
147 
148  fixedValueFvPatchVectorField::updateCoeffs();
149 }
150 
151 
153 (
154  Ostream& os
155 ) const
156 {
158  writeEntryIfDifferent<word>(os, "phi", "phi", phiName_);
159  writeEntryIfDifferent<word>(os, "rho", "rho", rhoName_);
160  writeEntry(os, "inletDirection", inletDir_);
161  writeEntry(os, "value", *this);
162 }
163 
164 
165 // * * * * * * * * * * * * * * * Member Operators * * * * * * * * * * * * * //
166 
167 void Foam::pressureDirectedInletVelocityFvPatchVectorField::operator=
168 (
169  const fvPatchField<vector>& pvf
170 )
171 {
172  fvPatchField<vector>::operator=(inletDir_*(inletDir_ & pvf));
173 }
174 
175 
176 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
177 
178 namespace Foam
179 {
181  (
184  );
185 }
186 
187 // ************************************************************************* //
label n
Macros for easy insertion into run-time selection tables.
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
const dimensionSet & dimensions() const
Return dimensions.
Generic GeometricField class.
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:57
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:160
Foam::fvPatchFieldMapper.
Abstract base class with a fat-interface to all derived classes covering all possible ways in which t...
Definition: fvPatchField.H:87
virtual void write(Ostream &) const
Write.
Definition: fvPatchField.C:231
virtual void operator=(const UList< Type > &)
Definition: fvPatchField.C:251
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:64
An abstract base class with a fat-interface to all derived classes covering all possible ways in whic...
Definition: fvsPatchField.H:82
This velocity inlet boundary condition is applied to patches where the pressure is specified....
pressureDirectedInletVelocityFvPatchVectorField(const fvPatch &, const DimensionedField< vector, volMesh > &, const dictionary &)
Construct from patch, internal field and dictionary.
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
virtual void map(const fvPatchVectorField &, const fvPatchFieldMapper &)
Map the given fvPatchField onto this fvPatchField.
virtual void reset(const fvPatchVectorField &)
Reset the fvPatchField to the given fvPatchField.
A class for managing temporary objects.
Definition: tmp.H:55
A class for handling words, derived from string.
Definition: word.H:62
#define FatalErrorInFunction
Report an error message using Foam::FatalError.
Definition: error.H:306
Namespace for OpenFOAM.
errorManipArg< error, int > exit(error &err, const int errNo=1)
Definition: errorManip.H:124
tmp< fvMatrix< Type > > operator==(const fvMatrix< Type > &, const fvMatrix< Type > &)
const dimensionSet dimMassFlux
SurfaceField< scalar > surfaceScalarField
void writeEntry(Ostream &os, const HashTable< T, Key, Hash > &ht)
Definition: HashTableIO.C:96
VolField< scalar > volScalarField
Definition: volFieldsFwd.H:61
error FatalError
makePatchTypeField(fvPatchScalarField, atmBoundaryLayerInletEpsilonFvPatchScalarField)
const dimensionSet dimFlux
dictionary dict
volScalarField & p
Foam::surfaceFields.