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-2021 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  Reuge, N., Cadoret, L., Coufort-Saudejaud, C., Pannala, S., Syamlal, M.,
33  & Caussat, B. (2008).
34  Multifluid Eulerian modeling of dense gas–solids fluidised bed
35  hydrodynamics: influence of the dissipation parameters.
36  Chemical Engineering Science, 63(22), 5540-5551.
37  \endverbatim
38 
39  \verbatim
40  Johnson, P. C., & Jackson, R. (1987).
41  Frictional–collisional constitutive relations for granular materials,
42  with application to plane shearing.
43  Journal of fluid Mechanics, 176, 67-93.
44  \endverbatim
45 
46 SourceFiles
47  JohnsonJacksonParticleSlipFvPatchVectorField.C
48 
49 \*---------------------------------------------------------------------------*/
50 
51 #ifndef JohnsonJacksonParticleSlipFvPatchVectorField_H
52 #define JohnsonJacksonParticleSlipFvPatchVectorField_H
53 
55 
56 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
57 
58 namespace Foam
59 {
60 
61 /*---------------------------------------------------------------------------*\
62  Class JohnsonJacksonParticleSlipFvPatchVectorField Declaration
63 \*---------------------------------------------------------------------------*/
64 
66 :
67  public partialSlipFvPatchVectorField
68 {
69  // Private Data
70 
71  //- Specularity coefficient
72  dimensionedScalar specularityCoefficient_;
73 
74 
75 public:
76 
77  //- Runtime type information
78  TypeName("JohnsonJacksonParticleSlip");
79 
80 
81  // Constructors
82 
83  //- Construct from patch and internal field
85  (
86  const fvPatch&,
88  );
89 
90  //- Construct from patch, internal field and dictionary
92  (
93  const fvPatch&,
95  const dictionary&
96  );
97 
98  //- Construct by mapping onto a new patch
100  (
102  const fvPatch&,
104  const fvPatchFieldMapper&
105  );
106 
107  //- Disallow copy without setting internal field reference
109  (
111  ) = delete;
112 
113  //- Copy constructor setting internal field reference
115  (
118  );
119 
120  //- Construct and return a clone setting internal field reference
122  (
124  ) const
125  {
127  (
129  );
130  }
131 
132 
133  // Member Functions
134 
135  // Mapping functions
136 
137  //- Map (and resize as needed) from self given a mapping object
138  // Used to update fields following mesh topology change
139  virtual void autoMap(const fvPatchFieldMapper&);
140 
141  //- Reverse map the given fvPatchField onto this fvPatchField
142  // Used to reconstruct fields
143  virtual void rmap(const fvPatchVectorField&, const labelList&);
144 
145 
146  //- Update the coefficients
147  virtual void updateCoeffs();
148 
149  //- Write
150  virtual void write(Ostream&) const;
151 
152 };
153 
154 
155 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
156 
157 } // End namespace Foam
158 
159 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
160 
161 #endif
162 
163 // ************************************************************************* //
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.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
virtual void rmap(const fvPatchVectorField &, const labelList &)
Reverse map the given fvPatchField onto this fvPatchField.
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:62
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:54
virtual tmp< fvPatchVectorField > clone(const DimensionedField< vector, volMesh > &iF) const
Construct and return a clone setting internal field reference.
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.