exponential.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2013-2020 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::ParticleStressModels::exponential
26 
27 Description
28  Exponential inter-particle stress model of the same form as used in
29  twoPhaseEulerFoam
30 
31 SourceFiles
32  exponential.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef exponential_H
37 #define exponential_H
38 
39 #include "ParticleStressModel.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 namespace ParticleStressModels
46 {
47 
48 /*---------------------------------------------------------------------------*\
49  Class exponential Declaration
50 \*---------------------------------------------------------------------------*/
51 
52 class exponential
53 :
54  public ParticleStressModel
55 {
56  // Private Data
57 
58  //- Pre-exponential factor
59  scalar preExp_;
60 
61  //- Maximum limit of the exponential
62  scalar expMax_;
63 
64  //- Front coefficient
65  scalar g0_;
66 
67 
68 public:
69 
70  //- Runtime type information
71  TypeName("exponential");
72 
73 
74  //- Constructors
75 
76  //- Construct from components
77  exponential(const dictionary& dict);
78 
79  //- Construct copy
80  exponential(const exponential& hc);
81 
82  //- Clone
83  virtual autoPtr<ParticleStressModel> clone() const
84  {
86  (
87  new exponential(*this)
88  );
89  }
90 
91 
92  //- Destructor
93  virtual ~exponential();
94 
95 
96  //- Member Functions
97 
98  //- Collision stress
100  (
101  const Field<scalar>& alpha,
102  const Field<scalar>& rho,
103  const Field<scalar>& uRms
104  ) const;
105 
106  //- Collision stress derivative w.r.t. the volume fraction
108  (
109  const Field<scalar>& alpha,
110  const Field<scalar>& rho,
111  const Field<scalar>& uRms
112  ) const;
113 };
114 
115 
116 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
117 
118 } // End namespace ParticleStressModels
119 } // End namespace Foam
120 
121 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
122 
123 #endif
124 
125 // ************************************************************************* //
tmp< Field< scalar > > tau(const Field< scalar > &alpha, const Field< scalar > &rho, const Field< scalar > &uRms) const
Member Functions.
Definition: exponential.C:83
dictionary dict
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
volScalarField alpha(IOobject("alpha", runTime.timeName(), mesh, IOobject::READ_IF_PRESENT, IOobject::AUTO_WRITE), lambda *max(Ua &U, zeroSensitivity))
Exponential inter-particle stress model of the same form as used in twoPhaseEulerFoam.
Definition: exponential.H:51
TypeName("exponential")
Runtime type information.
virtual ~exponential()
Destructor.
Definition: exponential.C:75
exponential(const dictionary &dict)
Constructors.
Definition: exponential.C:50
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:52
A class for managing temporary objects.
Definition: PtrList.H:53
tmp< Field< scalar > > dTaudTheta(const Field< scalar > &alpha, const Field< scalar > &rho, const Field< scalar > &uRms) const
Collision stress derivative w.r.t. the volume fraction.
Definition: exponential.C:95
virtual autoPtr< ParticleStressModel > clone() const
Clone.
Definition: exponential.H:82
Base class for inter-particle stress models.
Namespace for OpenFOAM.