JohnsonJacksonParticleThetaFvPatchScalarField.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::JohnsonJacksonParticleThetaFvPatchScalarField
26 
27 Description
28  Robin condition for the particulate granular temperature.
29 
30  References:
31  \verbatim
32  "Multifluid Eulerian modeling of dense gas–solids fluidized bed
33  hydrodynamics: Influence of the dissipation parameters"
34  Reuge, N.,
35  Chemical Engineering Science
36  Volume 63, Issue 22, November 2008, pp. 5540-5551
37  \endverbatim
38 
39  \verbatim
40  "Frictional-collisional constitutive relations for granular materials,
41  with application to plane shearing"
42  Johnson, P.C., and Jackson, R.,
43  Journal of Fluid Mechanics
44  Volume 176, March 1987, pp. 67-93
45  \endverbatim
46 
47 SourceFiles
48  JohnsonJacksonParticleThetaFvPatchScalarField.C
49 
50 \*---------------------------------------------------------------------------*/
51 
52 #ifndef JohnsonJacksonParticleThetaFvPatchScalarField_H
53 #define JohnsonJacksonParticleThetaFvPatchScalarField_H
54 
55 #include "mixedFvPatchFields.H"
56 
57 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
58 
59 namespace Foam
60 {
61 
62 /*---------------------------------------------------------------------------*\
63  Class JohnsonJacksonParticleThetaFvPatchScalarField Declaration
64 \*---------------------------------------------------------------------------*/
65 
67 :
68  public mixedFvPatchScalarField
69 {
70  // Private data
71 
72  //- Particle-wall restitution coefficient
73  dimensionedScalar restitutionCoefficient_;
74 
75  //- Specularity coefficient
76  dimensionedScalar specularityCoefficient_;
77 
78 
79 public:
80 
81  //- Runtime type information
82  TypeName("JohnsonJacksonParticleTheta");
83 
84 
85  // Constructors
86 
87  //- Construct from patch and internal field
89  (
90  const fvPatch&,
92  );
93 
94  //- Construct from patch, internal field and dictionary
96  (
97  const fvPatch&,
99  const dictionary&
100  );
101 
102  //- Construct by mapping onto a new patch
104  (
106  const fvPatch&,
108  const fvPatchFieldMapper&
109  );
110 
111  //- Construct as copy
113  (
115  );
116 
117  //- Construct and return a clone
118  virtual tmp<fvPatchScalarField> clone() const
119  {
121  (
123  );
124  }
125 
126  //- Construct as copy setting internal field reference
128  (
131  );
132 
133  //- Construct and return a clone setting internal field reference
135  (
137  ) const
138  {
140  (
142  );
143  }
144 
145 
146  // Member functions
147 
148  // Mapping functions
149 
150  //- Map (and resize as needed) from self given a mapping object
151  virtual void autoMap
152  (
153  const fvPatchFieldMapper&
154  );
155 
156  //- Reverse map the given fvPatchField onto this fvPatchField
157  virtual void rmap
158  (
159  const fvPatchScalarField&,
160  const labelList&
161  );
162 
163  //- Update the coefficients
164  virtual void updateCoeffs();
165 
166  //- Write
167  virtual void write(Ostream&) const;
168 };
169 
170 
171 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
172 
173 } // End namespace Foam
174 
175 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
176 
177 #endif
178 
179 // ************************************************************************* //
JohnsonJacksonParticleThetaFvPatchScalarField(const fvPatch &, const DimensionedField< scalar, volMesh > &)
Construct from patch and internal field.
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
Foam::fvPatchFieldMapper.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
Namespace for OpenFOAM.
virtual void rmap(const fvPatchScalarField &, const labelList &)
Reverse map the given fvPatchField onto this fvPatchField.
virtual void autoMap(const fvPatchFieldMapper &)
Map (and resize as needed) from self given a mapping object.
TypeName("JohnsonJacksonParticleTheta")
Runtime type information.
Abstract base class with a fat-interface to all derived classes covering all possible ways in which t...
Definition: fvPatchField.H:65
virtual void write(Ostream &) const
Write.
virtual void updateCoeffs()
Update the coefficients.
virtual tmp< fvPatchScalarField > clone() const
Construct and return a clone.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:53
Robin condition for the particulate granular temperature.
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:61
A class for managing temporary objects.
Definition: PtrList.H:118