CrossPowerLaw.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::CrossPowerLaw
26 
27 Description
28  An incompressible Cross-Power law non-Newtonian viscosity model.
29 
30 SourceFiles
31  CrossPowerLaw.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef CrossPowerLaw_H
36 #define CrossPowerLaw_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 CrossPowerLaw Declaration
51 \*---------------------------------------------------------------------------*/
52 
53 class CrossPowerLaw
54 :
55  public viscosityModel
56 {
57  // Private data
58 
59  dictionary CrossPowerLawCoeffs_;
60 
61  dimensionedScalar nu0_;
62  dimensionedScalar nuInf_;
65 
66  volScalarField nu_;
67 
68  // Private Member Functions
69 
70  //- Calculate and return the laminar viscosity
71  tmp<volScalarField> calcNu() const;
72 
73 
74 public:
75 
76  //- Runtime type information
77  TypeName("CrossPowerLaw");
78 
79 
80  // Constructors
81 
82  //- Construct from components
84  (
85  const word& name,
87  const volVectorField& U,
88  const surfaceScalarField& phi
89  );
90 
91 
92  //- Destructor
94  {}
95 
96 
97  // Member Functions
98 
99  //- Return the laminar viscosity
100  tmp<volScalarField> nu() const
101  {
102  return nu_;
103  }
104 
105  //- Return the laminar viscosity for patch
106  tmp<scalarField> nu(const label patchi) const
107  {
108  return nu_.boundaryField()[patchi];
109  }
110 
111  //- Correct the laminar viscosity
112  void correct()
113  {
114  nu_ = calcNu();
115  }
116 
117  //- Read transportProperties dictionary
118  bool read(const dictionary& viscosityProperties);
119 };
120 
121 
122 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
123 
124 } // End namespace viscosityModels
125 } // End namespace Foam
126 
127 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
128 
129 #endif
130 
131 // ************************************************************************* //
GeometricBoundaryField & boundaryField()
Return reference to GeometricBoundaryField.
word name(const complex &)
Return a string representation of a complex.
Definition: complex.C:47
An incompressible Cross-Power law non-Newtonian viscosity model.
Definition: CrossPowerLaw.H:52
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
CrossPowerLaw(const word &name, const dictionary &viscosityProperties, const volVectorField &U, const surfaceScalarField &phi)
Construct from components.
Definition: CrossPowerLaw.C:60
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
Namespace for OpenFOAM.
label patchi
bool read(const dictionary &viscosityProperties)
Read transportProperties dictionary.
Definition: CrossPowerLaw.C:91
surfaceScalarField & phi
void correct()
Correct the laminar viscosity.
TypeName("CrossPowerLaw")
Runtime type information.
tmp< volScalarField > nu() const
Return the laminar viscosity.
Definition: CrossPowerLaw.H:99
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