gradientEnergyFvPatchScalarField.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-2023 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 
30 #include "fvPatchFieldMapper.H"
31 #include "volFields.H"
32 #include "basicThermo.H"
33 
34 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
35 
38 (
39  const fvPatch& p,
41 )
42 :
43  fixedGradientFvPatchScalarField(p, iF)
44 {}
45 
46 
49 (
50  const fvPatch& p,
52  const dictionary& dict
53 )
54 :
55  fixedGradientFvPatchScalarField(p, iF, dict)
56 {}
57 
58 
61 (
63  const fvPatch& p,
65  const fvPatchFieldMapper& mapper
66 )
67 :
68  fixedGradientFvPatchScalarField(ptf, p, iF, mapper)
69 {}
70 
71 
74 (
77 )
78 :
79  fixedGradientFvPatchScalarField(tppsf, iF)
80 {}
81 
82 
83 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
84 
86 {
87  if (updated())
88  {
89  return;
90  }
91 
93  const label patchi = patch().index();
94 
95  fvPatchScalarField& Tp =
96  const_cast<fvPatchScalarField&>(thermo.T().boundaryField()[patchi]);
97 
98  Tp.evaluate();
99 
100  if
101  (
102  isA<zeroGradientFvPatchScalarField>(Tp)
103  || isA<fixedGradientFvPatchScalarField>(Tp)
104  )
105  {
106  gradient() =
107  thermo.Cpv(Tp, patchi)*Tp.snGrad()
108  + patch().deltaCoeffs()*
109  (
110  thermo.he(Tp, patchi)
111  - thermo.he(Tp, patch().faceCells())
112  );
113  }
114  else if (isA<gradientEnergyCalculatedTemperatureFvPatchScalarField>(Tp))
115  {
117  refCast<gradientEnergyCalculatedTemperatureFvPatchScalarField>(Tp);
118 
119  gradient() = Tg.heGradient();
120  }
121  else
122  {
124  << "Temperature boundary condition not recognised."
125  << "A " << typeName << " condition for energy must be used with a "
126  << zeroGradientFvPatchScalarField::typeName << ", "
127  << fixedGradientFvPatchScalarField::typeName << " or "
128  << gradientEnergyCalculatedTemperatureFvPatchScalarField::typeName
129  << " condition for temperature."
130  << exit(FatalError);
131  }
132 
133  fixedGradientFvPatchScalarField::updateCoeffs();
134 }
135 
136 
138 {
140  writeEntry(os, "value", *this);
141 }
142 
143 
144 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
145 
146 namespace Foam
147 {
149  (
152  );
153 }
154 
155 // ************************************************************************* //
Macros for easy insertion into run-time selection tables.
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
const Boundary & boundaryField() const
Return const-reference to the boundary field.
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:57
Base-class for fluid and solid thermodynamic properties.
Definition: basicThermo.H:78
static const basicThermo & lookupThermo(const fvPatchScalarField &pf)
Lookup the thermo associated with the given patch field.
Definition: basicThermo.C:81
virtual volScalarField & he()=0
Enthalpy/Internal energy [J/kg].
virtual const volScalarField & T() const =0
Temperature [K].
virtual const volScalarField & Cpv() const =0
Heat capacity at constant pressure/volume [J/kg/K].
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:160
Foam::fvPatchFieldMapper.
Abstract base class with a fat-interface to all derived classes covering all possible ways in which t...
Definition: fvPatchField.H:87
virtual void evaluate(const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)
Evaluate the patch field, sets Updated to false.
Definition: fvPatchField.C:211
virtual tmp< Field< Type > > snGrad() const
Return patch-normal gradient.
Definition: fvPatchField.C:164
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:64
Base class for temperature boundary conditions in which the parameters of the gradient energy conditi...
This boundary condition provides a gradient condition for energy. This is selected when the correspon...
gradientEnergyFvPatchScalarField(const fvPatch &, const DimensionedField< scalar, volMesh > &)
Construct from patch and internal field.
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
#define FatalErrorInFunction
Report an error message using Foam::FatalError.
Definition: error.H:306
label patchi
void write(std::ostream &os, const bool binary, List< floatScalar > &fField)
Write floats ascii or binary.
Namespace for OpenFOAM.
errorManipArg< error, int > exit(error &err, const int errNo=1)
Definition: errorManip.H:124
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
makeNullConstructablePatchTypeField(fvPatchVectorField, noSlipFvPatchVectorField)
void writeEntry(Ostream &os, const HashTable< T, Key, Hash > &ht)
Definition: HashTableIO.C:96
error FatalError
dictionary dict
volScalarField & p
fluidMulticomponentThermo & thermo
Definition: createFields.H:31