From 7aa867a0a5e98af925a64173ced7e40722de5d24 Mon Sep 17 00:00:00 2001
From: william <william>
Date: Wed, 18 Dec 2013 09:44:57 +0000
Subject: [PATCH] ENH: added header documentation to MPPIC classes
---
.../clouds/Templates/MPPICCloud/MPPICCloud.H | 2 +-
.../Templates/MPPICParcel/MPPICParcel.H | 3 +-
.../basicKinematicMPPICParcel.H | 2 +-
.../makeBasicKinematicMPPICParcelSubmodels.C | 1 -
.../AveragingMethod/AveragingMethod.H | 3 +-
.../MPPIC/AveragingMethods/Basic/Basic.H | 10 +++++++
.../MPPIC/AveragingMethods/Dual/Dual.H | 14 ++++++++++
.../MPPIC/AveragingMethods/Moment/Moment.H | 11 ++++++++
.../CorrectionLimitingMethod.H | 1 +
.../absolute/absolute.H | 4 +++
.../relative/relative.H | 4 +++
.../DampingModels/DampingModel/DampingModel.H | 2 +-
.../MPPIC/DampingModels/NoDamping/NoDamping.H | 3 +-
.../DampingModels/Relaxation/Relaxation.H | 16 +++++++++--
.../IsotropyModel/IsotropyModel.H | 2 +-
.../IsotropyModels/NoIsotropy/NoIsotropy.H | 3 +-
.../IsotropyModels/Stochastic/Stochastic.H | 20 +++++++++++--
.../MPPIC/PackingModels/Explicit/Explicit.H | 18 +++++++++++-
.../MPPIC/PackingModels/Implicit/Implicit.H | 10 ++++++-
.../MPPIC/PackingModels/NoPacking/NoPacking.H | 3 +-
.../PackingModels/PackingModel/PackingModel.H | 2 +-
.../HarrisCrighton/HarrisCrighton.H | 27 ++++++++++++++++++
.../MPPIC/ParticleStressModels/Lun/Lun.H | 28 +++++++++++++++++++
.../ParticleStressModel/ParticleStressModel.H | 9 ++++++
.../exponential/exponential.H | 10 +++++++
.../TimeScaleModel/TimeScaleModel.H | 9 ++++++
.../TimeScaleModels/equilibrium/equilibrium.H | 18 ++++++++++++
.../TimeScaleModels/isotropic/isotropic.H | 18 ++++++++++++
.../nonEquilibrium/nonEquilibrium.H | 19 +++++++++++++
29 files changed, 252 insertions(+), 20 deletions(-)
diff --git a/src/lagrangian/intermediate/clouds/Templates/MPPICCloud/MPPICCloud.H b/src/lagrangian/intermediate/clouds/Templates/MPPICCloud/MPPICCloud.H
index 2b142fae632..8583f6b7397 100644
--- a/src/lagrangian/intermediate/clouds/Templates/MPPICCloud/MPPICCloud.H
+++ b/src/lagrangian/intermediate/clouds/Templates/MPPICCloud/MPPICCloud.H
@@ -25,7 +25,7 @@ Class
Foam::MPPICCloud
Description
- Adds collisions to kinematic clouds
+ Adds MPPIC modelling to kinematic clouds
SourceFiles
MPPICCloudI.H
diff --git a/src/lagrangian/intermediate/parcels/Templates/MPPICParcel/MPPICParcel.H b/src/lagrangian/intermediate/parcels/Templates/MPPICParcel/MPPICParcel.H
index d0917a06eff..c095821f8da 100644
--- a/src/lagrangian/intermediate/parcels/Templates/MPPICParcel/MPPICParcel.H
+++ b/src/lagrangian/intermediate/parcels/Templates/MPPICParcel/MPPICParcel.H
@@ -25,10 +25,11 @@ Class
Foam::MPPICParcel
Description
- Wrapper around kinematic parcel types to add collision modelling
+ Wrapper around kinematic parcel types to add MPPIC modelling
SourceFiles
MPPICParcelI.H
+ MPPICParcelTrackingDataI.H
MPPICParcel.C
MPPICParcelIO.C
diff --git a/src/lagrangian/intermediate/parcels/derived/basicKinematicMPPICParcel/basicKinematicMPPICParcel.H b/src/lagrangian/intermediate/parcels/derived/basicKinematicMPPICParcel/basicKinematicMPPICParcel.H
index ee9b03870e1..d72dd536614 100644
--- a/src/lagrangian/intermediate/parcels/derived/basicKinematicMPPICParcel/basicKinematicMPPICParcel.H
+++ b/src/lagrangian/intermediate/parcels/derived/basicKinematicMPPICParcel/basicKinematicMPPICParcel.H
@@ -28,7 +28,7 @@ Description
Definition of basic kinematic MPPIC parcel
SourceFiles
- basicKinematicParcel.H
+ basicKinematicMPPICParcel.H
\*---------------------------------------------------------------------------*/
diff --git a/src/lagrangian/intermediate/parcels/derived/basicKinematicMPPICParcel/makeBasicKinematicMPPICParcelSubmodels.C b/src/lagrangian/intermediate/parcels/derived/basicKinematicMPPICParcel/makeBasicKinematicMPPICParcelSubmodels.C
index 5154df3a245..735c21f3efc 100644
--- a/src/lagrangian/intermediate/parcels/derived/basicKinematicMPPICParcel/makeBasicKinematicMPPICParcelSubmodels.C
+++ b/src/lagrangian/intermediate/parcels/derived/basicKinematicMPPICParcel/makeBasicKinematicMPPICParcelSubmodels.C
@@ -58,7 +58,6 @@ namespace Foam
makeMPPICParcelDampingModels(basicKinematicMPPICCloud);
makeMPPICParcelIsotropyModels(basicKinematicMPPICCloud);
makeMPPICParcelPackingModels(basicKinematicMPPICCloud);
-
}
diff --git a/src/lagrangian/intermediate/submodels/MPPIC/AveragingMethods/AveragingMethod/AveragingMethod.H b/src/lagrangian/intermediate/submodels/MPPIC/AveragingMethods/AveragingMethod/AveragingMethod.H
index 909459ceb4f..dddcea6f1a3 100644
--- a/src/lagrangian/intermediate/submodels/MPPIC/AveragingMethods/AveragingMethod/AveragingMethod.H
+++ b/src/lagrangian/intermediate/submodels/MPPIC/AveragingMethods/AveragingMethod/AveragingMethod.H
@@ -25,10 +25,11 @@ Class
Foam::AveragingMethod
Description
- Base-class for averaging lagrangian fields
+ Base class for lagrangian averaging methods.
SourceFiles
AveragingMethod.C
+ AveragingMethodI.H
\*---------------------------------------------------------------------------*/
diff --git a/src/lagrangian/intermediate/submodels/MPPIC/AveragingMethods/Basic/Basic.H b/src/lagrangian/intermediate/submodels/MPPIC/AveragingMethods/Basic/Basic.H
index d0b32e36d2b..4123b47ed93 100644
--- a/src/lagrangian/intermediate/submodels/MPPIC/AveragingMethods/Basic/Basic.H
+++ b/src/lagrangian/intermediate/submodels/MPPIC/AveragingMethods/Basic/Basic.H
@@ -24,6 +24,16 @@ License
Class
Foam::AveragingMethods::Basic
+Description
+ Basic lagrangian averaging procedure.
+
+ This is a cell-volume based average. Point values are summed over the
+ computational cells and the result is divided by the cell volume.
+
+ Interpolation is done assuming a constant value over each cells. Cell
+ gradients are calculated by the default fvc::grad scheme, and are also
+ assumed constant when interpolated.
+
SourceFiles
Basic.C
diff --git a/src/lagrangian/intermediate/submodels/MPPIC/AveragingMethods/Dual/Dual.H b/src/lagrangian/intermediate/submodels/MPPIC/AveragingMethods/Dual/Dual.H
index d86436fa956..537c1270b96 100644
--- a/src/lagrangian/intermediate/submodels/MPPIC/AveragingMethods/Dual/Dual.H
+++ b/src/lagrangian/intermediate/submodels/MPPIC/AveragingMethods/Dual/Dual.H
@@ -24,6 +24,20 @@ License
Class
Foam::AveragingMethods::Dual
+Description
+ Dual-mesh lagrangian averaging procedure.
+
+ Point values are summed using the tetrahedral decomposition of the
+ computational cells. Summation is done in the cells, and also in the
+ terahedrons surrounding each point. The latter forms a type of dual mesh.
+ The interpolation is weighted by proximity to the cell centre or point, as
+ calculated by the barycentric coordinate within the tethrahedron.
+
+ Values are interpolated linearly across the tethrahedron. Gradients are
+ calculated directly from the point values using a first order finite
+ element basis. The computed gradient is assumed constant over the
+ tethrahedron.
+
SourceFiles
Dual.C
diff --git a/src/lagrangian/intermediate/submodels/MPPIC/AveragingMethods/Moment/Moment.H b/src/lagrangian/intermediate/submodels/MPPIC/AveragingMethods/Moment/Moment.H
index 1f8df2cf4db..67aec06b582 100644
--- a/src/lagrangian/intermediate/submodels/MPPIC/AveragingMethods/Moment/Moment.H
+++ b/src/lagrangian/intermediate/submodels/MPPIC/AveragingMethods/Moment/Moment.H
@@ -24,6 +24,17 @@ License
Class
Foam::AveragingMethods::Moment
+Description
+ Moment lagrangian averaging procedure.
+
+ Point values and moments from the cell centroid are summed over
+ computational cells. A linear function is generated which has the same
+ integrated moment as that of the point data.
+
+ The computed linear function is used to interpolate values within a cell.
+ The gradient is calculated from the coefficients of the function, and is
+ assumed constant over the cell.
+
SourceFiles
Moment.C
diff --git a/src/lagrangian/intermediate/submodels/MPPIC/CorrectionLimitingMethods/CorrectionLimitingMethod/CorrectionLimitingMethod.H b/src/lagrangian/intermediate/submodels/MPPIC/CorrectionLimitingMethods/CorrectionLimitingMethod/CorrectionLimitingMethod.H
index b5ecba77fb0..a478d47e912 100644
--- a/src/lagrangian/intermediate/submodels/MPPIC/CorrectionLimitingMethods/CorrectionLimitingMethod/CorrectionLimitingMethod.H
+++ b/src/lagrangian/intermediate/submodels/MPPIC/CorrectionLimitingMethods/CorrectionLimitingMethod/CorrectionLimitingMethod.H
@@ -25,6 +25,7 @@ Class
Foam::CorrectionLimitingMethod
Description
+ Base class for correction limiting methods.
SourceFiles
CorrectionLimitingMethod.C
diff --git a/src/lagrangian/intermediate/submodels/MPPIC/CorrectionLimitingMethods/absolute/absolute.H b/src/lagrangian/intermediate/submodels/MPPIC/CorrectionLimitingMethods/absolute/absolute.H
index ef242a4c130..85fc18054e9 100644
--- a/src/lagrangian/intermediate/submodels/MPPIC/CorrectionLimitingMethods/absolute/absolute.H
+++ b/src/lagrangian/intermediate/submodels/MPPIC/CorrectionLimitingMethods/absolute/absolute.H
@@ -25,6 +25,10 @@ Class
Foam::CorrectionLimitingMethods::absolute
Description
+ Correction limiting method that limits the velocity correction to that of a
+ rebound with a coefficient of restitution $e$. The absolute velocity of the
+ particle is used when calculating the magnitude of the limited correction.
+ The direction is calculated using the relative velocity.
SourceFiles
absolute.C
diff --git a/src/lagrangian/intermediate/submodels/MPPIC/CorrectionLimitingMethods/relative/relative.H b/src/lagrangian/intermediate/submodels/MPPIC/CorrectionLimitingMethods/relative/relative.H
index 275ab396a08..73c772f7234 100644
--- a/src/lagrangian/intermediate/submodels/MPPIC/CorrectionLimitingMethods/relative/relative.H
+++ b/src/lagrangian/intermediate/submodels/MPPIC/CorrectionLimitingMethods/relative/relative.H
@@ -25,6 +25,10 @@ Class
Foam::CorrectionLimitingMethods::relative
Description
+ Correction limiting method that limits the velocity correction to that of a
+ rebound with a coefficient of restitution $e$. The relative velocity of the
+ particle with respect to the mean value is used to calculate the direction
+ and magnitude of the limited velocity.
SourceFiles
relative.C
diff --git a/src/lagrangian/intermediate/submodels/MPPIC/DampingModels/DampingModel/DampingModel.H b/src/lagrangian/intermediate/submodels/MPPIC/DampingModels/DampingModel/DampingModel.H
index 356cb727867..79edceeb9c6 100644
--- a/src/lagrangian/intermediate/submodels/MPPIC/DampingModels/DampingModel/DampingModel.H
+++ b/src/lagrangian/intermediate/submodels/MPPIC/DampingModels/DampingModel/DampingModel.H
@@ -25,7 +25,7 @@ Class
Foam::DampingModel
Description
- Templated Damping model class.
+ Base class for collisional damping models.
SourceFiles
DampingModel.C
diff --git a/src/lagrangian/intermediate/submodels/MPPIC/DampingModels/NoDamping/NoDamping.H b/src/lagrangian/intermediate/submodels/MPPIC/DampingModels/NoDamping/NoDamping.H
index ee8274b783b..34f2b9a967f 100644
--- a/src/lagrangian/intermediate/submodels/MPPIC/DampingModels/NoDamping/NoDamping.H
+++ b/src/lagrangian/intermediate/submodels/MPPIC/DampingModels/NoDamping/NoDamping.H
@@ -22,10 +22,9 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
- Foam::NoDamping
+ Foam::DampingModels::NoDamping
Description
- Templated NoDamping model class.
SourceFiles
NoDamping.C
diff --git a/src/lagrangian/intermediate/submodels/MPPIC/DampingModels/Relaxation/Relaxation.H b/src/lagrangian/intermediate/submodels/MPPIC/DampingModels/Relaxation/Relaxation.H
index f1859cd7de5..d9f6e07e578 100644
--- a/src/lagrangian/intermediate/submodels/MPPIC/DampingModels/Relaxation/Relaxation.H
+++ b/src/lagrangian/intermediate/submodels/MPPIC/DampingModels/Relaxation/Relaxation.H
@@ -22,10 +22,22 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
- Foam::Relaxation
+ Foam::DampingModels::Relaxation
Description
- Templated Relaxation model class.
+ Relaxation collisional damping model.
+
+ Particle velocities are relaxed towards the local mean over a time-scale.
+
+ Reference:
+ \verbatim
+ "An improved collision damping time for MP-PIC calculations of dense
+ particle flows with applications to polydisperse sedimenting beds and
+ colliding particle jets"
+ P O'Rourke and D Snider
+ Chemical Engineering Science
+ Volume 65, Issue 22, Pages 6014-6028, November 2010
+ \endverbatim
SourceFiles
Relaxation.C
diff --git a/src/lagrangian/intermediate/submodels/MPPIC/IsotropyModels/IsotropyModel/IsotropyModel.H b/src/lagrangian/intermediate/submodels/MPPIC/IsotropyModels/IsotropyModel/IsotropyModel.H
index ad3b500363a..08f20f1256a 100644
--- a/src/lagrangian/intermediate/submodels/MPPIC/IsotropyModels/IsotropyModel/IsotropyModel.H
+++ b/src/lagrangian/intermediate/submodels/MPPIC/IsotropyModels/IsotropyModel/IsotropyModel.H
@@ -25,7 +25,7 @@ Class
Foam::IsotropyModel
Description
- Templated Isotropy model class.
+ Base class for collisional return-to-isotropy models.
SourceFiles
IsotropyModel.C
diff --git a/src/lagrangian/intermediate/submodels/MPPIC/IsotropyModels/NoIsotropy/NoIsotropy.H b/src/lagrangian/intermediate/submodels/MPPIC/IsotropyModels/NoIsotropy/NoIsotropy.H
index 071b01d53c7..e5aafff43e3 100644
--- a/src/lagrangian/intermediate/submodels/MPPIC/IsotropyModels/NoIsotropy/NoIsotropy.H
+++ b/src/lagrangian/intermediate/submodels/MPPIC/IsotropyModels/NoIsotropy/NoIsotropy.H
@@ -22,10 +22,9 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
- Foam::NoIsotropy
+ Foam::IsotropyModels::NoIsotropy
Description
- Templated NoIsotropy model class.
SourceFiles
NoIsotropy.C
diff --git a/src/lagrangian/intermediate/submodels/MPPIC/IsotropyModels/Stochastic/Stochastic.H b/src/lagrangian/intermediate/submodels/MPPIC/IsotropyModels/Stochastic/Stochastic.H
index fb3893fa209..f1e06f64de2 100644
--- a/src/lagrangian/intermediate/submodels/MPPIC/IsotropyModels/Stochastic/Stochastic.H
+++ b/src/lagrangian/intermediate/submodels/MPPIC/IsotropyModels/Stochastic/Stochastic.H
@@ -22,10 +22,26 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
- Foam::Stochastic
+ Foam::IsotropyModels::Stochastic
Description
- Templated Stochastic model class.
+ Stochastic return-to-isotropy model.
+
+ Particle velocities are modified by sampling a gaussian-plus-delta
+ distribution, which depends on a time-scale. This randomises some particle
+ velocities whilst leaving others unchanged. The lower the value of the
+ time-scale, the greater the proportion of particle velocities affected.
+
+ A correction step is performed at the end to ensure that the model
+ conserves both momentum and granular temperature.
+
+ Reference:
+ \verbatim
+ "Inclusion of collisional return-to-isotropy in the MP-PIC method"
+ P O'Rourke and D Snider
+ Chemical Engineering Science
+ Volume 80, Issue 0, Pages 39-54, December 2012
+ \endverbatim
SourceFiles
Stochastic.C
diff --git a/src/lagrangian/intermediate/submodels/MPPIC/PackingModels/Explicit/Explicit.H b/src/lagrangian/intermediate/submodels/MPPIC/PackingModels/Explicit/Explicit.H
index b3dd1a55717..054d53eaa58 100644
--- a/src/lagrangian/intermediate/submodels/MPPIC/PackingModels/Explicit/Explicit.H
+++ b/src/lagrangian/intermediate/submodels/MPPIC/PackingModels/Explicit/Explicit.H
@@ -22,7 +22,23 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
- Foam::Explicit
+ Foam::PackingModels::Explicit
+
+Description
+ Explicit model for applying an inter-particle stress to the particles.
+
+ The inter-particle stress is calculated using current particle locations.
+ This force is then applied only to the particles that are moving towards
+ regions of close pack. The resulting velocity change is limited using an
+ abtracted correction velocity limiter.
+
+ Reference:
+ \verbatim
+ "An Incompressible Three-Dimensional Multiphase Particle-in-Cell Model
+ for Dense Particle Flows"
+ D Snider
+ Journal of Computational Physics
+ Volume 170, Issue 2, Pages 523-549, July 2001
SourceFiles
Explicit.C
diff --git a/src/lagrangian/intermediate/submodels/MPPIC/PackingModels/Implicit/Implicit.H b/src/lagrangian/intermediate/submodels/MPPIC/PackingModels/Implicit/Implicit.H
index 095fed016bb..c3064d73f24 100644
--- a/src/lagrangian/intermediate/submodels/MPPIC/PackingModels/Implicit/Implicit.H
+++ b/src/lagrangian/intermediate/submodels/MPPIC/PackingModels/Implicit/Implicit.H
@@ -22,7 +22,15 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
- Foam::Implicit
+ Foam::PackingModels::Implicit
+
+Description
+ Implicit model for applying an inter-particle stress to the particles.
+
+ The time evolution of particulate volume fraction is solved for implicitly
+ on the eulerian mesh. The computed flux is then applied to the lagrangian
+ field. The gravity force can optionally be applied to the particles as part
+ of this model, using the keyword "applyGravity".
SourceFiles
Implicit.C
diff --git a/src/lagrangian/intermediate/submodels/MPPIC/PackingModels/NoPacking/NoPacking.H b/src/lagrangian/intermediate/submodels/MPPIC/PackingModels/NoPacking/NoPacking.H
index a7aa5ce84e6..67bb37bf5d4 100644
--- a/src/lagrangian/intermediate/submodels/MPPIC/PackingModels/NoPacking/NoPacking.H
+++ b/src/lagrangian/intermediate/submodels/MPPIC/PackingModels/NoPacking/NoPacking.H
@@ -22,10 +22,9 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
- Foam::NoPacking
+ Foam::PackingModel::NoPacking
Description
- Templated NoPacking model class.
SourceFiles
NoPacking.C
diff --git a/src/lagrangian/intermediate/submodels/MPPIC/PackingModels/PackingModel/PackingModel.H b/src/lagrangian/intermediate/submodels/MPPIC/PackingModels/PackingModel/PackingModel.H
index d29af9c4498..6fcddbace16 100644
--- a/src/lagrangian/intermediate/submodels/MPPIC/PackingModels/PackingModel/PackingModel.H
+++ b/src/lagrangian/intermediate/submodels/MPPIC/PackingModels/PackingModel/PackingModel.H
@@ -25,7 +25,7 @@ Class
Foam::PackingModel
Description
- Templated Packing model class.
+ Base class for packing models.
SourceFiles
PackingModel.C
diff --git a/src/lagrangian/intermediate/submodels/MPPIC/ParticleStressModels/HarrisCrighton/HarrisCrighton.H b/src/lagrangian/intermediate/submodels/MPPIC/ParticleStressModels/HarrisCrighton/HarrisCrighton.H
index e9b6f0210c0..3eb3702340d 100644
--- a/src/lagrangian/intermediate/submodels/MPPIC/ParticleStressModels/HarrisCrighton/HarrisCrighton.H
+++ b/src/lagrangian/intermediate/submodels/MPPIC/ParticleStressModels/HarrisCrighton/HarrisCrighton.H
@@ -21,6 +21,33 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
+Class
+ Foam::ParticleStressModels::HarrisCrighton
+
+Description
+ Inter-particle stress model of Harris and Crighton
+
+ The stress value takes the following form:
+ \f[
+ \dfrac{P_s \alpha^\beta}{\max \left( \alpha_{pack} - \alpha , \epsilon
+ ( 1 - \alpha ) \right) }
+ \f]
+ Here, $\alpha$ is the volume fraction of the dispersed phase, and the other
+ values are modelling constants. A small value $\epsilon$ is used to limit
+ the denominator to ensure numerical stability.
+
+ Reference:
+ \verbatim
+ "Solitons, solitary waves, and voidage disturbances in gas-fluidized
+ beds"
+ S Harris and D Crighton,
+ Journal of Fluid Mechanics
+ Volume 266, Pages 243-276, April 2006
+ \endverbatim
+
+SourceFiles
+ HarrisCrighton.C
+
\*---------------------------------------------------------------------------*/
#ifndef HarrisCrighton_H
diff --git a/src/lagrangian/intermediate/submodels/MPPIC/ParticleStressModels/Lun/Lun.H b/src/lagrangian/intermediate/submodels/MPPIC/ParticleStressModels/Lun/Lun.H
index ace89618fb8..c00787ce78b 100644
--- a/src/lagrangian/intermediate/submodels/MPPIC/ParticleStressModels/Lun/Lun.H
+++ b/src/lagrangian/intermediate/submodels/MPPIC/ParticleStressModels/Lun/Lun.H
@@ -21,6 +21,34 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
+Class
+ Foam::ParticleStressModels::Lun
+
+Description
+ Inter-particle stress model of Lun et al
+
+ The stress value takes the following form:
+ \f[
+ \left[ \alpha \rho + \alpha^2 \rho (1 + e) \frac{3}{5}
+ \left( \frac{\alpha_{pack}}{\alpha_{pack} - \alpha}
+ \right)^\frac{1}{3} \right] \frac{1}{3} \sigma^2
+ \f]
+ Here, $\alpha$ is the volume fraction of the dispersed phase, $\rho$ is the
+ density of the dispersed phase, $e$ is a coefficient of restitution, and
+ $\sigma$ is the RMS velocityh fluctuation.
+
+ Reference:
+ \verbatim
+ "Kinetic theories for granular flow: inelastic particles in Couette
+ flow and slightly inelastic particles in a general flowfield"
+ C Lun, S Savage, G Jeffrey, N Chepurniy
+ Journal of Fluid Mechanics
+ Volume 1, Page 223, April 2006
+ \endverbatim
+
+SourceFiles
+ Lun.C
+
\*---------------------------------------------------------------------------*/
#ifndef Lun_H
diff --git a/src/lagrangian/intermediate/submodels/MPPIC/ParticleStressModels/ParticleStressModel/ParticleStressModel.H b/src/lagrangian/intermediate/submodels/MPPIC/ParticleStressModels/ParticleStressModel/ParticleStressModel.H
index bea5dade316..3338f3a94b6 100644
--- a/src/lagrangian/intermediate/submodels/MPPIC/ParticleStressModels/ParticleStressModel/ParticleStressModel.H
+++ b/src/lagrangian/intermediate/submodels/MPPIC/ParticleStressModels/ParticleStressModel/ParticleStressModel.H
@@ -21,6 +21,15 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
+Class
+ Foam::ParticleStressModel
+
+Description
+ Base class for inter-particle stress models.
+
+SourceFiles
+ exponential.C
+
\*---------------------------------------------------------------------------*/
#ifndef ParticleStressModel_H
diff --git a/src/lagrangian/intermediate/submodels/MPPIC/ParticleStressModels/exponential/exponential.H b/src/lagrangian/intermediate/submodels/MPPIC/ParticleStressModels/exponential/exponential.H
index 8eb29a0cb66..5d989622feb 100644
--- a/src/lagrangian/intermediate/submodels/MPPIC/ParticleStressModels/exponential/exponential.H
+++ b/src/lagrangian/intermediate/submodels/MPPIC/ParticleStressModels/exponential/exponential.H
@@ -21,6 +21,16 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
+Class
+ Foam::ParticleStressModels::exponential
+
+Description
+ Exponential inter-particle stress model of the same form as used in
+ twoPhaseEulerFoam
+
+SourceFiles
+ exponential.C
+
\*---------------------------------------------------------------------------*/
#ifndef exponential_H
diff --git a/src/lagrangian/intermediate/submodels/MPPIC/TimeScaleModels/TimeScaleModel/TimeScaleModel.H b/src/lagrangian/intermediate/submodels/MPPIC/TimeScaleModels/TimeScaleModel/TimeScaleModel.H
index b103d528cf6..6c7f6e938cb 100644
--- a/src/lagrangian/intermediate/submodels/MPPIC/TimeScaleModels/TimeScaleModel/TimeScaleModel.H
+++ b/src/lagrangian/intermediate/submodels/MPPIC/TimeScaleModels/TimeScaleModel/TimeScaleModel.H
@@ -21,6 +21,15 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
+Class
+ Foam::TimeScaleModel
+
+Description
+ Base class for time scale models.
+
+SourceFiles
+ TimeScaleModel.C
+
\*---------------------------------------------------------------------------*/
#ifndef TimeScaleModel_H
diff --git a/src/lagrangian/intermediate/submodels/MPPIC/TimeScaleModels/equilibrium/equilibrium.H b/src/lagrangian/intermediate/submodels/MPPIC/TimeScaleModels/equilibrium/equilibrium.H
index 0fa635f935a..a8036d2711e 100644
--- a/src/lagrangian/intermediate/submodels/MPPIC/TimeScaleModels/equilibrium/equilibrium.H
+++ b/src/lagrangian/intermediate/submodels/MPPIC/TimeScaleModels/equilibrium/equilibrium.H
@@ -21,6 +21,24 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
+Class
+ Foam::TimeScaleModels::equilibrium
+
+Description
+ Equlibrium model for the time scale over which properties of a dispersed
+ phase tend towards the mean value.
+
+ Reference:
+ \verbatim
+ "A model for collisional exchange in gas/liquid/solid fluidized beds"
+ P O'Rourke, P Zhao and D Snider
+ Chemical Engineering Science
+ Volume 64, Issue 8, Pages 1784-1797, April 2009
+ \endverbatim
+
+SourceFiles
+ equilibrium.C
+
\*---------------------------------------------------------------------------*/
#ifndef equilibrium_H
diff --git a/src/lagrangian/intermediate/submodels/MPPIC/TimeScaleModels/isotropic/isotropic.H b/src/lagrangian/intermediate/submodels/MPPIC/TimeScaleModels/isotropic/isotropic.H
index 6eb3cef0fc1..dbca765160e 100644
--- a/src/lagrangian/intermediate/submodels/MPPIC/TimeScaleModels/isotropic/isotropic.H
+++ b/src/lagrangian/intermediate/submodels/MPPIC/TimeScaleModels/isotropic/isotropic.H
@@ -21,6 +21,24 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
+Class
+ Foam::TimeScaleModels::isotropic
+
+Description
+ Model for the time scale over which the velocity field of a dispersed phase
+ tends towards an isotropic distribution.
+
+ Reference:
+ \verbatim
+ "Inclusion of collisional return-to-isotropy in the MP-PIC method"
+ P O'Rourke and D Snider
+ Chemical Engineering Science
+ Volume 80, Issue 0, Pages 39-54, December 2012
+ \endverbatim
+
+SourceFiles
+ isotropic.C
+
\*---------------------------------------------------------------------------*/
#ifndef isotropic_H
diff --git a/src/lagrangian/intermediate/submodels/MPPIC/TimeScaleModels/nonEquilibrium/nonEquilibrium.H b/src/lagrangian/intermediate/submodels/MPPIC/TimeScaleModels/nonEquilibrium/nonEquilibrium.H
index 4cb1143e844..4eeb3ac4823 100644
--- a/src/lagrangian/intermediate/submodels/MPPIC/TimeScaleModels/nonEquilibrium/nonEquilibrium.H
+++ b/src/lagrangian/intermediate/submodels/MPPIC/TimeScaleModels/nonEquilibrium/nonEquilibrium.H
@@ -21,6 +21,25 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
+Class
+ Foam::TimeScaleModels::nonEquilibrium
+
+Description
+ Non-Equlibrium model for the time scale over which properties of a
+ dispersed phase tend towards the mean value.
+
+ Reference:
+ \verbatim
+ "An improved collision damping time for MP-PIC calculations of dense
+ particle flows with applications to polydisperse sedimenting beds and
+ colliding particle jets"
+ P O'Rourke and D Snider
+ Chemical Engineering Science
+ Volume 65, Issue 22, Pages 6014-6028, November 2010
+
+SourceFiles
+ nonEquilibrium.C
+
\*---------------------------------------------------------------------------*/
#ifndef nonEquilibrium_H
--
GitLab