From ee5150bb8ab991046c895ce3a3d1cf652115f03b Mon Sep 17 00:00:00 2001 From: mathiasvangoe Date: Tue, 27 Mar 2018 10:28:05 +0200 Subject: [PATCH] Added documentation for temporalSmoothing smoothing model --- doc/smoothingModel_temporalSmoothing.html | 55 +++++++++++++++++++++++ doc/smoothingModel_temporalSmoothing.txt | 48 ++++++++++++++++++++ 2 files changed, 103 insertions(+) create mode 100644 doc/smoothingModel_temporalSmoothing.html create mode 100644 doc/smoothingModel_temporalSmoothing.txt diff --git a/doc/smoothingModel_temporalSmoothing.html b/doc/smoothingModel_temporalSmoothing.html new file mode 100644 index 00000000..efa3b35b --- /dev/null +++ b/doc/smoothingModel_temporalSmoothing.html @@ -0,0 +1,55 @@ + +
CFDEMproject WWW Site - CFDEM Commands +
+ + + + +
+ +

smoothingModel_temporalSmoothing command +

+

Syntax: +

+

Defined in dictionary dependent on the application. +

+
smoothingModel temporalSmoothing;
+temporalSmoothingProps
+{
+    lowerLimit number1;
+    upperLimit number2;
+    refField referenceField;
+    smoothingStrength smoothingControlParameter;
+} 
+
+ +

Examples: +

+
temporalSmoothingProps
+{
+    lowerLimit 0.1;
+    upperLimit 1e10;
+    referenceField "p";
+    smoothingStrength 1;
+} 
+
+

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 smoothingStrength. 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 CFD–DEM 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. +

+

Related commands: +

+

smoothingModel +

+ diff --git a/doc/smoothingModel_temporalSmoothing.txt b/doc/smoothingModel_temporalSmoothing.txt new file mode 100644 index 00000000..d4e473ce --- /dev/null +++ b/doc/smoothingModel_temporalSmoothing.txt @@ -0,0 +1,48 @@ +"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c + +:link(lws,http://www.cfdem.com) +:link(lc,CFDEMcoupling_Manual.html#comm) + +:line + +smoothingModel_temporalSmoothing command :h3 + +[Syntax:] + +Defined in dictionary dependent on the application. + +smoothingModel temporalSmoothing; +temporalSmoothingProps +\{ + lowerLimit number1; + upperLimit number2; + refField referenceField; + smoothingStrength smoothingControlParameter; +\} :pre + +{number1} = scalar fields will be bound to this lower value :ulb,l +{number2} = scalar fields will be bound to this upper value :l +{referenceField} = reference to the un-smoothed field required for the relaxation operation :l +{smoothingStrength} = control parameter for the smoothing, lower value yields stronger smoothing (smoothingStrength = 1 results in an equal contribution from the un-smoothed and smoothed fields) :l +:ule + +[Examples:] + +temporalSmoothingProps +\{ + lowerLimit 0.1; + upperLimit 1e10; + referenceField "p"; + smoothingStrength 1; +\} :pre + +[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 smoothingStrength. 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 CFD–DEM 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. + +[Related commands:] + +"smoothingModel"_smoothingModel.html +