BirdCarreau.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) 2018-2020 OpenFOAM Foundation
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 Class
27  Foam::laminarModels::generalizedNewtonianViscosityModels::BirdCarreau
28 
29 Description
30  An incompressible Bird-Carreau non-Newtonian viscosity model.
31 
32  The Bird-Carreau-Yasuda form is also supported if the optional "a"
33  coefficient is specified. "a" defaults to 2 for the Bird-Carreau model.
34 
35  Example specification for a polymer:
36  \verbatim
37  viscosityModel BirdCarreau;
38 
39  nuInf 0;
40  n 0.5;
41  \endverbatim
42 
43 SourceFiles
44  BirdCarreau.C
45 
46 \*---------------------------------------------------------------------------*/
47 
48 #ifndef BirdCarreau_H
49 #define BirdCarreau_H
50 
52 #include "dimensionedScalar.H"
53 
54 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
55 
56 namespace Foam
57 {
58 namespace laminarModels
59 {
60 namespace generalizedNewtonianViscosityModels
61 {
62 
63 /*---------------------------------------------------------------------------*\
64  Class BirdCarreau Declaration
65 \*---------------------------------------------------------------------------*/
66 
67 class BirdCarreau
68 :
70 {
71  // Private Data
72 
73  dictionary BirdCarreauCoeffs_;
74 
75  dimensionedScalar nuInf_;
79 
80 
81 public:
82 
83  //- Runtime type information
84  TypeName("BirdCarreau");
85 
86 
87  // Constructors
88 
89  //- Construct from dictionary (components)
91 
92 
93  //- Destructor
94  virtual ~BirdCarreau() = default;
95 
96 
97  // Member Functions
98 
99  //- Read transportProperties dictionary
100  virtual bool read(const dictionary& viscosityProperties);
101 
102  //- Return the laminar viscosity
103  virtual tmp<volScalarField> nu
104  (
105  const volScalarField& nu0,
106  const volScalarField& strainRate
107  ) const;
108 };
109 
110 
111 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
112 
113 } // End namespace generalizedNewtonianViscosityModels
114 } // End namespace laminarModels
115 } // End namespace Foam
116 
117 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
118 
119 #endif
120 
121 // ************************************************************************* //
Foam::laminarModels::generalizedNewtonianViscosityModels::BirdCarreau::read
virtual bool read(const dictionary &viscosityProperties)
Read transportProperties dictionary.
Definition: BirdCarreau.C:84
Foam::tmp
A class for managing temporary objects.
Definition: PtrList.H:61
Foam::laminarModels::generalizedNewtonianViscosityModels::BirdCarreau::~BirdCarreau
virtual ~BirdCarreau()=default
Destructor.
Foam::laminarModels::generalizedNewtonianViscosityModels::BirdCarreau::nu
virtual tmp< volScalarField > nu(const volScalarField &nu0, const volScalarField &strainRate) const
Return the laminar viscosity.
Definition: BirdCarreau.C:110
Foam::laminarModels::generalizedNewtonianViscosityModel::viscosityProperties
const dictionary & viscosityProperties() const
Return the phase transport properties dictionary.
Definition: generalizedNewtonianViscosityModel.H:129
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:121
Foam::dimensioned< scalar >
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
dimensionedScalar.H
Foam::laminarModels::generalizedNewtonianViscosityModels::BirdCarreau
An incompressible Bird-Carreau non-Newtonian viscosity model.
Definition: BirdCarreau.H:66
Foam::laminarModels::generalizedNewtonianViscosityModel
An abstract base class for generalized Newtonian viscosity models.
Definition: generalizedNewtonianViscosityModel.H:63
Foam::GeometricField< scalar, fvPatchField, volMesh >
Foam::laminarModels::generalizedNewtonianViscosityModels::BirdCarreau::TypeName
TypeName("BirdCarreau")
Runtime type information.
generalizedNewtonianViscosityModel.H
Foam::laminarModels::generalizedNewtonianViscosityModels::BirdCarreau::BirdCarreau
BirdCarreau(const dictionary &viscosityProperties)
Construct from dictionary (components)
Definition: BirdCarreau.C:57