zhyang-dev/CFDEMcoupling-PFM
1
0
Fork 0
mirror of https://github.com/ParticulateFlow/CFDEMcoupling-PFM.git synced 2025-12-08 06:37:44 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

[DOC] update particleCellVolume and volWeightedAverage [ci skip]

Browse Source 
add new options
This commit is contained in:
danielque
2020-08-03 13:26:56 +02:00
parent 71586e1192
commit 3b29d96c05
2 changed files with 5 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
doc/forceModel_particleCellVolume.txt
View File

@ -22,11 +22,14 @@ particleCellVolumeProps
lowerThreshold scalar2; lowerThreshold scalar2;
startTime scalar3; startTime scalar3;
verbose; verbose;
writeToFile switch1;
\} :pre \} :pre
{scalar1} = only cells with a field value (magnitude) lower than this upper threshold are considered :l {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 {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 {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 :ule
[Examples:] [Examples:]

2
doc/forceModel_volWeightedAverage.txt
View File

@ -30,6 +30,7 @@ volWeightedAverageProps
upperThreshold scalar1; upperThreshold scalar1;
lowerThreshold scalar2; lowerThreshold scalar2;
verbose; verbose;
writeToFile switch1;
\} :pre \} :pre
{time} = (optional, default 0.) time to start the averaging :ulb,l {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 {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 {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 {verbose} = (optional, default false) keyword only (mostly used for debugging) :l
{switch1} = (optional, default false) switch for file output :l
:ule :ule
[Examples:] [Examples:]