pressureNormalInletOutletVelocityFvPatchVectorField.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) 2011-2017 OpenFOAM Foundation
9  Copyright (C) 2017-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 
31 #include "fvPatchFieldMapper.H"
32 #include "volFields.H"
33 #include "surfaceFields.H"
34 
35 
36 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
37 
40 (
41  const fvPatch& p,
43 )
44 :
45  mixedFvPatchVectorField(p, iF),
46  phiName_("phi"),
47  rhoName_("rho")
48 {
49  refValue() = *this;
50  refGrad() = Zero;
51  valueFraction() = 0.0;
52 }
53 
54 
57 (
59  const fvPatch& p,
61  const fvPatchFieldMapper& mapper
62 )
63 :
64  mixedFvPatchVectorField(ptf, p, iF, mapper),
65  phiName_(ptf.phiName_),
66  rhoName_(ptf.rhoName_)
67 {}
68 
69 
72 (
73  const fvPatch& p,
75  const dictionary& dict
76 )
77 :
78  mixedFvPatchVectorField(p, iF),
79  phiName_(dict.getOrDefault<word>("phi", "phi")),
80  rhoName_(dict.getOrDefault<word>("rho", "rho"))
81 {
82  patchType() = dict.getOrDefault<word>("patchType", word::null);
83  fvPatchVectorField::operator=(vectorField("value", dict, p.size()));
84  refValue() = *this;
85  refGrad() = Zero;
86  valueFraction() = 0.0;
87 }
88 
89 
92 (
94 )
95 :
96  mixedFvPatchVectorField(pivpvf),
97  phiName_(pivpvf.phiName_),
98  rhoName_(pivpvf.rhoName_)
99 {}
100 
101 
104 (
107 )
108 :
109  mixedFvPatchVectorField(pivpvf, iF),
110  phiName_(pivpvf.phiName_),
111  rhoName_(pivpvf.rhoName_)
112 {}
113 
114 
115 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
116 
118 {
119  if (updated())
120  {
121  return;
122  }
123 
124  const surfaceScalarField& phi =
125  db().lookupObject<surfaceScalarField>(phiName_);
126 
127  const fvsPatchField<scalar>& phip =
128  patch().patchField<surfaceScalarField, scalar>(phi);
129 
130  tmp<vectorField> n = patch().nf();
131  const Field<scalar>& magS = patch().magSf();
132 
133  if (phi.dimensions() == dimVelocity*dimArea)
134  {
135  refValue() = n*phip/magS;
136  }
137  else if (phi.dimensions() == dimDensity*dimVelocity*dimArea)
138  {
139  const fvPatchField<scalar>& rhop =
140  patch().lookupPatchField<volScalarField, scalar>(rhoName_);
141 
142  refValue() = n*phip/(rhop*magS);
143  }
144  else
145  {
147  << "dimensions of phi are not correct"
148  << "\n on patch " << this->patch().name()
149  << " of field " << this->internalField().name()
150  << " in file " << this->internalField().objectPath()
151  << exit(FatalError);
152  }
153 
154  valueFraction() = 1.0 - pos0(phip);
155 
156  mixedFvPatchVectorField::updateCoeffs();
157 }
158 
159 
161 (
162  Ostream& os
163 ) const
164 {
166  os.writeEntry("phi", phiName_);
167  os.writeEntry("rho", rhoName_);
168  writeEntry("value", os);
169 }
170 
171 
172 // * * * * * * * * * * * * * * * Member Operators * * * * * * * * * * * * * //
173 
174 void Foam::pressureNormalInletOutletVelocityFvPatchVectorField::operator=
175 (
176  const fvPatchField<vector>& pvf
177 )
178 {
180  (
181  valueFraction()*(patch().nf()*(patch().nf() & pvf))
182  + (1 - valueFraction())*pvf
183  );
184 }
185 
186 
187 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
188 
189 namespace Foam
190 {
192  (
195  );
196 }
197 
198 // ************************************************************************* //
Foam::fvPatchField< scalar >
volFields.H
Foam::fvPatchField< vector >::write
virtual void write(Ostream &) const
Write.
Definition: fvPatchField.C:384
p
volScalarField & p
Definition: createFieldRefs.H:8
Foam::pressureNormalInletOutletVelocityFvPatchVectorField
This velocity inlet/outlet boundary condition is applied to patches where the pressure is specified....
Definition: pressureNormalInletOutletVelocityFvPatchVectorField.H:99
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:65
Foam::pressureNormalInletOutletVelocityFvPatchVectorField::pressureNormalInletOutletVelocityFvPatchVectorField
pressureNormalInletOutletVelocityFvPatchVectorField(const fvPatch &, const DimensionedField< vector, volMesh > &)
Construct from patch and internal field.
Definition: pressureNormalInletOutletVelocityFvPatchVectorField.C:40
Foam::tmp
A class for managing temporary objects.
Definition: PtrList.H:61
Foam::Zero
static constexpr const zero Zero
Global zero (0)
Definition: zero.H:131
Foam::dimVelocity
const dimensionSet dimVelocity
Foam::dimDensity
const dimensionSet dimDensity
Foam::fvsPatchField
An abstract base class with a fat-interface to all derived classes covering all possible ways in whic...
Definition: fvsPatchField.H:68
surfaceFields.H
Foam::surfaceFields.
fvPatchFieldMapper.H
Foam::pos0
dimensionedScalar pos0(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:188
Foam::vectorField
Field< vector > vectorField
Specialisation of Field<T> for vector.
Definition: primitiveFieldsFwd.H:54
n
label n
Definition: TABSMDCalcMethod2.H:31
Foam::dimArea
const dimensionSet dimArea(sqr(dimLength))
Definition: dimensionSets.H:59
Foam::Field< scalar >
Foam::fvPatch
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:65
phi
surfaceScalarField & phi
Definition: setRegionFluidFields.H:8
Foam::volScalarField
GeometricField< scalar, fvPatchField, volMesh > volScalarField
Definition: volFieldsFwd.H:57
dict
dictionary dict
Definition: searchingEngine.H:14
Foam::FatalError
error FatalError
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
pressureNormalInletOutletVelocityFvPatchVectorField.H
Foam::exit
errorManipArg< error, int > exit(error &err, const int errNo=1)
Definition: errorManip.H:130
FatalErrorInFunction
#define FatalErrorInFunction
Report an error message using Foam::FatalError.
Definition: error.H:453
Foam::surfaceScalarField
GeometricField< scalar, fvsPatchField, surfaceMesh > surfaceScalarField
Definition: surfaceFieldsFwd.H:54
Foam::foamVersion::patch
const std::string patch
OpenFOAM patch number as a std::string.
Foam::pressureNormalInletOutletVelocityFvPatchVectorField::updateCoeffs
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
Definition: pressureNormalInletOutletVelocityFvPatchVectorField.C:117
Foam::Ostream::writeEntry
Ostream & writeEntry(const keyType &key, const T &value)
Write a keyword/value entry.
Definition: Ostream.H:236
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::GeometricField< scalar, fvsPatchField, surfaceMesh >
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::pressureNormalInletOutletVelocityFvPatchVectorField::write
virtual void write(Ostream &) const
Write.
Definition: pressureNormalInletOutletVelocityFvPatchVectorField.C:161