src/transportModels/incompressible/viscosityModels/BirdCarreau/BirdCarreau.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2004-2010 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
  13     the Free Software Foundation, either version 3 of the License, or
  14     (at your 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, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::viscosityModels::BirdCarreau
  26
  27 Description
  28     An incompressible Bird-Carreau non-Newtonian viscosity model.
  29
  30 SourceFiles
  31     BirdCarreau.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef BirdCarreau_H
  36 #define BirdCarreau_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 BirdCarreau Declaration
  51 \*---------------------------------------------------------------------------*/
  52
  53 class BirdCarreau
  54 :
  55     public viscosityModel
  56 {
  57     // Private data
  58
  59         dictionary BirdCarreauCoeffs_;
  60
  61         dimensionedScalar nu0_;
  62         dimensionedScalar nuInf_;
  63         dimensionedScalar k_;
  64         dimensionedScalar n_;
  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("BirdCarreau");
  79
  80
  81     // Constructors
  82
  83         //- construct from components
  84         BirdCarreau
  85         (
  86             const word& name,
  87             const dictionary& viscosityProperties,
  88             const volVectorField& U,
  89             const surfaceScalarField& phi
  90         );
  91
  92
  93     //- Destructor
  94     ~BirdCarreau()
  95     {}
  96
  97
  98     // Member Functions
  99
 100         //- Return the laminar viscosity
 101         tmp<volScalarField> nu() const
 102         {
 103             return nu_;
 104         }
 105
 106         //- Correct the laminar viscosity
 107         void correct()
 108         {
 109             nu_ = calcNu();
 110         }
 111
 112         //- Read transportProperties dictionary
 113         bool read(const dictionary& viscosityProperties);
 114 };
 115
 116
 117 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 118
 119 } // End namespace viscosityModels
 120 } // End namespace Foam
 121
 122 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 123
 124 #endif
 125
 126 // ************************************************************************* //