Formatting
[foam-extend-3.2.git] / src / transportModels / incompressible / viscosityModels / HerschelBulkley / HerschelBulkley.H
blobf4331e02b84bcf4cf1bd963dd68cca3a5d9d5758
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | foam-extend: Open Source CFD
4    \\    /   O peration     | Version:     3.2
5     \\  /    A nd           | Web:         http://www.foam-extend.org
6      \\/     M anipulation  | For copyright notice see file Copyright
7 -------------------------------------------------------------------------------
8 License
9     This file is part of foam-extend.
11     foam-extend is free software: you can redistribute it and/or modify it
12     under the terms of the GNU General Public License as published by the
13     Free Software Foundation, either version 3 of the License, or (at your
14     option) any later version.
16     foam-extend is distributed in the hope that it will be useful, but
17     WITHOUT ANY WARRANTY; without even the implied warranty of
18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
19     General Public License for more details.
21     You should have received a copy of the GNU General Public License
22     along with foam-extend.  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
95         ~HerschelBulkley()
96         {}
99     // Member Functions
101         //- Return the laminar viscosity
102         const volScalarField& nu() const
103         {
104             return nu_;
105         }
107         //- Correct the laminar viscosity
108         void correct()
109         {
110             nu_ = calcNu();
111         }
113         //- Read transportProperties dictionary
114         bool read(const dictionary& viscosityProperties);
118 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
120 } // End namespace viscosityModels
121 } // End namespace Foam
123 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
125 #endif
127 // ************************************************************************* //