fluidThermophysicalTransportModel.H
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) 2022-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 Class
25  Foam::fluidThermophysicalTransportModel
26 
27 Description
28  Abstract base class for fluid thermophysical transport models
29  RAS, LES and laminar.
30 
31 SourceFiles
32  fluidThermophysicalTransportModel.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef fluidThermophysicalTransportModel_H
37 #define fluidThermophysicalTransportModel_H
38 
41 #include "fluidThermo.H"
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 
48 /*---------------------------------------------------------------------------*\
49  Class fluidThermophysicalTransportModel Declaration
50 \*---------------------------------------------------------------------------*/
51 
53 :
55 {
56 protected:
57 
58  // Protected data
59 
61 
62 
63 public:
64 
65  // Constructors
66 
67  //- Construct from compressibleMomentumTransportModel
69  (
71  const word& group
72  );
73 
74 
75  //- Destructor
77  {}
78 
79 
80  // Member Functions
81 
82  //- Access function to momentum transport model
84  {
86  }
87 
88  //- Access function to fluid thermophysical properties
89  virtual const fluidThermo& thermo() const = 0;
90 
91  //- Effective thermal turbulent diffusivity
92  // of mixture for a patch [kg/m/s]
93  virtual tmp<scalarField> alphaEff(const label patchi) const = 0;
94 
95  //- Mass diffusivity
96  // for a given specie mass-fraction [kg/m/s]
97  virtual tmp<volScalarField> D(const volScalarField& Yi) const = 0;
98 
99  //- Mass diffusivity
100  // for a given specie mass-fraction for patch [kg/m/s]
101  virtual tmp<scalarField> D
102  (
103  const volScalarField& Yi,
104  const label patchi
105  ) const = 0;
106 
107  //- Effective mass diffusion coefficient
108  // for a given specie mass-fraction [kg/m/s]
109  virtual tmp<volScalarField> DEff(const volScalarField& Yi) const = 0;
110 
111  //- Effective mass diffusion coefficient
112  // for a given specie mass-fraction for patch [kg/m/s]
113  virtual tmp<scalarField> DEff
114  (
115  const volScalarField& Yi,
116  const label patchi
117  ) const = 0;
118 
119  //- Return the patch heat flux correction [W/m^2]
120  // For isotropic or patch-aligned thermal conductivity qCorr is null
121  virtual tmp<scalarField> qCorr(const label patchi) const;
122 
123  //- Return the specie flux for the given specie mass-fraction [kg/m^2/s]
124  virtual tmp<surfaceScalarField> j(const volScalarField& Yi) const = 0;
125 
126  //- Return the specie flux
127  // for the given specie mass-fraction for patch [kg/m^2/s]
128  virtual tmp<scalarField> j
129  (
130  const volScalarField& Yi,
131  const label patchi
132  ) const = 0;
133 
134  //- Return the source term for the given specie mass-fraction equation
135  virtual tmp<fvScalarMatrix> divj(volScalarField& Yi) const = 0;
136 };
137 
138 
139 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
140 
141 } // End namespace Foam
142 
143 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
144 
145 #endif
146 
147 // ************************************************************************* //
Generic GeometricField class.
word group() const
Return group (extension part of name)
Definition: IOobject.C:321
Base class for single-phase compressible momentum transport models.
Base-class for fluid thermodynamic properties.
Definition: fluidThermo.H:56
Abstract base class for fluid thermophysical transport models RAS, LES and laminar.
virtual tmp< scalarField > alphaEff(const label patchi) const =0
Effective thermal turbulent diffusivity.
const compressibleMomentumTransportModel & momentumTransport() const
Access function to momentum transport model.
virtual tmp< volScalarField > D(const volScalarField &Yi) const =0
Mass diffusivity.
virtual tmp< scalarField > qCorr(const label patchi) const
Return the patch heat flux correction [W/m^2].
virtual tmp< volScalarField > DEff(const volScalarField &Yi) const =0
Effective mass diffusion coefficient.
fluidThermophysicalTransportModel(const compressibleMomentumTransportModel &momentumTransport, const word &group)
Construct from compressibleMomentumTransportModel.
virtual tmp< surfaceScalarField > j(const volScalarField &Yi) const =0
Return the specie flux for the given specie mass-fraction [kg/m^2/s].
const compressibleMomentumTransportModel & momentumTransportModel_
virtual const fluidThermo & thermo() const =0
Access function to fluid thermophysical properties.
virtual tmp< fvScalarMatrix > divj(volScalarField &Yi) const =0
Return the source term for the given specie mass-fraction equation.
Abstract base class for all fluid and solid thermophysical transport models.
A class for managing temporary objects.
Definition: tmp.H:55
A class for handling words, derived from string.
Definition: word.H:63
label patchi
Namespace for OpenFOAM.
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