linearViscousStress.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2013-2016 OpenFOAM Foundation
9  Copyright (C) 2019 OpenCFD Ltd.
10 -------------------------------------------------------------------------------
11 License
12  This file is part of OpenFOAM.
13 
14  OpenFOAM is free software: you can redistribute it and/or modify it
15  under the terms of the GNU General Public License as published by
16  the Free Software Foundation, either version 3 of the License, or
17  (at your option) any later version.
18 
19  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
20  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
21  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22  for more details.
23 
24  You should have received a copy of the GNU General Public License
25  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
26 
27 Class
28  Foam::linearViscousStress
29 
30 Group
31  grpTurbulence
32 
33 Description
34  Linear viscous stress turbulence model base class
35 
36 SourceFiles
37  linearViscousStress.C
38 
39 \*---------------------------------------------------------------------------*/
40 
41 #ifndef linearViscousStress_H
42 #define linearViscousStress_H
43 
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45 
46 namespace Foam
47 {
48 
49 /*---------------------------------------------------------------------------*\
50  Class linearViscousStress Declaration
51 \*---------------------------------------------------------------------------*/
52 
53 template<class BasicTurbulenceModel>
55 :
56  public BasicTurbulenceModel
57 {
58 
59 public:
60 
61  typedef typename BasicTurbulenceModel::alphaField alphaField;
62  typedef typename BasicTurbulenceModel::rhoField rhoField;
63  typedef typename BasicTurbulenceModel::transportModel transportModel;
64 
65 
66  // Constructors
67 
68  //- Construct from components
70  (
71  const word& modelName,
72  const alphaField& alpha,
73  const rhoField& rho,
74  const volVectorField& U,
75  const surfaceScalarField& alphaRhoPhi,
76  const surfaceScalarField& phi,
77  const transportModel& transport,
78  const word& propertiesName
79  );
80 
81 
82  //- Destructor
83  virtual ~linearViscousStress() = default;
84 
85 
86  // Member Functions
87 
88  //- Re-read model coefficients if they have changed
89  virtual bool read() = 0;
90 
91  //- Return the effective stress tensor
92  virtual tmp<volSymmTensorField> devRhoReff() const;
93 
94  //- Return the source term for the momentum equation
96 
97  //- Return the source term for the momentum equation
99  (
100  const volScalarField& rho,
102  ) const;
103 
104  //- Solve the turbulence equations and correct the turbulence viscosity
105  virtual void correct() = 0;
106 };
107 
108 
109 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
110 
111 } // End namespace Foam
112 
113 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
114 
115 #ifdef NoRepository
116  #include "linearViscousStress.C"
117 #endif
118 
119 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
120 
121 #endif
122 
123 // ************************************************************************* //
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:62
Foam::tmp
A class for managing temporary objects.
Definition: PtrList.H:59
Foam::constant::atomic::alpha
const dimensionedScalar alpha
Fine-structure constant: default SI units: [].
Definition: readThermalProperties.H:212
Foam::linearViscousStress::read
virtual bool read()=0
Re-read model coefficients if they have changed.
Definition: linearViscousStress.C:64
rho
rho
Definition: readInitialConditions.H:88
Foam::linearViscousStress::transportModel
BasicTurbulenceModel::transportModel transportModel
Definition: linearViscousStress.H:62
Foam::linearViscousStress
Linear viscous stress turbulence model base class.
Definition: linearViscousStress.H:53
Foam::linearViscousStress::correct
virtual void correct()=0
Solve the turbulence equations and correct the turbulence viscosity.
Definition: linearViscousStress.C:125
Foam::linearViscousStress::rhoField
BasicTurbulenceModel::rhoField rhoField
Definition: linearViscousStress.H:61
phi
surfaceScalarField & phi
Definition: setRegionFluidFields.H:8
Foam::linearViscousStress::linearViscousStress
linearViscousStress(const word &modelName, const alphaField &alpha, const rhoField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const transportModel &transport, const word &propertiesName)
Construct from components.
Definition: linearViscousStress.C:36
Foam::linearViscousStress::devRhoReff
virtual tmp< volSymmTensorField > devRhoReff() const
Return the effective stress tensor.
Definition: linearViscousStress.C:72
Foam::RASModel::rhoField
BasicTurbulenceModel::rhoField rhoField
Definition: RASModel.H:97
Foam::linearViscousStress::divDevRhoReff
virtual tmp< fvVectorMatrix > divDevRhoReff(volVectorField &U) const
Return the source term for the momentum equation.
Definition: linearViscousStress.C:96
Foam::linearViscousStress::~linearViscousStress
virtual ~linearViscousStress()=default
Destructor.
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::RASModel::alphaField
BasicTurbulenceModel::alphaField alphaField
Definition: RASModel.H:96
linearViscousStress.C
Foam::RASModel::transportModel
BasicTurbulenceModel::transportModel transportModel
Definition: RASModel.H:98
U
U
Definition: pEqn.H:72
Foam::linearViscousStress::alphaField
BasicTurbulenceModel::alphaField alphaField
Definition: linearViscousStress.H:60
Foam::GeometricField< vector, fvPatchField, volMesh >