Files
CFDEMcoupling-PFM/doc/forceModel_particleCellVolume.txt
2018-07-23 09:03:40 +02:00

65 lines
1.5 KiB
Plaintext

"CFDEMproject Website"_lws - "Main Page"_main :c
:link(lws,http://www.cfdem.com)
:link(main,CFDEMcoupling_Manual.html)
:line
forceModel particleCellVolume command :h3
[Syntax:]
Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties
dictionary.
forceModels
(
particleCellVolume
);
particleCellVolumeProps
\{
upperThreshold scalar1;
lowerThreshold scalar2;
startTime scalar3;
verbose;
\} :pre
{scalar1} = only cells with a field value (magnitude) lower than this upper threshold are considered :l
{scalar2} = only cells with a field value (magnitude) greater than this lower threshold are considered :l
{scalar3} = (optional, default 0) start time of volume calculation and output :l
:ule
[Examples:]
forceModels
(
particleCellVolume
);
particleCellVolumeProps
\{
upperThreshold 0.999;
lowerThreshold 0;
verbose;
\} :pre
[Description:]
This "force model" does not influence the particles or the simulation - it is a
postprocessing tool! The total volume of the particles as they are represented
on the CFD mesh is calculated. Further the total volume of the cells particles
are in is calculated.
At "writeTime" a field named particleCellVolume, where scalarField is the name
of the original field, is written. This can then be probed using standard
function object probes. Analogously a field named cellVolume is written. Using
the {verbose} option a screen output is given.
[Restrictions:]
none
[Related commands:]
"forceModel"_forceModel.html