pressureInletVelocityFvPatchVectorField.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 "volFields.H"
31 #include "surfaceFields.H"
32 
33 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
34 
37 (
38  const fvPatch& p,
40 )
41 :
42  fixedValueFvPatchVectorField(p, iF),
43  phiName_("phi"),
44  rhoName_("rho")
45 {}
46 
47 
50 (
52  const fvPatch& p,
54  const fvPatchFieldMapper& mapper
55 )
56 :
57  fixedValueFvPatchVectorField(ptf, p, iF, mapper),
58  phiName_(ptf.phiName_),
59  rhoName_(ptf.rhoName_)
60 {}
61 
62 
65 (
66  const fvPatch& p,
68  const dictionary& dict
69 )
70 :
71  fixedValueFvPatchVectorField(p, iF, dict),
72  phiName_(dict.lookupOrDefault<word>("phi", "phi")),
73  rhoName_(dict.lookupOrDefault<word>("rho", "rho"))
74 {}
75 
76 
79 (
81 )
82 :
83  fixedValueFvPatchVectorField(pivpvf),
84  phiName_(pivpvf.phiName_),
85  rhoName_(pivpvf.rhoName_)
86 {}
87 
88 
91 (
94 )
95 :
96  fixedValueFvPatchVectorField(pivpvf, iF),
97  phiName_(pivpvf.phiName_),
98  rhoName_(pivpvf.rhoName_)
99 {}
100 
101 
102 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
103 
105 {
106  if (updated())
107  {
108  return;
109  }
110 
111  const surfaceScalarField& phi =
112  db().lookupObject<surfaceScalarField>(phiName_);
113 
114  const fvsPatchField<scalar>& phip =
115  patch().patchField<surfaceScalarField, scalar>(phi);
116 
117  tmp<vectorField> n = patch().nf();
118  const Field<scalar>& magS = patch().magSf();
119 
120  if (phi.dimensions() == dimVelocity*dimArea)
121  {
122  operator==(n*phip/magS);
123  }
124  else if (phi.dimensions() == dimDensity*dimVelocity*dimArea)
125  {
126  const fvPatchField<scalar>& rhop =
127  patch().lookupPatchField<volScalarField, scalar>(rhoName_);
128 
129  operator==(n*phip/(rhop*magS));
130  }
131  else
132  {
134  << "dimensions of phi are not correct"
135  << "\n on patch " << this->patch().name()
136  << " of field " << this->internalField().name()
137  << " in file " << this->internalField().objectPath()
138  << exit(FatalError);
139  }
140 
141  fixedValueFvPatchVectorField::updateCoeffs();
142 }
143 
144 
146 {
148  os.writeEntryIfDifferent<word>("phi", "phi", phiName_);
149  os.writeEntryIfDifferent<word>("rho", "rho", rhoName_);
150  writeEntry("value", os);
151 }
152 
153 
154 // * * * * * * * * * * * * * * * Member Operators * * * * * * * * * * * * * //
155 
156 void Foam::pressureInletVelocityFvPatchVectorField::operator=
157 (
158  const fvPatchField<vector>& pvf
159 )
160 {
161  fvPatchField<vector>::operator=(patch().nf()*(patch().nf() & pvf));
162 }
163 
164 
165 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
166 
167 namespace Foam
168 {
170  (
173  );
174 }
175 
176 // ************************************************************************* //
Foam::fvPatchField< scalar >
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::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::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
pressureInletVelocityFvPatchVectorField.H
surfaceFields.H
Foam::surfaceFields.
n
label n
Definition: TABSMDCalcMethod2.H:31
Foam::dimArea
const dimensionSet dimArea(sqr(dimLength))
Definition: dimensionSets.H:60
Foam::Field< scalar >
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
Foam::pressureInletVelocityFvPatchVectorField::pressureInletVelocityFvPatchVectorField
pressureInletVelocityFvPatchVectorField(const fvPatch &, const DimensionedField< vector, volMesh > &)
Construct from patch and internal field.
Definition: pressureInletVelocityFvPatchVectorField.C:37
phi
surfaceScalarField & phi
Definition: setRegionFluidFields.H:8
Foam::volScalarField
GeometricField< scalar, fvPatchField, volMesh > volScalarField
Definition: volFieldsFwd.H:57
Foam::pressureInletVelocityFvPatchVectorField
This velocity inlet boundary condition is applied to patches where the pressure is specified....
Definition: pressureInletVelocityFvPatchVectorField.H:76
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::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::fvPatchField::operator=
virtual void operator=(const UList< Type > &)
Definition: fvPatchField.C:379
Foam::pressureInletVelocityFvPatchVectorField::updateCoeffs
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
Definition: pressureInletVelocityFvPatchVectorField.C:104
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::pressureInletVelocityFvPatchVectorField::write
virtual void write(Ostream &) const
Write.
Definition: pressureInletVelocityFvPatchVectorField.C:145