filmHeightInletVelocityFvPatchVectorField.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) 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 "volFields.H"
32 #include "surfaceFields.H"
33 
34 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
35 
38 (
39  const fvPatch& p,
41 )
42 :
43  fixedValueFvPatchVectorField(p, iF),
44  phiName_("phi"),
45  rhoName_("rho"),
46  deltafName_("deltaf")
47 {}
48 
49 
52 (
54  const fvPatch& p,
56  const fvPatchFieldMapper& mapper
57 )
58 :
59  fixedValueFvPatchVectorField(ptf, p, iF, mapper),
60  phiName_(ptf.phiName_),
61  rhoName_(ptf.rhoName_),
62  deltafName_(ptf.deltafName_)
63 {}
64 
65 
68 (
69  const fvPatch& p,
71  const dictionary& dict
72 )
73 :
74  fixedValueFvPatchVectorField(p, iF, dict),
75  phiName_(dict.getOrDefault<word>("phi", "phi")),
76  rhoName_(dict.getOrDefault<word>("rho", "rho")),
77  deltafName_(dict.getOrDefault<word>("deltaf", "deltaf"))
78 {}
79 
80 
83 (
85 )
86 :
87  fixedValueFvPatchVectorField(fhivpvf),
88  phiName_(fhivpvf.phiName_),
89  rhoName_(fhivpvf.rhoName_),
90  deltafName_(fhivpvf.deltafName_)
91 {}
92 
93 
96 (
99 )
100 :
101  fixedValueFvPatchVectorField(fhivpvf, iF),
102  phiName_(fhivpvf.phiName_),
103  rhoName_(fhivpvf.rhoName_),
104  deltafName_(fhivpvf.deltafName_)
105 {}
106 
107 
108 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
109 
111 {
112  if (updated())
113  {
114  return;
115  }
116 
117  const fvsPatchField<scalar>& phip =
118  patch().lookupPatchField<surfaceScalarField, scalar>(phiName_);
119 
120  const fvPatchField<scalar>& rhop =
121  patch().lookupPatchField<volScalarField, scalar>(rhoName_);
122 
123  const fvPatchField<scalar>& deltafp =
124  patch().lookupPatchField<volScalarField, scalar>(deltafName_);
125 
126  vectorField n(patch().nf());
127  const scalarField& magSf = patch().magSf();
129  operator==(n*phip/(rhop*magSf*deltafp + ROOTVSMALL));
130 
131  fixedValueFvPatchVectorField::updateCoeffs();
132 }
133 
134 
136 {
138  os.writeEntryIfDifferent<word>("phi", "phi", phiName_);
139  os.writeEntryIfDifferent<word>("rho", "rho", rhoName_);
140  os.writeEntryIfDifferent<word>("deltaf", "deltaf", deltafName_);
141  writeEntry("value", os);
142 }
143 
144 
145 // * * * * * * * * * * * * * * * Member Operators * * * * * * * * * * * * * //
146 
147 void Foam::filmHeightInletVelocityFvPatchVectorField::operator=
148 (
149  const fvPatchField<vector>& pvf
150 )
151 {
152  fvPatchField<vector>::operator=(patch().nf()*(patch().nf() & pvf));
153 }
154 
155 
156 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
157 
158 namespace Foam
159 {
161  (
163  filmHeightInletVelocityFvPatchVectorField
164  );
165 }
166 
167 
168 // ************************************************************************* //
Foam::surfaceFields.
dictionary dict
fvPatchField< vector > fvPatchVectorField
A list of keyword definitions, which are a keyword followed by a number of values (eg...
Definition: dictionary.H:120
filmHeightInletVelocityFvPatchVectorField(const fvPatch &, const DimensionedField< vector, volMesh > &)
Construct from patch and internal field.
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:68
Abstract base class with a fat-interface to all derived classes covering all possible ways in which t...
virtual void write(Ostream &) const
Write.
Definition: fvPatchField.C:333
This boundary condition is designed to be used in conjunction with surface film modelling. It provides a velocity inlet boundary condition for patches where the film height is specified. The inflow velocity is obtained from the flux with a direction normal to the patch faces using:
Macros for easy insertion into run-time selection tables.
GeometricField< scalar, fvPatchField, volMesh > volScalarField
Definition: volFieldsFwd.H:84
A class for handling words, derived from Foam::string.
Definition: word.H:63
Field< scalar > scalarField
Specialisation of Field<T> for scalar.
A FieldMapper for finite-volume patch fields.
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:327
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:55
OBJstream os(runTime.globalPath()/outputName)
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
virtual void operator=(const UList< Type > &)
Definition: fvPatchField.C:352
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
Definition: areaFieldsFwd.H:42
const std::string patch
OpenFOAM patch number as a std::string.
label n
Field< vector > vectorField
Specialisation of Field<T> for vector.
volScalarField & p
GeometricField< scalar, fvsPatchField, surfaceMesh > surfaceScalarField
tmp< faMatrix< Type > > operator==(const faMatrix< Type > &, const faMatrix< Type > &)
makePatchTypeField(fvPatchScalarField, atmBoundaryLayerInletEpsilonFvPatchScalarField)
Namespace for OpenFOAM.