powerLaw.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) 2018-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::laminarModels::generalizedNewtonianViscosityModels::powerLaw
26 
27 Description
28  Standard power-law generalized Newtonian viscosity model
29 
30 SourceFiles
31  powerLaw.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef powerLaw_H
36 #define powerLaw_H
37 
39 #include "dimensionedScalar.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 namespace laminarModels
46 {
47 namespace generalizedNewtonianViscosityModels
48 {
49 
50 /*---------------------------------------------------------------------------*\
51  Class powerLaw Declaration
52 \*---------------------------------------------------------------------------*/
53 
54 class powerLaw
55 :
57 {
58  // Private Data
59 
62  dimensionedScalar nuMin_;
63  dimensionedScalar nuMax_;
64 
65 
66 public:
67 
68  //- Runtime type information
69  TypeName("powerLaw");
70 
71 
72  // Constructors
73 
74  //- Construct from components
76 
77 
78  //- Destructor
79  virtual ~powerLaw()
80  {}
81 
82 
83  // Member Functions
84 
85  //- Read transportProperties dictionary
86  virtual bool read(const dictionary& viscosityProperties);
87 
88  //- Return the laminar viscosity
89  virtual tmp<volScalarField> nu
90  (
91  const volScalarField& nu0,
92  const volScalarField& strainRate
93  ) const;
94 };
95 
96 
97 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
98 
99 } // End namespace generalizedNewtonianViscosityModels
100 } // End namespace laminarModels
101 } // End namespace Foam
102 
103 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
104 
105 #endif
106 
107 // ************************************************************************* //
powerLaw(const dictionary &viscosityProperties)
Construct from components.
Definition: powerLaw.C:54
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:158
An abstract base class for generalized Newtonian viscosity models.
Standard power-law generalized Newtonian viscosity model.
Definition: powerLaw.H:53
virtual bool read(const dictionary &viscosityProperties)
Read transportProperties dictionary.
Definition: powerLaw.C:71
const dictionary & viscosityProperties() const
Return the phase transport properties dictionary.
virtual tmp< volScalarField > nu(const volScalarField &nu0, const volScalarField &strainRate) const
Return the laminar viscosity.
Definition: powerLaw.C:92
A class for managing temporary objects.
Definition: PtrList.H:53
Namespace for OpenFOAM.