HerschelBulkley.C
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2011-2017 OpenFOAM Foundation
9  Copyright (C) 2017 OpenCFD Ltd.
10 -------------------------------------------------------------------------------
11 License
12  This file is part of OpenFOAM.
13 
14  OpenFOAM is free software: you can redistribute it and/or modify it
15  under the terms of the GNU General Public License as published by
16  the Free Software Foundation, either version 3 of the License, or
17  (at your option) any later version.
18 
19  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
20  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
21  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22  for more details.
23 
24  You should have received a copy of the GNU General Public License
25  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
26 
27 \*---------------------------------------------------------------------------*/
28 
29 #include "HerschelBulkley.H"
31 #include "surfaceFields.H"
32 
33 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
34 
35 namespace Foam
36 {
37 namespace viscosityModels
38 {
39  defineTypeNameAndDebug(HerschelBulkley, 0);
40 
42  (
43  viscosityModel,
44  HerschelBulkley,
45  dictionary
46  );
47 }
48 }
49 
50 
51 // * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * * //
52 
55 {
56  dimensionedScalar tone("tone", dimTime, 1.0);
57  dimensionedScalar rtone("rtone", dimless/dimTime, 1.0);
58 
60 
61  return
62  (
63  min
64  (
65  nu0_,
66  (tau0_ + k_*rtone*pow(tone*sr(), n_))
67  /(max(sr(), dimensionedScalar ("VSMALL", dimless/dimTime, VSMALL)))
68  )
69  );
70 }
71 
72 
73 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
74 
76 (
77  const word& name,
78  const dictionary& viscosityProperties,
79  const volVectorField& U,
80  const surfaceScalarField& phi
81 )
82 :
83  viscosityModel(name, viscosityProperties, U, phi),
84  HerschelBulkleyCoeffs_
85  (
86  viscosityProperties.optionalSubDict(typeName + "Coeffs")
87  ),
88  k_("k", dimViscosity, HerschelBulkleyCoeffs_),
89  n_("n", dimless, HerschelBulkleyCoeffs_),
90  tau0_("tau0", dimViscosity/dimTime, HerschelBulkleyCoeffs_),
91  nu0_("nu0", dimViscosity, HerschelBulkleyCoeffs_),
92  nu_
93  (
94  IOobject
95  (
96  name,
97  U_.time().timeName(),
98  U_.db(),
101  ),
102  calcNu()
103  )
104 {}
105 
106 
107 // * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * * //
108 
110 (
111  const dictionary& viscosityProperties
112 )
113 {
114  viscosityModel::read(viscosityProperties);
115 
116  HerschelBulkleyCoeffs_ =
117  viscosityProperties.optionalSubDict(typeName + "Coeffs");
118 
119  HerschelBulkleyCoeffs_.readEntry("k", k_);
120  HerschelBulkleyCoeffs_.readEntry("n", n_);
121  HerschelBulkleyCoeffs_.readEntry("tau0", tau0_);
122  HerschelBulkleyCoeffs_.readEntry("nu0", nu0_);
123 
124  return true;
125 }
126 
127 
128 // ************************************************************************* //
Foam::viscosityModels::HerschelBulkley::HerschelBulkley
HerschelBulkley(const word &name, const dictionary &viscosityProperties, const volVectorField &U, const surfaceScalarField &phi)
Construct from components.
Definition: HerschelBulkley.C:76
Foam::IOobject
Defines the attributes of an object for which implicit objectRegistry management is supported,...
Definition: IOobject.H:169
Foam::viscosityModel
An abstract base class for incompressible viscosityModels.
Definition: viscosityModel.H:67
Foam::IOobject::AUTO_WRITE
Definition: IOobject.H:194
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:65
Foam::viscosityModels::HerschelBulkley::calcNu
tmp< volScalarField > calcNu() const
Calculate and return the laminar viscosity.
Definition: HerschelBulkley.C:54
Foam::tmp
A class for managing temporary objects.
Definition: PtrList.H:61
surfaceFields.H
Foam::surfaceFields.
Foam::min
label min(const labelHashSet &set, label minValue=labelMax)
Find the min value in labelHashSet, optionally limited by second argument.
Definition: hashSets.C:33
Foam::viscosityModel::read
virtual bool read(const dictionary &viscosityProperties)=0
Read transportProperties dictionary.
Definition: viscosityModel.C:66
Foam::dimTime
const dimensionSet dimTime(0, 0, 1, 0, 0, 0, 0)
Definition: dimensionSets.H:53
Foam::dictionary::readEntry
bool readEntry(const word &keyword, T &val, enum keyType::option matchOpt=keyType::REGEX, bool mandatory=true) const
Definition: dictionaryTemplates.C:302
phi
surfaceScalarField & phi
Definition: setRegionFluidFields.H:8
Foam::pow
dimensionedScalar pow(const dimensionedScalar &ds, const dimensionedScalar &expt)
Definition: dimensionedScalar.C:75
Foam::max
label max(const labelHashSet &set, label maxValue=labelMin)
Find the max value in labelHashSet, optionally limited by second argument.
Definition: hashSets.C:47
Foam::viscosityModels::defineTypeNameAndDebug
defineTypeNameAndDebug(BirdCarreau, 0)
Foam::dimViscosity
const dimensionSet dimViscosity
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:123
addToRunTimeSelectionTable.H
Macros for easy insertion into run-time selection tables.
Foam::dimensioned< scalar >
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
U
U
Definition: pEqn.H:72
HerschelBulkley.H
Foam::viscosityModels::HerschelBulkley::read
virtual bool read(const dictionary &viscosityProperties)
Read transportProperties dictionary.
Definition: HerschelBulkley.C:110
Foam::dictionary::optionalSubDict
const dictionary & optionalSubDict(const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
Find and return a sub-dictionary, otherwise return this dictionary.
Definition: dictionary.C:577
Foam::name
word name(const expressions::valueTypeCode typeCode)
A word representation of a valueTypeCode. Empty for INVALID.
Definition: exprTraits.C:59
Foam::GeometricField< vector, fvPatchField, volMesh >
Foam::IOobject::NO_READ
Definition: IOobject.H:188
Foam::viscosityModels::addToRunTimeSelectionTable
addToRunTimeSelectionTable(viscosityModel, BirdCarreau, dictionary)
Foam::viscosityModel::strainRate
tmp< volScalarField > strainRate() const
Return the strain rate.
Definition: viscosityModel.C:60
Foam::dimless
const dimensionSet dimless
Dimensionless.
Definition: dimensionSets.C:189