HerschelBulkley.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 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::HerschelBulkley
26 
27 Description
28  Herschel-Bulkley non-Newtonian viscosity model.
29 
30 SourceFiles
31  HerschelBulkley.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef HerschelBulkley_H
36 #define HerschelBulkley_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 HerschelBulkley Declaration
51 \*---------------------------------------------------------------------------*/
52 
53 class HerschelBulkley
54 :
55  public viscosityModel
56 {
57  // Private data
58 
59  dictionary HerschelBulkleyCoeffs_;
60 
63  dimensionedScalar tau0_;
64  dimensionedScalar nu0_;
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("HerschelBulkley");
79 
80 
81  // Constructors
82 
83  //- Construct from components
85  (
86  const word& name,
88  const volVectorField& U,
89  const surfaceScalarField& phi
90  );
91 
92 
93  //- Destructor
95  {}
96 
97 
98  // Member Functions
99 
100  //- Return the laminar viscosity
101  tmp<volScalarField> nu() const
102  {
103  return nu_;
104  }
105 
106  //- Return the laminar viscosity for patch
107  tmp<scalarField> nu(const label patchi) const
108  {
109  return nu_.boundaryField()[patchi];
110  }
111 
112  //- Correct the laminar viscosity
113  void correct()
114  {
115  nu_ = calcNu();
116  }
117 
118  //- Read transportProperties dictionary
119  bool read(const dictionary& viscosityProperties);
120 };
121 
122 
123 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
124 
125 } // End namespace viscosityModels
126 } // End namespace Foam
127 
128 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
129 
130 #endif
131 
132 // ************************************************************************* //
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.
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.
bool read(const dictionary &viscosityProperties)
Read transportProperties dictionary.
HerschelBulkley(const word &name, const dictionary &viscosityProperties, const volVectorField &U, const surfaceScalarField &phi)
Construct from components.
Herschel-Bulkley non-Newtonian viscosity model.
label patchi
surfaceScalarField & phi
TypeName("HerschelBulkley")
Runtime type information.
void correct()
Correct the laminar viscosity.
const dictionary & viscosityProperties() const
Return the phase transport properties dictionary.
A class for managing temporary objects.
Definition: PtrList.H:118
U
Definition: pEqn.H:82