mixedEnergyFvPatchScalarField.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 
28 #include "fieldMapper.H"
29 #include "volFields.H"
30 #include "basicThermo.H"
32 
33 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
34 
37 (
38  const fvPatch& p,
40 )
41 :
42  mixedFvPatchScalarField(p, iF)
43 {
44  valueFraction() = 0.0;
45  refValue() = 0.0;
46  refGrad() = 0.0;
47 }
48 
49 
52 (
53  const fvPatch& p,
55  const dictionary& dict
56 )
57 :
58  mixedFvPatchScalarField(p, iF, dict)
59 {}
60 
61 
64 (
66  const fvPatch& p,
68  const fieldMapper& mapper
69 )
70 :
71  mixedFvPatchScalarField(ptf, p, iF, mapper, false)
72 {
73  map(ptf, mapper);
74 }
75 
76 
79 (
80  const mixedEnergyFvPatchScalarField& tppsf,
82 )
83 :
84  mixedFvPatchScalarField(tppsf, iF)
85 {}
86 
87 
88 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
89 
91 (
93  const fieldMapper& mapper
94 )
95 {
96  // Unmapped faces are considered zero-gradient/adiabatic
97  mapper(*this, ptf, [&](){ return patchInternalField(); });
98  mapper(refValue(), ptf.refValue(), [&](){ return patchInternalField(); });
99  mapper(refGrad(), ptf.refGrad(), scalar(0));
100  mapper(valueFraction(), ptf.valueFraction(), scalar(0));
101 }
102 
103 
105 (
106  const fvPatchScalarField& ptf,
107  const fieldMapper& mapper
108 )
109 {
110  map(refCast<const mixedEnergyFvPatchScalarField>(ptf), mapper);
111 }
112 
113 
115 {
116  if (updated())
117  {
118  return;
119  }
120 
122  const label patchi = patch().index();
123 
124  fvPatchScalarField& Tp =
125  const_cast<fvPatchScalarField&>(thermo.T().boundaryField()[patchi]);
126 
127  if (isA<mixedFvPatchScalarField>(Tp))
128  {
129  mixedFvPatchScalarField& Tm =
130  refCast<mixedFvPatchScalarField>(Tp);
131 
132  Tm.evaluate();
133 
134  valueFraction() = Tm.valueFraction();
135  refValue() = thermo.he(Tm.refValue(), patchi);
136  refGrad() =
137  thermo.Cpv(Tm, patchi)*Tm.refGrad()
138  + patch().deltaCoeffs()*
139  (
140  thermo.he(Tm, patchi)
141  - thermo.he(Tm, patch().faceCells())
142  );
143  }
144  else if (isA<mixedEnergyCalculatedTemperatureFvPatchScalarField>(Tp))
145  {
147  refCast<mixedEnergyCalculatedTemperatureFvPatchScalarField>(Tp);
148 
149  Tm.evaluate();
150 
151  valueFraction() = Tm.heValueFraction();
152  refValue() = Tm.heRefValue();
153  refGrad() = Tm.heRefGrad();
154  }
155  else
156  {
158  << "Temperature boundary condition not recognised."
159  << "A " << typeName << " condition for energy must be used with a "
160  << mixedFvPatchScalarField::typeName << " or "
161  << mixedEnergyCalculatedTemperatureFvPatchScalarField::typeName
162  << " condition for temperature."
163  << exit(FatalError);
164  }
165 
166  mixedFvPatchScalarField::updateCoeffs();
167 }
168 
169 
170 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
171 
172 namespace Foam
173 {
175  (
178  );
179 }
180 
181 // ************************************************************************* //
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.
Base-class for fluid and solid thermodynamic properties.
Definition: basicThermo.H:78
static const basicThermo & lookupThermo(const FieldType &f)
Lookup the thermo associated with the given field.
virtual const volScalarField & T() const =0
Temperature [K].
virtual const volScalarField & Cpv() const =0
Heat capacity at constant pressure/volume [J/kg/K].
virtual const volScalarField & he() const =0
Enthalpy/Internal energy [J/kg].
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:162
Abstract base class for field mapping.
Definition: fieldMapper.H:48
Abstract base class with a fat-interface to all derived classes covering all possible ways in which t...
Definition: fvPatchField.H:88
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 mixed energy condition ...
This boundary condition provides a mixed condition for energy. This is selected when the correspondin...
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
void map(const mixedEnergyFvPatchScalarField &, const fieldMapper &)
Map the given fvPatchField onto this fvPatchField.
mixedEnergyFvPatchScalarField(const fvPatch &, const DimensionedField< scalar, volMesh > &)
Construct from patch and internal field.
#define FatalErrorInFunction
Report an error message using Foam::FatalError.
Definition: error.H:334
label patchi
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)
error FatalError
dictionary dict
volScalarField & p
fluidMulticomponentThermo & thermo
Definition: createFields.H:31