From 3b29d96c055e116276c2c49e41be5f7bb10fb56c Mon Sep 17 00:00:00 2001 From: danielque Date: Mon, 3 Aug 2020 13:26:56 +0200 Subject: [PATCH] [DOC] update particleCellVolume and volWeightedAverage [ci skip] add new options --- doc/forceModel_particleCellVolume.txt | 3 +++ doc/forceModel_volWeightedAverage.txt | 2 ++ 2 files changed, 5 insertions(+) diff --git a/doc/forceModel_particleCellVolume.txt b/doc/forceModel_particleCellVolume.txt index 08162efb..e8065699 100644 --- a/doc/forceModel_particleCellVolume.txt +++ b/doc/forceModel_particleCellVolume.txt @@ -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:] diff --git a/doc/forceModel_volWeightedAverage.txt b/doc/forceModel_volWeightedAverage.txt index a5773317..0570bc64 100644 --- a/doc/forceModel_volWeightedAverage.txt +++ b/doc/forceModel_volWeightedAverage.txt @@ -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:]