All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
linearViscousStress.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-2020 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::linearViscousStress
26 
27 Description
28  Linear viscous stress turbulence model base class
29 
30 SourceFiles
31  linearViscousStress.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef linearViscousStress_H
36 #define linearViscousStress_H
37 
38 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
39 
40 namespace Foam
41 {
42 
43 /*---------------------------------------------------------------------------*\
44  Class linearViscousStress Declaration
45 \*---------------------------------------------------------------------------*/
46 
47 template<class BasicMomentumTransportModel>
49 :
50  public BasicMomentumTransportModel
51 {
52 
53 public:
54 
55  typedef typename BasicMomentumTransportModel::alphaField alphaField;
56  typedef typename BasicMomentumTransportModel::rhoField rhoField;
57  typedef typename BasicMomentumTransportModel::transportModel transportModel;
58 
59 
60  // Constructors
61 
62  //- Construct from components
64  (
65  const word& modelName,
66  const alphaField& alpha,
67  const rhoField& rho,
68  const volVectorField& U,
69  const surfaceScalarField& alphaRhoPhi,
70  const surfaceScalarField& phi,
71  const transportModel& transport
72  );
73 
74 
75  //- Destructor
76  virtual ~linearViscousStress()
77  {}
78 
79 
80  // Member Functions
81 
82  //- Re-read model coefficients if they have changed
83  virtual bool read() = 0;
84 
85  //- Return the effective stress tensor
86  virtual tmp<volSymmTensorField> devTau() const;
87 
88  //- Return the source term for the momentum equation
90 
91  //- Return the source term for the momentum equation
93  (
94  const volScalarField& rho,
96  ) const;
97 
98  //- Solve the turbulence equations and correct the turbulence viscosity
99  virtual void correct() = 0;
100 };
101 
102 
103 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
104 
105 } // End namespace Foam
106 
107 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
108 
109 #ifdef NoRepository
110  #include "linearViscousStress.C"
111 #endif
112 
113 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
114 
115 #endif
116 
117 // ************************************************************************* //
virtual void correct()=0
Solve the turbulence equations and correct the turbulence viscosity.
virtual ~linearViscousStress()
Destructor.
volScalarField alpha(IOobject("alpha", runTime.timeName(), mesh, IOobject::READ_IF_PRESENT, IOobject::AUTO_WRITE), lambda *max(Ua &U, zeroSensitivity))
Linear viscous stress turbulence model base class.
BasicMomentumTransportModel::transportModel transportModel
BasicMomentumTransportModel::alphaField alphaField
linearViscousStress(const word &modelName, const alphaField &alpha, const rhoField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const transportModel &transport)
Construct from components.
A class for handling words, derived from string.
Definition: word.H:59
phi
Definition: correctPhi.H:3
virtual bool read()=0
Re-read model coefficients if they have changed.
U
Definition: pEqn.H:72
BasicMomentumTransportModel::rhoField rhoField
virtual tmp< volSymmTensorField > devTau() const
Return the effective stress tensor.
A class for managing temporary objects.
Definition: PtrList.H:53
virtual tmp< fvVectorMatrix > divDevTau(volVectorField &U) const
Return the source term for the momentum equation.
Namespace for OpenFOAM.