ENH: autoLayerDriver: better layering information message
[OpenFOAM-2.0.x.git] / src / transportModels / incompressible / viscosityModels / HerschelBulkley / HerschelBulkley.H
blobc59d9556752eb25e695b38e394c4cb3f4a125d42
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
4    \\    /   O peration     |
5     \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
6      \\/     M anipulation  |
7 -------------------------------------------------------------------------------
8 License
9     This file is part of OpenFOAM.
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.
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.
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/>.
24 Class
25     Foam::viscosityModels::HerschelBulkley
27 Description
28      Herschel-Bulkley non-Newtonian viscosity model.
30 SourceFiles
31     HerschelBulkley.C
33 \*---------------------------------------------------------------------------*/
35 #ifndef HerschelBulkley_H
36 #define HerschelBulkley_H
38 #include "viscosityModel.H"
39 #include "dimensionedScalar.H"
40 #include "volFields.H"
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 namespace Foam
46 namespace viscosityModels
49 /*---------------------------------------------------------------------------*\
50                            Class HerschelBulkley Declaration
51 \*---------------------------------------------------------------------------*/
53 class HerschelBulkley
55     public viscosityModel
57     // Private data
59         dictionary HerschelBulkleyCoeffs_;
61         dimensionedScalar k_;
62         dimensionedScalar n_;
63         dimensionedScalar tau0_;
64         dimensionedScalar nu0_;
66         volScalarField nu_;
69     // Private Member Functions
71         //- Calculate and return the laminar viscosity
72         tmp<volScalarField> calcNu() const;
75 public:
77     //- Runtime type information
78     TypeName("HerschelBulkley");
81     // Constructors
83         //- Construct from components
84         HerschelBulkley
85         (
86             const word& name,
87             const dictionary& viscosityProperties,
88             const volVectorField& U,
89             const surfaceScalarField& phi
90         );
93     //- Destructor
94     ~HerschelBulkley()
95     {}
98     // Member Functions
100         //- Return the laminar viscosity
101         tmp<volScalarField> nu() const
102         {
103             return nu_;
104         }
106         //- Correct the laminar viscosity
107         void correct()
108         {
109             nu_ = calcNu();
110         }
112         //- Read transportProperties dictionary
113         bool read(const dictionary& viscosityProperties);
117 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
119 } // End namespace viscosityModels
120 } // End namespace Foam
122 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
124 #endif
126 // ************************************************************************* //