Forward compatibility: flex
[foam-extend-3.2.git] / src / solidModels / constitutiveModel / rheologyLaws / linearElastic / linearElastic.H
blob63643449c9c56420a978b39562d6297cac1d8d76
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | foam-extend: Open Source CFD
4    \\    /   O peration     | Version:     3.2
5     \\  /    A nd           | Web:         http://www.foam-extend.org
6      \\/     M anipulation  | For copyright notice see file Copyright
7 -------------------------------------------------------------------------------
8 License
9     This file is part of foam-extend.
11     foam-extend is free software: you can redistribute it and/or modify it
12     under the terms of the GNU General Public License as published by the
13     Free Software Foundation, either version 3 of the License, or (at your
14     option) any later version.
16     foam-extend is distributed in the hope that it will be useful, but
17     WITHOUT ANY WARRANTY; without even the implied warranty of
18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
19     General Public License for more details.
21     You should have received a copy of the GNU General Public License
22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
24 Class
25     linearElastic
27 Description
28     Linear elastic rheology
30 SourceFiles
31     linearElastic.C
33 \*---------------------------------------------------------------------------*/
35 #ifndef linearElastic_H
36 #define linearElastic_H
38 #include "rheologyLaw.H"
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 namespace Foam
45 /*---------------------------------------------------------------------------*\
46                          Class linearElastic Declaration
47 \*---------------------------------------------------------------------------*/
49 class linearElastic
51     public rheologyLaw
53     // Private data
55         //- Density
56         dimensionedScalar rho_;
58         //- Modulus of elasticity
59         dimensionedScalar E_;
61         //- Poisson's ratio
62         dimensionedScalar nu_;
64     // Private Member Functions
66         //- Disallow default bitwise copy construct
67         linearElastic(const linearElastic&);
69         //- Disallow default bitwise assignment
70         void operator=(const linearElastic&);
72 public:
74     //- Runtime type information
75     TypeName("linearElastic");
77     // Static data members
80     // Constructors
82         //- Construct from dictionary
83         linearElastic
84         (
85             const word& name,
86             const volSymmTensorField& sigma,
87             const dictionary& dict
88         );
91     // Destructor
93         virtual ~linearElastic();
96     // Member Functions
98         //- Return density
99         virtual tmp<volScalarField> rho() const;
101         //- Return modulus of elasticity
102         virtual tmp<volScalarField> E() const;
104         //- Return Poisson's ratio
105         virtual tmp<volScalarField> nu() const;
107         //- Return density
108         virtual tmp<volScalarField> rho(scalar t) const
109         {
110             return rho();
111         }
113         //- Return modulus of elasticity
114         virtual tmp<volScalarField> E(scalar t) const
115         {
116             return E();
117         }
119         virtual tmp<volScalarField> E(const volScalarField& epsEq) const
120         {
121             return E();
122         }
124         //- Return Poisson's ratio
125         virtual tmp<volScalarField> nu(scalar t) const
126         {
127             return nu();
128         }
130         //- Return creep compliance
131         virtual tmp<volScalarField> J(scalar t) const
132         {
133             notImplemented(type() + "::J(scalar t)");
135             return 1.0/E(t);
136         }
138         //- Return modulus of plasticity
139         virtual tmp<volScalarField> Ep() const;
141         virtual tmp<volScalarField> Ep(const volScalarField& sigmaEq) const
142         {
143             return Ep();
144         }
146         //- Return yield stress
147         virtual tmp<volScalarField> sigmaY() const;
149         //- Return yield stress given cellID
150         virtual scalar sigmaY
151         (const scalar epsilonPEq, const label cellID) const;
153         //- Correct the rheological model
154         virtual void correct()
155         {}
159 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
161 } // End namespace Foam
163 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
165 #endif
167 // ************************************************************************* //