mirror of
https://github.com/ParticulateFlow/CFDEMcoupling-PFM.git
synced 2025-12-08 06:37:44 +00:00
[DOC] update particleCellVolume and volWeightedAverage [ci skip]
add new options
This commit is contained in:
@ -22,11 +22,14 @@ particleCellVolumeProps
|
||||
lowerThreshold scalar2;
|
||||
startTime scalar3;
|
||||
verbose;
|
||||
writeToFile switch1;
|
||||
\} :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
|
||||
{verbose} = (optional, default false) keyword only (mostly used for debugging) :l
|
||||
{switch1} = (optional, default false) switch for file output :l
|
||||
:ule
|
||||
|
||||
[Examples:]
|
||||
|
||||
@ -30,6 +30,7 @@ volWeightedAverageProps
|
||||
upperThreshold scalar1;
|
||||
lowerThreshold scalar2;
|
||||
verbose;
|
||||
writeToFile switch1;
|
||||
\} :pre
|
||||
|
||||
{time} = (optional, default 0.) time to start the averaging :ulb,l
|
||||
@ -38,6 +39,7 @@ volWeightedAverageProps
|
||||
{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
|
||||
{verbose} = (optional, default false) keyword only (mostly used for debugging) :l
|
||||
{switch1} = (optional, default false) switch for file output :l
|
||||
:ule
|
||||
|
||||
[Examples:]
|
||||
|
||||
Reference in New Issue
Block a user