[DOC] fix up and add links to new documentation

This commit is contained in:
danielque
2018-10-15 10:33:19 +02:00
parent f2f3230de0
commit b5d5b56824
5 changed files with 36 additions and 12 deletions

View File

@ -94,11 +94,13 @@ Fines,
"fieldStore"_forceModel_fieldStore.html,
"fieldTimeAverage"_forceModel_fieldTimeAverage.html,
"gradPForce"_forceModel_gradPForce.html,
"gradPForceSmooth"_forceModel_gradPForceSmooth.html,
granKineticEnergy,
"interface"_forceModel_interface.html,
"noDrag"_forceModel_noDrag.html,
"particleCellVolume"_forceModel_particleCellVolume.html,
"pdCorrelation"_forceModel_pdCorrelation.html,
"surfaceTensionForce"_forceModel_surfaceTensionForce.html,
"virtualMassForce"_forceModel_virtualMassForce.html,
"viscForce"_forceModel_viscForce.html,
"volWeightedAverage"_forceModel_volWeightedAverage.html :tb(c=2,ea=c)
@ -188,7 +190,8 @@ The "smoothingModel"_smoothingModel.html keyword entry specifies the model for
smoothing the exchange fields.
"constDiffSmoothing"_smoothingModel_constDiffSmoothing.html,
"off"_smoothingModel_noSmoothing.html :tb(c=2,ea=c)
"off"_smoothingModel_noSmoothing.html,
"temporalSmoothing"_smoothingModel_temporalSmoothing.html :tb(c=2,ea=c)
6.16 Thermal conductivity models :h4

View File

@ -10,6 +10,7 @@
This section lists all CFDEMcoupling solvers alphabetically.
"cfdemSolverIB"_cfdemSolverIB.html,
"cfdemSolverMultiphase"_cfdemSolverMultiphase.html,
"cfdemSolverPiso"_cfdemSolverPiso.html,
"cfdemSolverPisoScalar"_cfdemSolverPisoScalar.html,
cfdemSolverRhoPimple,

View File

@ -59,7 +59,13 @@ gradPForceSmoothProps
\} :pre
[Description:]
The gradPForceSmooth model calculates the particle based pressure gradient force identically as the gradPForce model but allows smoothing of the pressure prior to the force calculation (without altering the original pressure field). Any smoothing model can be used and does not have to be the same as specified in couplingProperties. Properties for the smoothing model has to be specified in a sub-dictionary within gradPForceSmoothProps.
The {gradPForceSmooth} model calculates the particle based pressure gradient
force identically to the "gradPForce"_forceModel_gradPForce.html model but
allows smoothing of the pressure prior to the force calculation (without
altering the original pressure field).
Any smoothing model can be used and does not have to be the same as specified in
couplingProperties. Properties for the smoothing model have to be specified in a
sub-dictionary within {gradPForceSmoothProps}.
[Restrictions:]
@ -67,5 +73,5 @@ A volScalarField "pSmooth" MUST be specified in the initial time directory!
[Related commands:]
"forceModel"_forceModel.html
"forceModel"_forceModel.html, "gradPForce"_forceModel_gradPForce.html

View File

@ -37,17 +37,19 @@ surfaceTensionForceProps
[Description:]
The force model calculates the surface tension force acting on each DEM particle based on a pre-calculated
surface tension force as V_particle * F^sigma. When used in conjunction with the "cfdemSolverMultiphase"
solver, the surface tension force is calculated with the CSF (continuum surface force) model
(see Brackbill et al. (1992): "A continuum method for modeling surface tension", J. Comput. Phys.).
The force model calculates the surface tension force acting on each DEM particle
based on a pre-calculated surface tension force as V_particle * F^sigma. When
used in conjunction with the "cfdemSolverMultiphase"_cfdemSolverMultiphase.html
solver, the surface tension force is calculated with the CSF (continuum surface
force) model (see Brackbill et al. (1992): "A continuum method for modeling
surface tension", J. Comput. Phys.).
[Restrictions:]
Has to be used with a multiphase solver that calculates the surface tension force. Tested with the solver
"cfdemSolverMultiphase".
Has to be used with a multiphase solver that calculates the surface tension
force, e.g. {cfdemSolverMultiphase}.
[Related commands:]
"forceModel"_forceModel.html
"forceModel"_forceModel.html, "cfdemSolverMultiphase"_cfdemSolverMultiphase.html

View File

@ -38,11 +38,23 @@ temporalSmoothingProps
[Description:]
The "temporalSmoothing" model is a smoothing model that utilizes temporal relaxation of a desired quantity. This model can be used to filter out high-frequency fluctuations (e.g. numerical noise) controlled via the control parameter gamma. Note that this model does NOT smooth the calculated fields, instead smoothing is performed on a separate (smooth) field which uses the calculated (un-smooth) field as a reference. Thus its usage is limited and CANNOT be used to smooth the exchange fields similar to the other smoothing models. For further information see Vångö et al., "Unresolved CFDDEM modeling of multiphase flow in densely packed particle beds", Appl. Math. Model. (2018).
The {temporalSmoothing} model is a smoothing model that utilizes temporal
relaxation of a desired quantity. This model can be used to filter out
high-frequency fluctuations (e.g. numerical noise) controlled via the control
parameter gamma.
Note that this model does NOT smooth the calculated fields, instead smoothing is
performed on a separate (smooth) field which uses the calculated (un-smooth)
field as a reference.
Thus its usage is limited and CANNOT be used to smooth the exchange fields
similar to other smoothing models.
For further information see Vångö et al., "Unresolved CFDDEM modeling of
multiphase flow in densely packed particle beds", Appl. Math. Model. (2018).
[Restrictions:]
This model does NOT smooth the calculated fields and can therefore NOT be used as a general smoothing model to smoothen the exhchange fields. Attempting this will generate an error.
This model does NOT smooth the calculated fields and can therefore NOT be used
as a general smoothing model to smoothen the exchange fields.
Attempting this will generate an error.
[Related commands:]