powerLaw.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 | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2011-2016 OpenFOAM Foundation
9  Copyright (C) 2017-2019 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 Class
28  Foam::viscosityModels::powerLaw
29 
30 Description
31  Standard power-law non-Newtonian viscosity model.
32 
33 SourceFiles
34  powerLaw.C
35 
36 \*---------------------------------------------------------------------------*/
37 
38 #ifndef viscosityModels_powerLaw_H
39 #define viscosityModels_powerLaw_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 powerLaw Declaration
54 \*---------------------------------------------------------------------------*/
55 
56 class powerLaw
57 :
58  public viscosityModel
59 {
60  // Private data
61 
62  dictionary powerLawCoeffs_;
63 
66  dimensionedScalar nuMin_;
67  dimensionedScalar nuMax_;
68 
69 
70 protected:
71 
72  // Protected data
73 
75 
76 
77  // Protected Member Functions
78 
79  //- Calculate and return the laminar viscosity
81 
82 
83 public:
84 
85  //- Runtime type information
86  TypeName("powerLaw");
87 
88 
89  // Constructors
90 
91  //- Construct from components
92  powerLaw
93  (
94  const word& name,
96  const volVectorField& U,
97  const surfaceScalarField& phi
98  );
99 
100 
101  //- Destructor
102  virtual ~powerLaw() = default;
103 
104 
105  // Member Functions
106 
107  //- Return the laminar viscosity
108  virtual tmp<volScalarField> nu() const
109  {
110  return nu_;
111  }
112 
113  //- Return the laminar viscosity for patch
114  virtual tmp<scalarField> nu(const label patchi) const
115  {
116  return nu_.boundaryField()[patchi];
117  }
118 
119  //- Correct the laminar viscosity
120  virtual void correct()
121  {
122  nu_ = calcNu();
123  }
124 
125  //- Read transportProperties dictionary
126  virtual bool read(const dictionary& viscosityProperties);
127 };
128 
129 
130 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
131 
132 } // End namespace viscosityModels
133 } // End namespace Foam
134 
135 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
136 
137 #endif
138 
139 // ************************************************************************* //
volFields.H
Foam::viscosityModel
An abstract base class for incompressible viscosityModels.
Definition: viscosityModel.H:67
Foam::viscosityModels::powerLaw::~powerLaw
virtual ~powerLaw()=default
Destructor.
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:65
Foam::tmp
A class for managing temporary objects.
Definition: PtrList.H:61
Foam::viscosityModels::powerLaw::read
virtual bool read(const dictionary &viscosityProperties)
Read transportProperties dictionary.
Definition: powerLaw.C:110
Foam::viscosityModel::viscosityProperties
const dictionary & viscosityProperties() const
Return the phase transport properties dictionary.
Definition: viscosityModel.H:144
Foam::viscosityModels::powerLaw::nu
virtual tmp< scalarField > nu(const label patchi) const
Return the laminar viscosity for patch.
Definition: powerLaw.H:113
Foam::viscosityModels::powerLaw::nu
virtual tmp< volScalarField > nu() const
Return the laminar viscosity.
Definition: powerLaw.H:107
Foam::viscosityModels::powerLaw::powerLaw
powerLaw(const word &name, const dictionary &viscosityProperties, const volVectorField &U, const surfaceScalarField &phi)
Construct from components.
Definition: powerLaw.C:79
Foam::viscosityModels::powerLaw::TypeName
TypeName("powerLaw")
Runtime type information.
phi
surfaceScalarField & phi
Definition: setRegionFluidFields.H:8
Foam::viscosityModels::powerLaw::calcNu
tmp< volScalarField > calcNu() const
Calculate and return the laminar viscosity.
Definition: powerLaw.C:54
Foam::viscosityModels::powerLaw::nu_
volScalarField nu_
Definition: powerLaw.H:73
Foam::viscosityModels::powerLaw::correct
virtual void correct()
Correct the laminar viscosity.
Definition: powerLaw.H:119
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:123
Foam::dimensioned< scalar >
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::viscosityModels::powerLaw
Standard power-law non-Newtonian viscosity model.
Definition: powerLaw.H:55
dimensionedScalar.H
U
U
Definition: pEqn.H:72
Foam::name
word name(const expressions::valueTypeCode typeCode)
A word representation of a valueTypeCode. Empty for INVALID.
Definition: exprTraits.C:59
Foam::GeometricField< scalar, fvPatchField, volMesh >
Foam::GeometricField::boundaryField
const Boundary & boundaryField() const
Return const-reference to the boundary field.
Definition: GeometricFieldI.H:62