fluxCorrectedVelocityFvPatchVectorField.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-2021 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 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
33 
36 (
37  const fvPatch& p,
39 )
40 :
41  zeroGradientFvPatchVectorField(p, iF),
42  phiName_("phi"),
43  rhoName_("rho")
44 {}
45 
46 
49 (
50  const fvPatch& p,
52  const dictionary& dict
53 )
54 :
55  zeroGradientFvPatchVectorField(p, iF),
56  phiName_(dict.lookupOrDefault<word>("phi", "phi")),
57  rhoName_(dict.lookupOrDefault<word>("rho", "rho"))
58 {
59  fvPatchVectorField::operator=(patchInternalField());
60 }
61 
62 
65 (
67  const fvPatch& p,
69  const fvPatchFieldMapper& mapper
70 )
71 :
72  zeroGradientFvPatchVectorField(ptf, p, iF, mapper),
73  phiName_(ptf.phiName_),
74  rhoName_(ptf.rhoName_)
75 {}
76 
77 
80 (
83 )
84 :
85  zeroGradientFvPatchVectorField(fcvpvf, iF),
86  phiName_(fcvpvf.phiName_),
87  rhoName_(fcvpvf.rhoName_)
88 {}
89 
90 
91 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
92 
94 (
96 )
97 {
98  if (!updated())
99  {
100  updateCoeffs();
101  }
102 
104 
105  const surfaceScalarField& phi =
106  db().lookupObject<surfaceScalarField>(phiName_);
107 
108  const fvsPatchField<scalar>& phip =
109  patch().patchField<surfaceScalarField, scalar>(phi);
110 
111  const vectorField n(patch().nf());
112  const Field<scalar>& magS = patch().magSf();
113 
114  if (phi.dimensions() == dimFlux)
115  {
116  operator==(*this - n*(n & *this) + n*phip/magS);
117  }
118  else if (phi.dimensions() == dimMassFlux)
119  {
120  const fvPatchField<scalar>& rhop =
121  patch().lookupPatchField<volScalarField, scalar>(rhoName_);
122 
123  operator==(*this - n*(n & *this) + n*phip/(rhop*magS));
124  }
125  else
126  {
128  << "dimensions of phi are incorrect\n"
129  << " on patch " << this->patch().name()
130  << " of field " << this->internalField().name()
131  << " in file " << this->internalField().objectPath()
132  << exit(FatalError);
133  }
134 }
135 
136 
138 {
140  writeEntryIfDifferent<word>(os, "phi", "phi", phiName_);
141  writeEntryIfDifferent<word>(os, "rho", "rho", rhoName_);
142  writeEntry(os, "value", *this);
143 }
144 
145 
146 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
147 
148 namespace Foam
149 {
151  (
154  );
155 }
156 
157 // ************************************************************************* //
Foam::surfaceFields.
errorManipArg< error, int > exit(error &err, const int errNo=1)
Definition: errorManip.H:124
void evaluate(GeometricField< Type, PatchField, GeoMesh > &result, const Function1< Type > &func, const GeometricField< Type, PatchField, GeoMesh > &x)
error FatalError
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
#define FatalErrorInFunction
Report an error message using Foam::FatalError.
Definition: error.H:323
commsTypes
Types of communications.
Definition: UPstream.H:64
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:62
Abstract base class with a fat-interface to all derived classes covering all possible ways in which t...
Definition: fvPatchField.H:66
virtual void write(Ostream &) const
Write.
Definition: fvPatchField.C:260
Macros for easy insertion into run-time selection tables.
GeometricField< scalar, fvPatchField, volMesh > volScalarField
Definition: volFieldsFwd.H:57
const dimensionSet & dimensions() const
Return dimensions.
tmp< fvMatrix< Type > > operator==(const fvMatrix< Type > &, const fvMatrix< Type > &)
A class for handling words, derived from string.
Definition: word.H:59
Foam::fvPatchFieldMapper.
const dimensionSet dimFlux
fluxCorrectedVelocityFvPatchVectorField(const fvPatch &, const DimensionedField< vector, volMesh > &)
Construct from patch and internal field.
phi
Definition: correctPhi.H:3
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:54
void writeEntry(Ostream &os, const HashTable< T, Key, Hash > &ht)
Definition: HashTableIO.C:96
This boundary condition provides a velocity outlet boundary condition for patches where the pressure ...
const dimensionSet dimMassFlux
T lookupOrDefault(const word &, const T &, bool recursive=false, bool patternMatch=true) const
Find and return a T,.
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
virtual void evaluate(const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)
Evaluate the patch field.
label n
GeometricField< scalar, fvsPatchField, surfaceMesh > surfaceScalarField
makePatchTypeField(fvPatchScalarField, atmBoundaryLayerInletEpsilonFvPatchScalarField)
An abstract base class with a fat-interface to all derived classes covering all possible ways in whic...
Definition: fvsPatchField.H:65
Namespace for OpenFOAM.