BirdCarreau.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::BirdCarreau
26 
27 Description
28  Bird-Carreau generalized Newtonian viscosity model
29 
30  The Bird-Carreau-Yasuda form is also supported if the optional \c a
31  coefficient is specified. \c a defaults to 2 for the Bird-Carreau model.
32 
33  The strain rate coefficient can be specified either as the constant \c k or
34  the critical stress level at the transition to shear thinning \c
35  tauStar if \c tauStar is provided:
36 
37  Kinematic viscosity [m^2/s]
38 
39  \f[
40  \nu = \nu_\infty\,
41  + (\nu_0 - \nu_\infty)\,
42  \left(1 + (k\gamma)^a \right)^{(n - 1)/a}
43  \f]
44 
45  or
46 
47  \f[
48  \nu = \nu_\infty
49  + (\nu_0 - \nu_\infty)
50  \left(1 + (\frac{\nu_0\gamma}{\tau^*} )^a \right)^{(n - 1)/a}
51  \f]
52 
53  Example specification for a polymer:
54  \verbatim
55  viscosityModel BirdCarreau;
56 
57  nuInf 0;
58  tauStar 90;
59  n 0.5;
60  \endverbatim
61 
62 SourceFiles
63  BirdCarreau.C
64 
65 \*---------------------------------------------------------------------------*/
66 
67 #ifndef BirdCarreau_H
68 #define BirdCarreau_H
69 
71 #include "dimensionedScalar.H"
72 
73 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
74 
75 namespace Foam
76 {
77 namespace laminarModels
78 {
79 namespace generalizedNewtonianViscosityModels
80 {
81 
82 /*---------------------------------------------------------------------------*\
83  Class BirdCarreau Declaration
84 \*---------------------------------------------------------------------------*/
85 
86 class BirdCarreau
87 :
89 {
90  // Private Data
91 
92  dimensionedScalar nuInf_;
94  dimensionedScalar tauStar_;
97 
98 
99 public:
100 
101  //- Runtime type information
102  TypeName("BirdCarreau");
103 
104 
105  // Constructors
106 
107  //- Construct from components
109 
110 
111  //- Destructor
112  virtual ~BirdCarreau()
113  {}
114 
115 
116  // Member Functions
117 
118  //- Read transportProperties dictionary
119  virtual bool read(const dictionary& viscosityProperties);
120 
121  //- Return the laminar viscosity
122  virtual tmp<volScalarField> nu
123  (
124  const volScalarField& nu0,
125  const volScalarField& strainRate
126  ) const;
127 };
128 
129 
130 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
131 
132 } // End namespace generalizedNewtonianViscosityModels
133 } // End namespace laminarModels
134 } // End namespace Foam
135 
136 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
137 
138 #endif
139 
140 // ************************************************************************* //
virtual tmp< volScalarField > nu(const volScalarField &nu0, const volScalarField &strainRate) const
Return the laminar viscosity.
Definition: BirdCarreau.C:108
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.
BirdCarreau(const dictionary &viscosityProperties)
Construct from components.
Definition: BirdCarreau.C:54
Bird-Carreau generalized Newtonian viscosity model.
Definition: BirdCarreau.H:85
const dictionary & viscosityProperties() const
Return the phase transport properties dictionary.
A class for managing temporary objects.
Definition: PtrList.H:53
virtual bool read(const dictionary &viscosityProperties)
Read transportProperties dictionary.
Definition: BirdCarreau.C:73
Namespace for OpenFOAM.