BinghamPlastic.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) 2014-2015 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::mixtureViscosityModels::BinghamPlastic
26 
27 Description
28  Viscosity correction model for Bingham plastics.
29 
30  The strain-rate used is defined as sqrt(2.0)*mag(symm(grad(U)))
31 
32 SourceFiles
33  BinghamPlastic.C
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef BinghamPlastic_H
38 #define BinghamPlastic_H
39 
40 #include "plastic.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 namespace mixtureViscosityModels
47 {
48 
49 /*---------------------------------------------------------------------------*\
50  Class BinghamPlastic Declaration
51 \*---------------------------------------------------------------------------*/
52 
53 class BinghamPlastic
54 :
55  public plastic
56 {
57 protected:
58 
59  // Protected data
60 
61  //- Yield stress coefficient
63 
64  //- Yield stress exponent
66 
67  //- Yield stress offset
69 
70  //- Velocity
71  const volVectorField& U_;
72 
73 
74 public:
75 
76  //- Runtime type information
77  TypeName("BinghamPlastic");
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 mixture viscosity
100  // given the viscosity of the continuous phase
101  tmp<volScalarField> mu(const volScalarField& muc) const;
102 
103  //- Read transportProperties dictionary
104  bool read(const dictionary& viscosityProperties);
105 };
106 
107 
108 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
109 
110 } // End namespace mixtureViscosityModels
111 } // End namespace Foam
112 
113 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
114 
115 #endif
116 
117 // ************************************************************************* //
word name(const complex &)
Return a string representation of a complex.
Definition: complex.C:47
tmp< volScalarField > mu(const volScalarField &muc) const
Return the mixture viscosity.
BinghamPlastic(const word &name, const dictionary &viscosityProperties, const volVectorField &U, const surfaceScalarField &phi)
Construct from components.
A class for handling words, derived from string.
Definition: word.H:59
dimensionedScalar yieldStressOffset_
Yield stress offset.
Viscosity correction model for a generic power-law plastic.
Definition: plastic.H:55
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
Namespace for OpenFOAM.
TypeName("BinghamPlastic")
Runtime type information.
const dictionary & viscosityProperties() const
Return the phase transport properties dictionary.
Viscosity correction model for Bingham plastics.
surfaceScalarField & phi
dimensionedScalar yieldStressCoeff_
Yield stress coefficient.
const volVectorField & U_
Velocity.
bool read(const dictionary &viscosityProperties)
Read transportProperties dictionary.
dimensionedScalar yieldStressExponent_
Yield stress exponent.
A class for managing temporary objects.
Definition: PtrList.H:118
U
Definition: pEqn.H:82