BirdCarreau.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
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  The Bird-Carreau-Yasuda form is also supported if the optional "a"
31  coefficient is specified. "a" defaults to 2 for the Bird-Carreau model.
32 
33 SourceFiles
34  BirdCarreau.C
35 
36 \*---------------------------------------------------------------------------*/
37 
38 #ifndef BirdCarreau_H
39 #define BirdCarreau_H
40 
41 #include "viscosityModel.H"
42 #include "dimensionedScalar.H"
43 #include "volFields.H"
44 
45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
46 
47 namespace Foam
48 {
49 namespace viscosityModels
50 {
51 
52 /*---------------------------------------------------------------------------*\
53  Class BirdCarreau Declaration
54 \*---------------------------------------------------------------------------*/
55 
56 class BirdCarreau
57 :
58  public viscosityModel
59 {
60  // Private data
61 
62  dictionary BirdCarreauCoeffs_;
63 
64  dimensionedScalar nu0_;
65  dimensionedScalar nuInf_;
69 
70  volScalarField nu_;
71 
72 
73  // Private Member Functions
74 
75  //- Calculate and return the laminar viscosity
76  tmp<volScalarField> calcNu() const;
77 
78 
79 public:
80 
81  //- Runtime type information
82  TypeName("BirdCarreau");
83 
84 
85  // Constructors
86 
87  //- Construct from components
89  (
90  const word& name,
92  const volVectorField& U,
93  const surfaceScalarField& phi
94  );
95 
96 
97  //- Destructor
98  ~BirdCarreau()
99  {}
100 
101 
102  // Member Functions
103 
104  //- Return the laminar viscosity
105  tmp<volScalarField> nu() const
106  {
107  return nu_;
108  }
109 
110  //- Return the laminar viscosity for patch
111  tmp<scalarField> nu(const label patchi) const
112  {
113  return nu_.boundaryField()[patchi];
114  }
115 
116  //- Correct the laminar viscosity
117  void correct()
118  {
119  nu_ = calcNu();
120  }
121 
122  //- Read transportProperties dictionary
123  bool read(const dictionary& viscosityProperties);
124 };
125 
126 
127 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
128 
129 } // End namespace viscosityModels
130 } // End namespace Foam
131 
132 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
133 
134 #endif
135 
136 // ************************************************************************* //
GeometricBoundaryField & boundaryField()
Return reference to GeometricBoundaryField.
word name(const complex &)
Return a string representation of a complex.
Definition: complex.C:47
tmp< volScalarField > nu() const
Return the laminar viscosity.
Definition: BirdCarreau.H:104
An abstract base class for incompressible viscosityModels.
A class for handling words, derived from string.
Definition: word.H:59
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
Namespace for OpenFOAM.
void correct()
Correct the laminar viscosity.
Definition: BirdCarreau.H:116
label patchi
An incompressible Bird-Carreau non-Newtonian viscosity model.
Definition: BirdCarreau.H:55
BirdCarreau(const word &name, const dictionary &viscosityProperties, const volVectorField &U, const surfaceScalarField &phi)
Construct from components.
Definition: BirdCarreau.C:62
TypeName("BirdCarreau")
Runtime type information.
surfaceScalarField & phi
const dictionary & viscosityProperties() const
Return the phase transport properties dictionary.
A class for managing temporary objects.
Definition: PtrList.H:118
bool read(const dictionary &viscosityProperties)
Read transportProperties dictionary.
Definition: BirdCarreau.C:101
U
Definition: pEqn.H:82