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 | Copyright (C) 2011-2012 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 (
51  const fvPatch& p,
53  const fvPatchFieldMapper& mapper
54 )
55 :
56  zeroGradientFvPatchVectorField(ptf, p, iF, mapper),
57  phiName_(ptf.phiName_),
58  rhoName_(ptf.rhoName_)
59 {}
60 
61 
64 (
65  const fvPatch& p,
67  const dictionary& dict
68 )
69 :
70  zeroGradientFvPatchVectorField(p, iF),
71  phiName_(dict.lookupOrDefault<word>("phi", "phi")),
72  rhoName_(dict.lookupOrDefault<word>("rho", "rho"))
73 {
74  fvPatchVectorField::operator=(patchInternalField());
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 
103  zeroGradientFvPatchVectorField::evaluate();
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() == dimVelocity*dimArea)
115  {
116  operator==(*this - n*(n & *this) + n*phip/magS);
117  }
118  else if (phi.dimensions() == dimDensity*dimVelocity*dimArea)
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  (
129  "fluxCorrectedVelocityFvPatchVectorField::evaluate()"
130  )
131  << "dimensions of phi are incorrect\n"
132  << " on patch " << this->patch().name()
133  << " of field " << this->dimensionedInternalField().name()
134  << " in file " << this->dimensionedInternalField().objectPath()
135  << exit(FatalError);
136  }
137 }
138 
139 
141 {
143  writeEntryIfDifferent<word>(os, "phi", "phi", phiName_);
144  writeEntryIfDifferent<word>(os, "rho", "rho", rhoName_);
145  writeEntry("value", os);
146 }
147 
148 
149 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
150 
151 namespace Foam
152 {
154  (
157  );
158 }
159 
160 // ************************************************************************* //
Foam::surfaceFields.
tmp< fvMatrix< Type > > operator==(const fvMatrix< Type > &, const fvMatrix< Type > &)
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::blocking)
Evaluate the patch field.
const dimensionSet dimArea(sqr(dimLength))
Definition: dimensionSets.H:57
A class for handling words, derived from string.
Definition: word.H:59
errorManipArg< error, int > exit(error &err, const int errNo=1)
Definition: errorManip.H:124
Foam::fvPatchFieldMapper.
fluxCorrectedVelocityFvPatchVectorField(const fvPatch &, const DimensionedField< vector, volMesh > &)
Construct from patch and internal field.
const dimensionSet dimDensity
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
virtual void write(Ostream &) const
Write.
Definition: fvPatchField.C:354
Namespace for OpenFOAM.
label n
GeometricField< scalar, fvPatchField, volMesh > volScalarField
Definition: volFieldsFwd.H:52
commsTypes
Types of communications.
Definition: UPstream.H:64
GeometricField< scalar, fvsPatchField, surfaceMesh > surfaceScalarField
Macros for easy insertion into run-time selection tables.
const dimensionSet & dimensions() const
Return dimensions.
Abstract base class with a fat-interface to all derived classes covering all possible ways in which t...
Definition: fvPatchField.H:65
surfaceScalarField & phi
#define FatalErrorIn(functionName)
Report an error message using Foam::FatalError.
Definition: error.H:314
rDeltaT dimensionedInternalField()
This boundary condition provides a velocity outlet boundary condition for patches where the pressure ...
error FatalError
T lookupOrDefault(const word &, const T &, bool recursive=false, bool patternMatch=true) const
Find and return a T,.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:53
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:61
makePatchTypeField(fvPatchVectorField, SRFFreestreamVelocityFvPatchVectorField)
const dimensionSet dimVelocity
An abstract base class with a fat-interface to all derived classes covering all possible ways in whic...
Definition: fvsPatchField.H:65