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

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2009 OpenCFD Ltd.
   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 the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     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, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::viscosityModels::powerLaw
  27
  28 Description
  29      Standard power-law non-Newtonian viscosity model.
  30
  31 SourceFiles
  32     powerLaw.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef powerLaw_H
  37 #define powerLaw_H
  38
  39 #include "viscosityModel.H"
  40 #include "dimensionedScalar.H"
  41 #include "volFields.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47 namespace viscosityModels
  48 {
  49
  50 /*---------------------------------------------------------------------------*\
  51                            Class powerLaw Declaration
  52 \*---------------------------------------------------------------------------*/
  53
  54 class powerLaw
  55 :
  56     public viscosityModel
  57 {
  58     // Private data
  59
  60         dictionary powerLawCoeffs_;
  61
  62         dimensionedScalar k_;
  63         dimensionedScalar n_;
  64         dimensionedScalar nuMin_;
  65         dimensionedScalar nuMax_;
  66
  67         volScalarField nu_;
  68
  69
  70     // Private Member Functions
  71
  72         //- Calculate and return the laminar viscosity
  73         tmp<volScalarField> calcNu() const;
  74
  75
  76 public:
  77
  78     //- Runtime type information
  79     TypeName("powerLaw");
  80
  81
  82     // Constructors
  83
  84         //- Construct from components
  85         powerLaw
  86         (
  87             const word& name,
  88             const dictionary& viscosityProperties,
  89             const volVectorField& U,
  90             const surfaceScalarField& phi
  91         );
  92
  93
  94     // Destructor
  95
  96         ~powerLaw()
  97         {}
  98
  99
 100     // Member Functions
 101
 102         //- Return the laminar viscosity
 103         tmp<volScalarField> nu() const
 104         {
 105             return nu_;
 106         }
 107
 108         //- Correct the laminar viscosity
 109         void correct()
 110         {
 111             nu_ = calcNu();
 112         }
 113
 114         //- Read transportProperties dictionary
 115         bool read(const dictionary& viscosityProperties);
 116 };
 117
 118
 119 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 120
 121 } // End namespace viscosityModels
 122 } // End namespace Foam
 123
 124 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 125
 126 #endif
 127
 128 // ************************************************************************* //