uniformInletOutletEnergyTemperatureFvScalarFieldSource.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) 2023-2026 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 
27 #include "fvSource.H"
28 #include "volFields.H"
29 #include "basicThermo.H"
31 
32 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
33 
36 (
38  const dictionary& dict
39 )
40 :
42  uniformInletHe_
43  (
44  Function1<scalar>::New
45  (
46  "uniformInletHe",
47  time().userUnits(),
49  dict
50  )
51  )
52 {}
53 
54 
57 (
60 )
61 :
63  uniformInletHe_(field.uniformInletHe_, false)
64 {}
65 
66 
67 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
68 
71 {}
72 
73 
74 // * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * * //
75 
78 (
79  const fvSource& model,
81 ) const
82 {
83  return
85  (
86  model.name() + ":" + this->internalField().name() + "SourceHeValue",
87  this->internalField().mesh(),
89  (
90  this->internalField().dimensions(),
91  uniformInletHe_->value(this->time().value())
92  )
93  );
94 }
95 
96 
99 (
100  const fvSource& model,
101  const scalarField& source,
102  const labelUList& cells
103 ) const
104 {
105  const scalar v = uniformInletHe_->value(time().value());
106  return tmp<scalarField>(new scalarField(source.size(), v));
107 }
108 
109 
112 (
113  const fvSource& model,
115 ) const
116 {
117  return neg0(source);
118 }
119 
120 
123 (
124  const fvSource& model,
125  const scalarField& source,
126  const labelUList& cells
127 ) const
128 {
129  return neg0(source);
130 }
131 
132 
134 (
135  Ostream& os
136 ) const
137 {
139  writeEntry
140  (
141  os,
142  time().userUnits(),
144  uniformInletHe_()
145  );
146 }
147 
148 
149 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
150 
151 namespace Foam
152 {
154  (
155  fvScalarFieldSource,
157  );
158 }
159 
160 // ************************************************************************* //
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...
static tmp< DimensionedField< Type, GeoMesh, PrimitiveField > > New(const word &name, const GeoMesh &mesh, const dimensionSet &, const PrimitiveField< Type > &)
Return a temporary field constructed from name, mesh,.
Run-time selectable general function of one variable.
Definition: Function1.H:62
void size(const label)
Override size to be inconsistent with allocated storage.
Definition: ListI.H:164
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:57
A list of keywords followed by any number of values (e.g. words and numbers) or sub-dictionaries.
Definition: dictionary.H:162
Base class for temperature source conditions in which the parameters of the corresponding energy cond...
const word & name() const
Return const access to the source name.
Definition: fvModelI.H:57
Base class for finite volume sources.
Definition: fvSource.H:53
A class for managing temporary objects.
Definition: tmp.H:55
This source condition is applied to the temperature field, but provides a uniform fixed energy into t...
virtual tmp< DimensionedField< scalar, fvMesh > > internalCoeff(const fvSource &model, const DimensionedField< scalar, fvMesh > &source) const
Return the internal coefficient.
virtual tmp< DimensionedField< scalar, fvMesh > > sourceHeValue(const fvSource &model, const DimensionedField< scalar, fvMesh > &source) const
Return the source energy value.
uniformInletOutletEnergyTemperatureFvScalarFieldSource(const DimensionedField< scalar, fvMesh > &, const dictionary &dict)
Construct from internal field and dictionary.
const cellShapeList & cells
const dimensionSet time
void write(std::ostream &os, const bool binary, List< floatScalar > &fField)
Write floats ascii or binary.
Namespace for OpenFOAM.
const dimensionSet & dimMass
Definition: dimensions.C:140
Field< scalar > scalarField
Specialisation of Field<T> for scalar.
makeTypeFieldSource(fvScalarFieldSource, turbulentKineticEnergyFvScalarFieldSource)
const dimensionSet & dimEnergy
Definition: dimensions.C:160
dimensionedScalar neg0(const dimensionedScalar &ds)
tmp< DimensionedField< TypeR, GeoMesh, Field > > New(const tmp< DimensionedField< TypeR, GeoMesh, Field >> &tdf1, const word &name, const dimensionSet &dimensions)
void writeEntry(Ostream &os, const word &key, const DimensionedFieldFunction< DimensionedFieldType > &f)
dictionary dict