plastic.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) 2014 OpenFOAM Foundation
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 Class
27  Foam::mixtureViscosityModels::plastic
28 
29 Description
30  Viscosity correction model for a generic power-law plastic.
31 
32 SourceFiles
33  plastic.C
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef plastic_H
38 #define plastic_H
39 
40 #include "mixtureViscosityModel.H"
41 #include "dimensionedScalar.H"
42 #include "volFields.H"
43 
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45 
46 namespace Foam
47 {
48 
49 class incompressibleTwoPhaseInteractingMixture;
50 
51 namespace mixtureViscosityModels
52 {
53 
54 /*---------------------------------------------------------------------------*\
55  Class plastic Declaration
56 \*---------------------------------------------------------------------------*/
57 
58 class plastic
59 :
61 {
62 protected:
63 
64  // Protected data
65 
66  //- Dictionary
68 
69  //- Plastic viscosity coefficient
71 
72  //- Plastic viscosity exponent
74 
75  //- Maximum viscosity
77 
78  //- Plastic phase fraction
79  const volScalarField& alpha_;
80 
81 
82 public:
83 
84  //- Runtime type information
85  TypeName("plastic");
86 
87 
88  // Constructors
89 
90  //- Construct from components
91  plastic
92  (
93  const word& name,
95  const volVectorField& U,
96  const surfaceScalarField& phi,
97  const word modelName=typeName
98  );
99 
100 
101  //- Destructor
102  ~plastic()
103  {}
104 
105 
106  // Member Functions
107 
108  //- Return the mixture viscosity
109  // given the viscosity of the continuous phase
110  tmp<volScalarField> mu(const volScalarField& muc) const;
111 
112  //- Read transportProperties dictionary
113  bool read(const dictionary& viscosityProperties);
114 };
115 
116 
117 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
118 
119 } // End namespace mixtureViscosityModels
120 } // End namespace Foam
121 
122 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
123 
124 #endif
125 
126 // ************************************************************************* //
volFields.H
Foam::mixtureViscosityModels::plastic::read
bool read(const dictionary &viscosityProperties)
Read transportProperties dictionary.
Foam::mixtureViscosityModels::plastic::alpha_
const volScalarField & alpha_
Plastic phase fraction.
Definition: plastic.H:78
Foam::mixtureViscosityModels::plastic::muMax_
dimensionedScalar muMax_
Maximum viscosity.
Definition: plastic.H:75
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::mixtureViscosityModel
An abstract base class for incompressible mixtureViscosityModels.
Definition: mixtureViscosityModel.H:62
Foam::mixtureViscosityModels::plastic::plastic
plastic(const word &name, const dictionary &viscosityProperties, const volVectorField &U, const surfaceScalarField &phi, const word modelName=typeName)
Construct from components.
Foam::mixtureViscosityModels::plastic::plasticViscosityCoeff_
dimensionedScalar plasticViscosityCoeff_
Plastic viscosity coefficient.
Definition: plastic.H:69
Foam::mixtureViscosityModels::plastic::plasticViscosityExponent_
dimensionedScalar plasticViscosityExponent_
Plastic viscosity exponent.
Definition: plastic.H:72
Foam::mixtureViscosityModel::viscosityProperties
const dictionary & viscosityProperties() const
Return the phase transport properties dictionary.
Definition: mixtureViscosityModel.H:139
mixtureViscosityModel.H
phi
surfaceScalarField & phi
Definition: setRegionFluidFields.H:8
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::mixtureViscosityModels::plastic::plasticCoeffs_
dictionary plasticCoeffs_
Dictionary.
Definition: plastic.H:66
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::mixtureViscosityModels::plastic::TypeName
TypeName("plastic")
Runtime type information.
dimensionedScalar.H
U
U
Definition: pEqn.H:72
Foam::mixtureViscosityModels::plastic::~plastic
~plastic()
Destructor.
Definition: plastic.H:101
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::mixtureViscosityModels::plastic
Viscosity correction model for a generic power-law plastic.
Definition: plastic.H:57
Foam::mixtureViscosityModels::plastic::mu
tmp< volScalarField > mu(const volScalarField &muc) const
Return the mixture viscosity.