fluxCorrectedVelocityFvPatchVectorField.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  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 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
36 
39 (
40  const fvPatch& p,
42 )
43 :
44  zeroGradientFvPatchVectorField(p, iF),
45  phiName_("phi"),
46  rhoName_("rho")
47 {}
48 
49 
52 (
54  const fvPatch& p,
56  const fvPatchFieldMapper& mapper
57 )
58 :
59  zeroGradientFvPatchVectorField(ptf, p, iF, mapper),
60  phiName_(ptf.phiName_),
61  rhoName_(ptf.rhoName_)
62 {}
63 
64 
67 (
68  const fvPatch& p,
70  const dictionary& dict
71 )
72 :
73  zeroGradientFvPatchVectorField(p, iF),
74  phiName_(dict.getOrDefault<word>("phi", "phi")),
75  rhoName_(dict.getOrDefault<word>("rho", "rho"))
76 {
77  patchType() = dict.getOrDefault<word>("patchType", word::null);
78  fvPatchVectorField::operator=(patchInternalField());
79 }
80 
81 
84 (
87 )
88 :
89  zeroGradientFvPatchVectorField(fcvpvf, iF),
90  phiName_(fcvpvf.phiName_),
91  rhoName_(fcvpvf.rhoName_)
92 {}
93 
94 
95 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
96 
98 (
100 )
101 {
102  if (!updated())
103  {
104  updateCoeffs();
105  }
106 
108 
109  const surfaceScalarField& phi =
110  db().lookupObject<surfaceScalarField>(phiName_);
111 
112  const fvsPatchField<scalar>& phip =
113  patch().patchField<surfaceScalarField, scalar>(phi);
114 
115  const vectorField n(patch().nf());
116  const Field<scalar>& magS = patch().magSf();
117 
118  if (phi.dimensions() == dimVelocity*dimArea)
119  {
120  operator==(*this - n*(n & *this) + n*phip/magS);
121  }
122  else if (phi.dimensions() == dimDensity*dimVelocity*dimArea)
123  {
124  const fvPatchField<scalar>& rhop =
125  patch().lookupPatchField<volScalarField, scalar>(rhoName_);
126 
127  operator==(*this - n*(n & *this) + n*phip/(rhop*magS));
128  }
129  else
130  {
132  << "dimensions of phi are incorrect\n"
133  << " on patch " << this->patch().name()
134  << " of field " << this->internalField().name()
135  << " in file " << this->internalField().objectPath()
136  << exit(FatalError);
137  }
138 }
139 
140 
142 {
144  os.writeEntryIfDifferent<word>("phi", "phi", phiName_);
145  os.writeEntryIfDifferent<word>("rho", "rho", rhoName_);
146  writeEntry("value", os);
147 }
148 
149 
150 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
151 
152 namespace Foam
153 {
155  (
158  );
159 }
160 
161 // ************************************************************************* //
Foam::fvPatchField< scalar >
volFields.H
Foam::fluxCorrectedVelocityFvPatchVectorField::write
virtual void write(Ostream &) const
Write.
Definition: fluxCorrectedVelocityFvPatchVectorField.C:141
Foam::fvPatchField< vector >::write
virtual void write(Ostream &) const
Write.
Definition: fvPatchField.C:384
p
volScalarField & p
Definition: createFieldRefs.H:8
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:65
Foam::dimVelocity
const dimensionSet dimVelocity
Foam::dimDensity
const dimensionSet dimDensity
fluxCorrectedVelocityFvPatchVectorField.H
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::fluxCorrectedVelocityFvPatchVectorField::fluxCorrectedVelocityFvPatchVectorField
fluxCorrectedVelocityFvPatchVectorField(const fvPatch &, const DimensionedField< vector, volMesh > &)
Construct from patch and internal field.
Definition: fluxCorrectedVelocityFvPatchVectorField.C:39
Foam::fluxCorrectedVelocityFvPatchVectorField
This boundary condition provides a velocity outlet boundary condition for patches where the pressure ...
Definition: fluxCorrectedVelocityFvPatchVectorField.H:131
n
label n
Definition: TABSMDCalcMethod2.H:31
Foam::dimArea
const dimensionSet dimArea(sqr(dimLength))
Definition: dimensionSets.H:59
Foam::Field< vector >
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
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
Foam::exit
errorManipArg< error, int > exit(error &err, const int errNo=1)
Definition: errorManip.H:130
Foam::fluxCorrectedVelocityFvPatchVectorField::evaluate
virtual void evaluate(const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)
Evaluate the patch field.
Definition: fluxCorrectedVelocityFvPatchVectorField.C:98
Foam::UPstream::commsTypes
commsTypes
Types of communications.
Definition: UPstream.H:69
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::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::stringOps::evaluate
string evaluate(label fieldWidth, const std::string &s, size_t pos=0, size_t len=std::string::npos)
String evaluation with specified (positive, non-zero) field width.
Definition: stringOpsEvaluate.C:37