diff --git a/doc/forceModel_Archimedes.txt b/doc/forceModel_Archimedes.txt index f45b886e..48b95e44 100644 --- a/doc/forceModel_Archimedes.txt +++ b/doc/forceModel_Archimedes.txt @@ -18,10 +18,14 @@ forceModels ); ArchimedesProps \{ - gravityFieldName "gravity"; + gravityFieldName "gravity"; + treatForceExplicit switch1; + treatForceDEM switch2; \} :pre {gravity} = name of the finite volume gravity field :ulb,l +{switch1} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l +{switch2} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l :ule [Examples:] diff --git a/doc/forceModel_ArchimedesIB.txt b/doc/forceModel_ArchimedesIB.txt index 77a965aa..56fac4b2 100644 --- a/doc/forceModel_ArchimedesIB.txt +++ b/doc/forceModel_ArchimedesIB.txt @@ -18,12 +18,16 @@ forceModels ); ArchimedesIBProps \{ - gravityFieldName "gravity"; - voidfractionFieldName "voidfraction"; + gravityFieldName "gravity"; + voidfractionFieldName "voidfraction"; + twoDimensional; + treatForceExplicit switch1; \} :pre {gravity} = name of the finite volume gravity field :ulb,l {voidfraction} = name of the finite volume voidfraction field :l +{twoDimensional} = optional keyword for conducting a two dimensional calculation :l +{switch1} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l :ule [Examples:] @@ -34,8 +38,8 @@ forceModels ); ArchimedesIBProps \{ - gravityFieldName "g"; - voidfractionFieldName "voidfractionNext"; + gravityFieldName "g"; + voidfractionFieldName "voidfractionNext"; \} :pre [Description:] diff --git a/doc/forceModel_DiFeliceDrag.txt b/doc/forceModel_DiFeliceDrag.txt index 49198afc..5ebdc882 100644 --- a/doc/forceModel_DiFeliceDrag.txt +++ b/doc/forceModel_DiFeliceDrag.txt @@ -18,12 +18,29 @@ forceModels ); DiFeliceDragProps \{ - velFieldName "U"; - interpolation switch1; + velFieldName "U"; + voidfractionFieldName "voidfraction"; + granVelFieldName "Us"; + scale scalar1; + scaleDrag scalar2; + treatForceExplicit switch1; + implForceDEM switch2; + verbose switch3; + interpolation switch4; + scalarViscosity switch5; \} :pre {U} = name of the finite volume fluid velocity field :ulb,l -{switch1} = flag to use interpolated voidfraction and velocity values (normally off) :l +{voidfraction} = name of the finite volume voidfraction field :l +{Us} = name of the finite volume granular velocity field :l +{scalar1} = (optional) scaling of particle diameter: d_sim=scale*d_real. d_sim=(potentially coarse-grained) particle diameter. +scale=coarse-graining factor. d_real= particle diameter as it is measured. :l +{scalar2} = (optional) scaling factor which directly scales the drag force. :l +{switch1} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l +{switch2} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l +{switch3} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l +{switch4} = (optional, default false) flag to use interpolated voidfraction and velocity values :l +{switch5} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l :ule [Examples:] diff --git a/doc/forceModel_GidaspowDrag.txt b/doc/forceModel_GidaspowDrag.txt index 0e6ae07c..c0901f43 100644 --- a/doc/forceModel_GidaspowDrag.txt +++ b/doc/forceModel_GidaspowDrag.txt @@ -21,17 +21,29 @@ GidaspowDragProps velFieldName "U"; voidfractionFieldName "voidfraction"; granVelFieldName "Us"; - phi scalar; - interpolation switch1; + phi scalar1; + scale scalar2; + scaleDrag scalar3; + switchingVoidfraction scalar4; + treatForceExplicit switch1; implForceDEM switch2; + verbose switch3; + interpolation switch4; + scalarViscosity switch5; \} :pre {U} = name of the finite volume fluid velocity field :ulb,l {voidfraction} = name of the finite volume voidfraction field :l {Us} = name of the finite volume cell averaged particle velocity field :l -{phi} = drag correction factor (in doubt 1) :l -{switch1} = (optional, normally off) flag to use interpolated voidfraction and fluid velocity values :l -{switch2} = (optional, normally off) flag to use implicit formulation of drag on DEM side :l +{scalar1} = drag correction factor (in doubt 1) :l +{scalar2} = (optional, default 1.0) scaling of particle diameter: d_sim=scale*d_real. d_sim=(potentially coarse-grained) particle diameter. scale=coarse-graining factor. d_real= particle diameter as it is measured. :l +{scalar3} = (optional, default 1.0) scaling of drag law :l +{scalar4} = (optional, default 0.8) voidfraction above which dilute formulation will be used :l +{switch1} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l +{switch2} = (optional, default false) flag to use implicit formulation of drag on DEM side :l +{switch3} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l +{switch4} = (optional, default false) flag to use interpolated voidfraction and fluid velocity values :l +{switch5} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l :ule [Examples:] diff --git a/doc/forceModel_KochHillDrag.txt b/doc/forceModel_KochHillDrag.txt index 674bcc2d..391a1827 100644 --- a/doc/forceModel_KochHillDrag.txt +++ b/doc/forceModel_KochHillDrag.txt @@ -18,16 +18,26 @@ forceModels ); KochHillDragProps \{ - velFieldName "U"; - voidfractionFieldName "voidfraction"; - interpolation switch1; - implForceDEM switch2; + velFieldName "U"; + voidfractionFieldName "voidfraction"; + granVelFieldName "Us" + treatForceExplicit switch1; + implForceDEM switch2; + verbose switch3; + interpolation switch4; + implForceDEMaccumulated switch5; + scalarViscosity switch6; \} :pre {U} = name of the finite volume fluid velocity field :ulb,l {voidfraction} = name of the finite volume voidfraction field :l -{switch1} = (optional, normally off) flag to use interpolated voidfraction and fluid velocity values :l -{switch2} = (optional, normally off) flag to use implicit formulation of drag on DEM side :l +{Us} = (optional, default "Us") name of finite volume granular velocity field :l +{switch1} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l +{switch2} = (optional, default false) flag to use implicit formulation of drag on DEM side :l +{switch3} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l +{switch4} = (optional, default false) flag to use interpolated voidfraction and fluid velocity values :l +{switch5} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l +{switch6} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l :ule [Examples:] diff --git a/doc/forceModel_LaEuScalarTemp.txt b/doc/forceModel_LaEuScalarTemp.txt index 2fe0f77e..501ca069 100644 --- a/doc/forceModel_LaEuScalarTemp.txt +++ b/doc/forceModel_LaEuScalarTemp.txt @@ -23,10 +23,12 @@ LaEuScalarTempProps voidfractionFieldName "voidfraction"; partTempName "Temp"; partHeatFluxName "convectiveHeatFlux"; - lambda value; - Cp value1; - interpolation "switch1"; - verbose "switch2"; + lambda scalar1; + Cp scalar2; + maxSource scalar3; + verbose switch1; + interpolation switch2; + scalarViscosity switch3; \} :pre {U} = name of the finite volume fluid velocity field :ulb,l @@ -34,10 +36,12 @@ LaEuScalarTempProps {voidfraction} = name of the finite volume voidfraction field :l {Temp} = name of the DEM data representing the particles temperature :l {convectiveHeatFlux} = name of the DEM data representing the particle-fluid convective heat flux :l -{value} = fluid thermal conductivity \[W/(m*K)\] :l -{value1} = fluid specific heat capacity \[W*s/(kg*K)\] :l -{switch1} = (optional, normally off) flag to use interpolated voidfraction and fluid velocity values :l -{switch2} = (normally off) for verbose run :l +{scalar1} = fluid thermal conductivity \[W/(m*K)\] :l +{scalar2} = fluid specific heat capacity \[W*s/(kg*K)\] :l +{scalar3} = (optional, default 1e30) limit maximal turbulence :l +{switch1} = (optional, default false) for verbose run :l +{switch2} = (optional, default false) flag to use interpolated voidfraction and fluid velocity values :l +{switch3} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l :ule [Examples:] diff --git a/doc/forceModel_MeiLift.txt b/doc/forceModel_MeiLift.txt index 4e7e9c52..de006c5b 100644 --- a/doc/forceModel_MeiLift.txt +++ b/doc/forceModel_MeiLift.txt @@ -20,14 +20,18 @@ MeiLiftProps \{ velFieldName "U"; useSecondOrderTerms; - interpolation switch1; + treatForceExplicit switch1; verbose switch2; + interpolation switch3; + scalarViscosity switch4; \} :pre {U} = name of the finite volume fluid velocity field :ulb,l -{useSecondOrderTerms} = switch to activate second order terms in the lift force model :l -{switch1} = switch to activate tri-linear interpolation of the flow quantities at the particle position :l -{switch2} = switch to activate the report of per-particle quantities to the screen :l +{useSecondOrderTerms} = (optional, default false) switch to activate second order terms in the lift force model :l +{switch1} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l +{switch2} = (optional, default false) switch to activate the report of per-particle quantities to the screen :l +{switch3} = (optional, default false) switch to activate tri-linear interpolation of the flow quantities at the particle position :l +{switch4} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l :ule [Examples:] diff --git a/doc/forceModel_SchillerNaumannDrag.txt b/doc/forceModel_SchillerNaumannDrag.txt index 75f41fcf..7c243739 100644 --- a/doc/forceModel_SchillerNaumannDrag.txt +++ b/doc/forceModel_SchillerNaumannDrag.txt @@ -19,9 +19,11 @@ forceModels SchillerNaumannDragProps \{ velFieldName "U"; + treatForceExplicit switch1; \} :pre {U} = name of the finite volume fluid velocity field :ulb,l +{switch1} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l :ule [Examples:] diff --git a/doc/forceModel_ShirgaonkarIB.txt b/doc/forceModel_ShirgaonkarIB.txt index 68da647d..313b18c3 100644 --- a/doc/forceModel_ShirgaonkarIB.txt +++ b/doc/forceModel_ShirgaonkarIB.txt @@ -18,12 +18,16 @@ forceModels ); ShirgaonkarIBProps \{ - velFieldName "U"; + velFieldName "U"; pressureFieldName "pressure"; + twoDimensional; + treatForceExplicit switch1; \} :pre {U} = name of the finite volume fluid velocity field :ulb,l {pressure} = name of the finite volume pressure field :l +{twoDimensional} = optional keyword for conducting a two dimensional calculation :l +{switch1} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l :ule [Examples:] diff --git a/doc/forceModel_gradPForce.txt b/doc/forceModel_gradPForce.txt index a2fd162e..c9db690d 100644 --- a/doc/forceModel_gradPForce.txt +++ b/doc/forceModel_gradPForce.txt @@ -18,14 +18,20 @@ forceModels ); gradPForceProps \{ - pFieldName "pressure"; - velocityFieldName "U"; - interpolation switch1; + pFieldName "pressure"; + velocityFieldName "U"; + useAddedMass scalar1; + treatForceExplicit switch1; + treatForceDEM switch2; + interpolation switch3; \} :pre {pressure} = name of the finite volume fluid pressure field :ulb,l {U} = name of the finite volume fluid velocity field :l -{switch1} = flag to use interpolated pressure values (normally off) :l +{scalar1} = (optional, default 0) coefficient of added mass accounted for :l +{switch1} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l +{switch2} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l +{switch3} = (optional, default false) flag to use interpolated pressure values :l :ule [Examples:] diff --git a/doc/forceModel_interface.txt b/doc/forceModel_interface.txt index 0e435413..45e07755 100644 --- a/doc/forceModel_interface.txt +++ b/doc/forceModel_interface.txt @@ -19,15 +19,25 @@ forceModels interfaceProps \{ VOFvoidfractionFieldName "alpha"; - alphaThreshold value1; - sigma value2; - theta value3; + gradAlphaName "gradAlpha"; + alphaThreshold scalar1; + sigma scalar2; + theta scalar3; + deltaAlphaIn scalar4; + deltaAlphaOut scalar5; + C scalar6; + treatForceExplicit switch1; \} :pre {alpha} = name of the finite volume fluid volume fraction field in a VOF simulation :ulb,l -{value1} = parameter used to define the distance of influence of the model :l -{value2} = fluid gas surface tension :l -{value3} = Three-phase contact angle for interface force :l +{gradAlpha} = name of gradient fluid volume fraction field :l +{scalar1} = parameter used to define the distance of influence of the model :l +{scalar2} = fluid gas surface tension :l +{scalar3} = Three-phase contact angle for interface force :l +{scalar4} = delta value subtracted from alphaThreshold :l +{scalar5} = delta value added to alphaThreshold :l +{scalar6} = (optional, default 1.0) factor to scale interfacial force :l +{switch1} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l :ule [Examples:] @@ -39,9 +49,12 @@ forceModels interfaceProps \{ VOFvoidfractionFieldName "alpha"; - alphaThreshold 0.54; + gradAlphaName "gradAlpha"; + alphaThreshold 0.55; sigma 0.07; theta 1.12; + deltaAlphaIn 0.05; + deltaAlphaOut 0.05; \} :pre [Description:] diff --git a/doc/forceModel_noDrag.txt b/doc/forceModel_noDrag.txt index e122ef27..9e5d995b 100644 --- a/doc/forceModel_noDrag.txt +++ b/doc/forceModel_noDrag.txt @@ -18,10 +18,15 @@ forceModels ); :pre noDragProps (optional) \{ - noDEMForce; (optional) - keepCFDForce; (optional) + noDEMForce; + keepCFDForce; + treatForceExplicit switch1; \} :pre +{noDEMForce} = (optional, default false) do not apply the previously calculated forces in DEM integration :ulb,l +{keepCFDForce} = (optional, default false) do not delete the previously calculated forces and use them in CFD source terms :l +{switch1} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l +:ule [Examples:] diff --git a/doc/forceModel_particleCellVolume.txt b/doc/forceModel_particleCellVolume.txt index ed5e396e..bd0270b2 100644 --- a/doc/forceModel_particleCellVolume.txt +++ b/doc/forceModel_particleCellVolume.txt @@ -18,13 +18,15 @@ forceModels ); particleCellVolumeProps \{ - upperThreshold value; - lowerThreshold value2; + upperThreshold scalar1; + lowerThreshold scalar2; + startTime scalar3; verbose; \} :pre -{value} = only cells with a field value (magnitude) lower than this upper threshold are considered :l -{value2} = only cells with a field value (magnitude) greater than this lower 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 +{scalar3} = (optional, default 0) start time of volume calculation and output :l :ule [Examples:] diff --git a/doc/forceModel_virtualMassForce.txt b/doc/forceModel_virtualMassForce.txt index d0556c7e..537818a3 100644 --- a/doc/forceModel_virtualMassForce.txt +++ b/doc/forceModel_virtualMassForce.txt @@ -19,9 +19,19 @@ forceModels virtualMassForceProps \{ velFieldName "U"; + phiFieldName "phi"; + splitUrelCalculation switch1; + Cadd scalar1; + treatForceExplicit switch2; + interpolation switch3; \} :pre {U} = name of the finite volume fluid velocity field :ulb,l +{phi} = name of the finite volume flux field :l +{switch1} = (optional, default false) indicator to split calculation of Urel between CFDEM and LIGGGHTS :l +{scalar1} = (optional, default 0.5) virtual mass coefficient :l +{switch2} = (optional, default true) sub model switch, see "forceSubModel"_forceSubModel.html for details :l +{switch3} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l :ule [Examples:] @@ -33,6 +43,7 @@ forceModels virtualMassForceProps \{ velFieldName "U"; + phiFieldName "phi"; \} :pre [Description:] diff --git a/doc/forceModel_viscForce.txt b/doc/forceModel_viscForce.txt index 04d7ba49..08baea2f 100644 --- a/doc/forceModel_viscForce.txt +++ b/doc/forceModel_viscForce.txt @@ -18,12 +18,20 @@ forceModels ); viscForceProps \{ - velocityFieldName "U"; - interpolation switch; + velocityFieldName "U"; + useAddedMass scalar1; + treatForceExplicit switch1; + treatForceDEM switch2; + interpolation switch3; + scalarViscosity switch4; \} :pre {U} = name of the finite volume fluid velocity field :ulb,l -{switch} = flag to use interpolated stress values (normally off) :l +{scalar1} = (optional, default 0) coefficient of added mass accounted for :l +{switch1} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l +{switch2} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l +{switch3} = (optional, default false) flag to use interpolated stress values :l +{switch4} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l :ule [Examples:] diff --git a/doc/forceModel_volWeightedAverage.txt b/doc/forceModel_volWeightedAverage.txt index 6013dc8e..81f98256 100644 --- a/doc/forceModel_volWeightedAverage.txt +++ b/doc/forceModel_volWeightedAverage.txt @@ -29,10 +29,7 @@ volWeightedAverageProps ); upperThreshold scalar1; lowerThreshold scalar2; - useVolumeFraction switch0; - volumeFractionName word1; verbose; - writeToFile switch1; \} :pre {time} = (optional, default 0.) time to start the averaging :ulb,l @@ -40,10 +37,7 @@ volWeightedAverageProps {vectorField} = names of the finite volume vector fields to be temporally averaged :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 -{switch0} = (optional, default false) consider a volume fraction for the calculation :l -{word1} = (optional, default "voidfraction") name of the volume fraction, only used if useVolumeFraction is true :l {verbose} = (optional, default false) keyword only (mostly used for debugging) :l -{switch1} = (optional, default false) switch for the output. :l :ule [Examples:] diff --git a/doc/forceSubModel.txt b/doc/forceSubModel.txt index b4b0f824..d350e09a 100644 --- a/doc/forceSubModel.txt +++ b/doc/forceSubModel.txt @@ -35,7 +35,37 @@ NOTE: This examples list might not be complete - please look for other models [Description:] The force sub model is designed to hold the settings a force model can have. -For now it handles the treatExplicit, treatDEM and implDEM option. +Depending on the availability within the respective force model, the following +options are handled: + +{treatForceExplicit} - switch for the purely explicit consideration of the force +term in the equation of motion on the CFD side (off -> the force is considered +semi-implicitly; default off) :ulb,l +{treatForceDEM} - switch for the consideration of the forces on the DEM side only +(off -> calculate forces for DEM and CFD; default off) :l +{implForceDEM} - If true, the fluid velocity and drag coefficient are communicated +to the DEM calculation at each coupling time step and the drag force is +calculated at each DEM time step, using the current particle velocity. +If false, a force term is communiated to the DEM calculation at each coupling +time step, the term is constant for one coupling interval. +(on -> DEM forces are updated every DEM step; default off) :l +{verbose} - switch for debug output to screen (on -> enable debug output; default +off) :l +{interpolation} - switch for the usage of interpolation models when getting data +for the Lagrangian calculation from Eulerian fields; +f false, the cell centre values are used. (default off) :l +{useFilteredDragModel} - switch for using a coarse-grid version of the Beetstra +drag model (takes grid-size effects into account; default = off) :l +{useParcelSizeDependentFilteredDrag} - switch for using a coarse-grid version of +the Beetstra drag model (takes parcel-size effects into account, will force the +switch useFilteredDragModel to "on"; default = off) :l +{implForceDEMaccumulated} - Can only be used in combination with implForceDEM +switch, drag force values of each DEM time step are accumulated and passed on to +the CFD-calculation. (default off) :l +{scalarViscosity} - switch for the usage of a user-defined viscosity nu for the +calculation of the drag force; The CFD calculation always uses the value of the +transport model. (off -> use tranportProperties nu; default off) :l +:ule [Restrictions:] diff --git a/doc/forceSubModel_ImEx.txt b/doc/forceSubModel_ImEx.txt index 68ccc9d0..36cbbb45 100644 --- a/doc/forceSubModel_ImEx.txt +++ b/doc/forceSubModel_ImEx.txt @@ -17,9 +17,17 @@ forceSubModels ImEx; ); :pre -treatExplicit true; // optional for some force models. -treatDEM true; // optional for some force models. -implDEM true; // optional for some force models. :pre +Optional for some force models: + +treatForceExplicit true; +treatForceDEM true; +implForceDEM true; +verbose true; +interpolation true; +useFilteredDragModel true; +useParcelSizeDependentFilteredDrag true; +implForceDEMaccumulated true; +scalarViscosity true; :pre [Examples:] @@ -27,7 +35,7 @@ forceSubModels ( ImEx; ); -treatExplicit true; // optional for some force models. :pre +treatForceExplicit true; // optional for some force models. :pre [Description:]