src/transportModels/incompressible/viscosityModels/powerLaw/powerLaw.H

   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.
  10
  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.
  15
  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.
  20
  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/>.
  23
  24 Class
  25     Foam::viscosityModels::powerLaw
  26
  27 Description
  28      Standard power-law non-Newtonian viscosity model.
  29
  30 SourceFiles
  31     powerLaw.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef powerLaw_H
  36 #define powerLaw_H
  37
  38 #include "viscosityModel.H"
  39 #include "dimensionedScalar.H"
  40 #include "volFields.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46 namespace viscosityModels
  47 {
  48
  49 /*---------------------------------------------------------------------------*\
  50                            Class powerLaw Declaration
  51 \*---------------------------------------------------------------------------*/
  52
  53 class powerLaw
  54 :
  55     public viscosityModel
  56 {
  57     // Private data
  58
  59         dictionary powerLawCoeffs_;
  60
  61         dimensionedScalar k_;
  62         dimensionedScalar n_;
  63         dimensionedScalar nuMin_;
  64         dimensionedScalar nuMax_;
  65
  66         volScalarField nu_;
  67
  68
  69     // Private Member Functions
  70
  71         //- Calculate and return the laminar viscosity
  72         tmp<volScalarField> calcNu() const;
  73
  74
  75 public:
  76
  77     //- Runtime type information
  78     TypeName("powerLaw");
  79
  80
  81     // Constructors
  82
  83         //- Construct from components
  84         powerLaw
  85         (
  86             const word& name,
  87             const dictionary& viscosityProperties,
  88             const volVectorField& U,
  89             const surfaceScalarField& phi
  90         );
  91
  92
  93     // Destructor
  94
  95         virtual ~powerLaw()
  96         {}
  97
  98
  99     // Member Functions
 100
 101         //- Return the laminar viscosity
 102         virtual const volScalarField& nu() const
 103         {
 104             return nu_;
 105         }
 106
 107         //- Correct the laminar viscosity
 108         virtual void correct()
 109         {
 110             nu_ = calcNu();
 111         }
 112
 113         //- Read transportProperties dictionary
 114         virtual bool read(const dictionary& viscosityProperties);
 115 };
 116
 117
 118 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 119
 120 } // End namespace viscosityModels
 121 } // End namespace Foam
 122
 123 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 124
 125 #endif
 126
 127 // ************************************************************************* //