compressibleMomentumTransportModel.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) 2013-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 Class
25  Foam::compressibleMomentumTransportModel
26 
27 Description
28  Base class for single-phase compressible turbulence models.
29 
30 SourceFiles
31  compressibleMomentumTransportModel.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef compressibleMomentumTransportModel_H
36 #define compressibleMomentumTransportModel_H
37 
38 #include "momentumTransportModel.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 /*---------------------------------------------------------------------------*\
46  Class compressibleMomentumTransportModel Declaration
47 \*---------------------------------------------------------------------------*/
48 
50 :
52 {
53 
54 public:
55 
57  typedef volScalarField rhoField;
58 
59 
60 protected:
61 
62  // Protected data
63 
65  const rhoField& rho_;
66 
67 
68 public:
69 
70  // Declare run-time constructor selection table
71 
73  (
74  autoPtr,
76  dictionary,
77  (
78  const alphaField& alpha,
79  const rhoField& rho,
80  const volVectorField& U,
82  const surfaceScalarField& phi,
83  const viscosity& viscosity
84  ),
86  );
87 
88 
89  // Constructors
90 
91  //- Construct
93  (
94  const word& type,
95  const geometricOneField& alpha,
96  const volScalarField& rho,
97  const volVectorField& U,
99  const surfaceScalarField& phi,
100  const viscosity& viscosity
101  );
102 
103 
104  // Selectors
105 
106  //- Return a reference to the selected turbulence model
108  (
109  const volScalarField& rho,
110  const volVectorField& U,
111  const surfaceScalarField& phi,
112  const viscosity& viscosity
113  );
114 
115 
116  //- Destructor
118  {}
119 
120 
121  // Member Functions
122 
123  //- Return the phase fraction field
124  const alphaField& alpha() const
125  {
126  return alpha_;
127  }
128 
129  //- Return the density field
130  const rhoField& rho() const
131  {
132  return rho_;
133  }
134 
135  //- Return the volumetric flux field
136  virtual tmp<surfaceScalarField> phi() const;
137 
138  //- Return the effective stress tensor including the laminar stress
139  virtual tmp<volSymmTensorField> devTau() const = 0;
140 
141  //- Return the stress matrix for the momentum equation
142  virtual tmp<fvVectorMatrix> divDevTau(volVectorField& U) const = 0;
143 };
144 
145 
146 namespace compressible
147 {
149 
150  template<class CompressibleMomentumTransportModel>
152  (
153  const volScalarField& rho,
154  const volVectorField& U,
155  const surfaceScalarField& phi,
156  const viscosity& viscosity
157  );
158 }
159 
160 
161 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
162 
163 } // End namespace Foam
164 
165 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
166 
167 #ifdef NoRepository
169 #endif
170 
171 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
172 
173 #endif
174 
175 // ************************************************************************* //
Generic GeometricField class.
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: autoPtr.H:51
Base class for single-phase compressible turbulence models.
virtual tmp< fvVectorMatrix > divDevTau(volVectorField &U) const =0
Return the stress matrix for the momentum equation.
declareRunTimeNewSelectionTable(autoPtr, compressibleMomentumTransportModel, dictionary,(const alphaField &alpha, const rhoField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const viscosity &viscosity),(alpha, rho, U, alphaRhoPhi, phi, viscosity))
const alphaField & alpha() const
Return the phase fraction field.
static autoPtr< compressibleMomentumTransportModel > New(const volScalarField &rho, const volVectorField &U, const surfaceScalarField &phi, const viscosity &viscosity)
Return a reference to the selected turbulence model.
virtual tmp< surfaceScalarField > phi() const
Return the volumetric flux field.
const rhoField & rho() const
Return the density field.
compressibleMomentumTransportModel(const word &type, const geometricOneField &alpha, const volScalarField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const viscosity &viscosity)
Construct.
virtual tmp< volSymmTensorField > devTau() const =0
Return the effective stress tensor including the laminar stress.
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:162
A class representing the concept of a GeometricField of 1 used to avoid unnecessary manipulations for...
Abstract base class for turbulence models (RAS, LES and laminar).
const volVectorField & U() const
Access function to velocity field.
const surfaceScalarField & alphaRhoPhi() const
Access function to phase flux field.
A class for managing temporary objects.
Definition: tmp.H:55
Abstract base class for all fluid physical properties.
Definition: viscosity.H:50
A class for handling words, derived from string.
Definition: word.H:62
U
Definition: pEqn.H:72
compressibleMomentumTransportModel momentumTransportModel
autoPtr< CompressibleMomentumTransportModel > New(const volScalarField &rho, const volVectorField &U, const surfaceScalarField &phi, const viscosity &viscosity)
Namespace for OpenFOAM.
fileType type(const fileName &, const bool checkVariants=true, const bool followLink=true)
Return the file type: directory or file.
Definition: POSIX.C:488