ParticleStressModel.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) 2013-2014 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::ParticleStressModel
26 
27 Description
28  Base class for inter-particle stress models.
29 
30 SourceFiles
31  exponential.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef ParticleStressModel_H
36 #define ParticleStressModel_H
37 
38 #include "Field.H"
39 #include "FieldField.H"
40 #include "dictionary.H"
41 #include "runTimeSelectionTables.H"
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 
48 /*---------------------------------------------------------------------------*\
49  Class ParticleStressModel Declaration
50 \*---------------------------------------------------------------------------*/
51 
53 {
54 private:
55 
56  //- Private member functions
57 
58  //- Disallow default bitwise assignment
59  void operator=(const ParticleStressModel&);
60 
61 
62 protected:
63 
64  // Protected data
65 
66  //- Close pack volume fraction
67  scalar alphaPacked_;
68 
69 
70 public:
71 
72  //- Runtime type information
73  TypeName("particleStressModel");
74 
75  //- Declare runtime constructor selection table
77  (
78  autoPtr,
80  dictionary,
81  (const dictionary& dict),
82  (dict)
83  );
84 
85 
86  //- Constructors
87 
88  //- Construct from components
89  ParticleStressModel(const dictionary& dict);
90 
91  //- Construct a copy
93 
94  //- Construct and return a clone
95  virtual autoPtr<ParticleStressModel> clone() const = 0;
96 
97 
98  //- Selector
100  (
101  const dictionary& dict
102  );
103 
104 
105  //- Destructor
106  virtual ~ParticleStressModel();
107 
108 
109  //- Member Functions
110 
111  //- Access max volume fraction
112  scalar alphaPacked() const;
113 
114  //- Collision stress
115  virtual tmp<Field<scalar> > tau
116  (
117  const Field<scalar>& alpha,
118  const Field<scalar>& rho,
119  const Field<scalar>& uRms
120  ) const = 0;
121 
122  //- Collision stress derivaive w.r.t. the volume fraction
123  virtual tmp<Field<scalar> > dTaudTheta
124  (
125  const Field<scalar>& alpha,
126  const Field<scalar>& rho,
127  const Field<scalar>& uRms
128  ) const = 0;
129 
130  //- Collision stress using FieldFields
132  (
135  const FieldField<Field, scalar>& uRms
136  ) const;
137 };
138 
139 
140 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
141 
142 } // End namespace Foam
143 
144 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
145 
146 #endif
147 
148 // ************************************************************************* //
virtual ~ParticleStressModel()
Destructor.
scalar alphaPacked() const
Member Functions.
Generic field type.
Definition: FieldField.H:51
Base class for inter-particle stress models.
Macros to ease declaration of run-time selection tables.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
Namespace for OpenFOAM.
dictionary dict
const dimensionedScalar alpha
Fine-structure constant: default SI units: [].
virtual autoPtr< ParticleStressModel > clone() const =0
Construct and return a clone.
ParticleStressModel(const dictionary &dict)
Constructors.
static autoPtr< ParticleStressModel > New(const dictionary &dict)
Selector.
TypeName("particleStressModel")
Runtime type information.
virtual tmp< Field< scalar > > dTaudTheta(const Field< scalar > &alpha, const Field< scalar > &rho, const Field< scalar > &uRms) const =0
Collision stress derivaive w.r.t. the volume fraction.
virtual tmp< Field< scalar > > tau(const Field< scalar > &alpha, const Field< scalar > &rho, const Field< scalar > &uRms) const =0
Collision stress.
declareRunTimeSelectionTable(autoPtr, ParticleStressModel, dictionary,(const dictionary &dict),(dict))
Declare runtime constructor selection table.
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:117
A class for managing temporary objects.
Definition: PtrList.H:118
scalar alphaPacked_
Close pack volume fraction.