pressureDirectedInletVelocityFvPatchVectorField.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-2016 OpenFOAM Foundation
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 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
36 
39 (
40  const fvPatch& p,
42 )
43 :
44  fixedValueFvPatchVectorField(p, iF),
45  phiName_("phi"),
46  rhoName_("rho"),
47  inletDir_(p.size())
48 {}
49 
50 
53 (
55  const fvPatch& p,
57  const fvPatchFieldMapper& mapper
58 )
59 :
60  fixedValueFvPatchVectorField(ptf, p, iF, mapper),
61  phiName_(ptf.phiName_),
62  rhoName_(ptf.rhoName_),
63  inletDir_(ptf.inletDir_, mapper)
64 {}
65 
66 
69 (
70  const fvPatch& p,
72  const dictionary& dict
73 )
74 :
75  fixedValueFvPatchVectorField(p, iF, dict),
76  phiName_(dict.lookupOrDefault<word>("phi", "phi")),
77  rhoName_(dict.lookupOrDefault<word>("rho", "rho")),
78  inletDir_("inletDirection", dict, p.size())
79 {}
80 
81 
84 (
86 )
87 :
88  fixedValueFvPatchVectorField(pivpvf),
89  phiName_(pivpvf.phiName_),
90  rhoName_(pivpvf.rhoName_),
91  inletDir_(pivpvf.inletDir_)
92 {}
93 
94 
97 (
100 )
101 :
102  fixedValueFvPatchVectorField(pivpvf, iF),
103  phiName_(pivpvf.phiName_),
104  rhoName_(pivpvf.rhoName_),
105  inletDir_(pivpvf.inletDir_)
106 {}
107 
108 
109 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
110 
112 (
113  const fvPatchFieldMapper& m
114 )
115 {
116  fixedValueFvPatchVectorField::autoMap(m);
117  inletDir_.autoMap(m);
118 }
119 
120 
122 (
123  const fvPatchVectorField& ptf,
124  const labelList& addr
125 )
126 {
127  fixedValueFvPatchVectorField::rmap(ptf, addr);
128 
130  refCast<const pressureDirectedInletVelocityFvPatchVectorField>(ptf);
131 
132  inletDir_.rmap(tiptf.inletDir_, addr);
133 }
134 
135 
137 {
138  if (updated())
139  {
140  return;
141  }
142 
143  const surfaceScalarField& phi =
144  db().lookupObject<surfaceScalarField>(phiName_);
145 
146  const fvsPatchField<scalar>& phip =
147  patch().patchField<surfaceScalarField, scalar>(phi);
148 
149  tmp<vectorField> n = patch().nf();
150  tmp<scalarField> ndmagS = (n & inletDir_)*patch().magSf();
151 
152  if (phi.dimensions() == dimVelocity*dimArea)
153  {
154  operator==(inletDir_*phip/ndmagS);
155  }
156  else if (phi.dimensions() == dimDensity*dimVelocity*dimArea)
157  {
158  const fvPatchField<scalar>& rhop =
159  patch().lookupPatchField<volScalarField, scalar>(rhoName_);
160 
161  operator==(inletDir_*phip/(rhop*ndmagS));
162  }
163  else
164  {
166  << "dimensions of phi are not correct"
167  << "\n on patch " << this->patch().name()
168  << " of field " << this->internalField().name()
169  << " in file " << this->internalField().objectPath()
170  << exit(FatalError);
171  }
172 
173  fixedValueFvPatchVectorField::updateCoeffs();
174 }
175 
176 
178 (
179  Ostream& os
180 ) const
181 {
183  os.writeEntryIfDifferent<word>("phi", "phi", phiName_);
184  os.writeEntryIfDifferent<word>("rho", "rho", rhoName_);
185  inletDir_.writeEntry("inletDirection", os);
186  writeEntry("value", os);
187 }
188 
189 
190 // * * * * * * * * * * * * * * * Member Operators * * * * * * * * * * * * * //
191 
192 void Foam::pressureDirectedInletVelocityFvPatchVectorField::operator=
193 (
194  const fvPatchField<vector>& pvf
195 )
196 {
197  fvPatchField<vector>::operator=(inletDir_*(inletDir_ & pvf));
198 }
199 
200 
201 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
202 
203 namespace Foam
204 {
206  (
209  );
210 }
211 
212 // ************************************************************************* //
Foam::fvPatchField< vector >
volFields.H
Foam::fvPatchField< vector >::write
virtual void write(Ostream &) const
Write.
Definition: fvPatchField.C:364
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:231
p
volScalarField & p
Definition: createFieldRefs.H:8
Foam::pressureDirectedInletVelocityFvPatchVectorField
This velocity inlet boundary condition is applied to patches where the pressure is specified....
Definition: pressureDirectedInletVelocityFvPatchVectorField.H:105
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:62
Foam::tmp
A class for managing temporary objects.
Definition: PtrList.H:59
Foam::pressureDirectedInletVelocityFvPatchVectorField::updateCoeffs
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
Definition: pressureDirectedInletVelocityFvPatchVectorField.C:136
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::pressureDirectedInletVelocityFvPatchVectorField::rmap
virtual void rmap(const fvPatchVectorField &, const labelList &)
Reverse map the given fvPatchField onto this fvPatchField.
Definition: pressureDirectedInletVelocityFvPatchVectorField.C:122
n
label n
Definition: TABSMDCalcMethod2.H:31
Foam::dimArea
const dimensionSet dimArea(sqr(dimLength))
Definition: dimensionSets.H:60
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:63
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:121
addToRunTimeSelectionTable.H
Macros for easy insertion into run-time selection tables.
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
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:355
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::List< label >
pressureDirectedInletVelocityFvPatchVectorField.H
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::pressureDirectedInletVelocityFvPatchVectorField::write
virtual void write(Ostream &) const
Write.
Definition: pressureDirectedInletVelocityFvPatchVectorField.C:178
Foam::GeometricField< scalar, fvsPatchField, surfaceMesh >
Foam::fvPatchField::operator=
virtual void operator=(const UList< Type > &)
Definition: fvPatchField.C:379
Foam::pressureDirectedInletVelocityFvPatchVectorField::pressureDirectedInletVelocityFvPatchVectorField
pressureDirectedInletVelocityFvPatchVectorField(const fvPatch &, const DimensionedField< vector, volMesh > &)
Construct from patch and internal field.
Definition: pressureDirectedInletVelocityFvPatchVectorField.C:39
Foam::pressureDirectedInletVelocityFvPatchVectorField::autoMap
virtual void autoMap(const fvPatchFieldMapper &)
Map (and resize as needed) from self given a mapping object.
Definition: pressureDirectedInletVelocityFvPatchVectorField.C:112
Foam::DimensionedField
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
Definition: DimensionedField.H:54