JohnsonJacksonParticleSlipFvPatchVectorField.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) 2014-2019 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::JohnsonJacksonParticleSlipFvPatchVectorField
26 
27 Description
28  Partial slip boundary condition for the particulate velocity.
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  JohnsonJacksonParticleSlipFvPatchVectorField.C
49 
50 \*---------------------------------------------------------------------------*/
51 
52 #ifndef JohnsonJacksonParticleSlipFvPatchVectorField_H
53 #define JohnsonJacksonParticleSlipFvPatchVectorField_H
54 
56 
57 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
58 
59 namespace Foam
60 {
61 
62 /*---------------------------------------------------------------------------*\
63  Class JohnsonJacksonParticleSlipFvPatchVectorField Declaration
64 \*---------------------------------------------------------------------------*/
65 
66 class JohnsonJacksonParticleSlipFvPatchVectorField
67 :
68  public partialSlipFvPatchVectorField
69 {
70  // Private Data
71 
72  //- Specularity coefficient
73  dimensionedScalar specularityCoefficient_;
74 
75 
76 public:
77 
78  //- Runtime type information
79  TypeName("JohnsonJacksonParticleSlip");
80 
81 
82  // Constructors
83 
84  //- Construct from patch and internal field
86  (
87  const fvPatch&,
88  const DimensionedField<vector, volMesh>&
89  );
90 
91  //- Construct from patch, internal field and dictionary
93  (
94  const fvPatch&,
95  const DimensionedField<vector, volMesh>&,
96  const dictionary&
97  );
98 
99  //- Construct by mapping onto a new patch
101  (
103  const fvPatch&,
104  const DimensionedField<vector, volMesh>&,
105  const fvPatchFieldMapper&
106  );
107 
108  //- Copy constructor
110  (
112  );
113 
114  //- Construct and return a clone
115  virtual tmp<fvPatchVectorField> clone() const
116  {
118  (
120  );
121  }
122 
123  //- Copy constructor setting internal field reference
125  (
128  );
129 
130  //- Construct and return a clone setting internal field reference
132  (
134  ) const
135  {
137  (
139  );
140  }
141 
142 
143  // Member Functions
144 
145  // Mapping functions
146 
147  //- Map (and resize as needed) from self given a mapping object
148  // Used to update fields following mesh topology change
149  virtual void autoMap(const fvPatchFieldMapper&);
150 
151  //- Reverse map the given fvPatchField onto this fvPatchField
152  // Used to reconstruct fields
153  virtual void rmap(const fvPatchVectorField&, const labelList&);
154 
155 
156  //- Update the coefficients
157  virtual void updateCoeffs();
158 
159  //- Write
160  virtual void write(Ostream&) const;
161 
162 };
163 
164 
165 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
166 
167 } // End namespace Foam
168 
169 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
170 
171 #endif
172 
173 // ************************************************************************* //
virtual tmp< fvPatchVectorField > clone() const
Construct and return a clone.
virtual void autoMap(const fvPatchFieldMapper &)
Map (and resize as needed) from self given a mapping object.
virtual void write(Ostream &) const
Write.
JohnsonJacksonParticleSlipFvPatchVectorField(const fvPatch &, const DimensionedField< vector, volMesh > &)
Construct from patch and internal field.
virtual void rmap(const fvPatchVectorField &, const labelList &)
Reverse map the given fvPatchField onto this fvPatchField.
Abstract base class with a fat-interface to all derived classes covering all possible ways in which t...
Definition: fvPatchField.H:66
Foam::fvPatchFieldMapper.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:53
dimensioned< scalar > dimensionedScalar
Dimensioned scalar obtained from generic dimensioned type.
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
virtual void updateCoeffs()
Update the coefficients.
Partial slip boundary condition for the particulate velocity.
TypeName("JohnsonJacksonParticleSlip")
Runtime type information.
A class for managing temporary objects.
Definition: PtrList.H:53
Namespace for OpenFOAM.