granularPressureModel.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) 2011-2024 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::kineticTheoryModels::granularPressureModel
26 
27 SourceFiles
28  granularPressureModel.C
29 
30 \*---------------------------------------------------------------------------*/
31 
32 #ifndef granularPressureModel_H
33 #define granularPressureModel_H
34 
35 #include "dictionary.H"
36 #include "volFields.H"
37 #include "dimensionedTypes.H"
38 #include "runTimeSelectionTables.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 namespace kineticTheoryModels
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class granularPressureModel Declaration
49 \*---------------------------------------------------------------------------*/
50 
52 {
53  // Private member functions
54 
55  //- Read the coefficients from coeffDict
56  virtual bool readCoeffs(const dictionary& coeffDict)
57  {
58  return true;
59  }
60 
61 
62 public:
63 
64  //- Runtime type information
65  TypeName("granularPressureModel");
66 
67  // Declare runtime constructor selection table
69  (
70  autoPtr,
72  dictionary,
73  (
74  const dictionary& dict
75  ),
76  (dict)
77  );
78 
79 
80  // Constructors
81 
82  //- Construct from the coefficients dictionary
83  granularPressureModel(const dictionary& coeffDict);
84 
85  //- Disallow default bitwise copy construction
87 
88 
89  // Selectors
90 
92  (
93  const dictionary& dict
94  );
95 
96 
97  //- Destructor
98  virtual ~granularPressureModel();
99 
100 
101  // Member Functions
102 
103  //- Read the coefficients from the optional ".*Coeffs" sub-dictionary
104  // of the given dictionary
105  bool read(const dictionary& dict);
106 
107  //- Granular pressure coefficient
109  (
110  const volScalarField& alpha1,
111  const volScalarField& g0,
112  const volScalarField& rho1,
113  const dimensionedScalar& e
114  ) const = 0;
115 
116  //- Derivative of the granular pressure coefficient
118  (
119  const volScalarField& alpha1,
120  const volScalarField& g0,
121  const volScalarField& g0prime,
122  const volScalarField& rho1,
123  const dimensionedScalar& e
124  ) const = 0;
125 
126 
127  // Member Operators
128 
129  //- Disallow default bitwise assignment
130  void operator=(const granularPressureModel&) = delete;
131 };
132 
133 
134 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
135 
136 } // End namespace kineticTheoryModels
137 } // End namespace Foam
138 
139 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
140 
141 #endif
142 
143 // ************************************************************************* //
Generic GeometricField class.
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: autoPtr.H:51
A list of keywords followed by any number of values (e.g. words and numbers) or sub-dictionaries.
Definition: dictionary.H:162
virtual tmp< volScalarField > granularPressureCoeff(const volScalarField &alpha1, const volScalarField &g0, const volScalarField &rho1, const dimensionedScalar &e) const =0
Granular pressure coefficient.
TypeName("granularPressureModel")
Runtime type information.
virtual tmp< volScalarField > granularPressureCoeffPrime(const volScalarField &alpha1, const volScalarField &g0, const volScalarField &g0prime, const volScalarField &rho1, const dimensionedScalar &e) const =0
Derivative of the granular pressure coefficient.
static autoPtr< granularPressureModel > New(const dictionary &dict)
bool read(const dictionary &dict)
Read the coefficients from the optional ".*Coeffs" sub-dictionary.
declareRunTimeSelectionTable(autoPtr, granularPressureModel, dictionary,(const dictionary &dict),(dict))
void operator=(const granularPressureModel &)=delete
Disallow default bitwise assignment.
granularPressureModel(const dictionary &coeffDict)
Construct from the coefficients dictionary.
A class for managing temporary objects.
Definition: tmp.H:55
Namespace for OpenFOAM.
const doubleScalar e
Definition: doubleScalar.H:106
Macros to ease declaration of run-time selection tables.
dictionary dict