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] fix spelling

Browse Source
This commit is contained in:
danielque
2018-07-26 13:04:30 +02:00
parent d9abd3df0b
commit cdd416ec0a
35 changed files with 92 additions and 92 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
doc/CFDEMcoupling_about.txt
View File

@ -33,7 +33,7 @@ OpenFOAM\ |reg|\ (*) to include a coupling to the DEM code
END_RST --> END_RST -->
In this toolbox the particle representation within the CFD In this toolbox the particle representation within the CFD
solver is organized by "cloud" classes. Key functionalities are organised in solver is organized by "cloud" classes. Key functionalities are organized in
sub-models (e.g. force models, data exchange models, etc.) which can easily be sub-models (e.g. force models, data exchange models, etc.) which can easily be
selected and combined by dictionary settings. selected and combined by dictionary settings.

6
doc/CFDEMcoupling_dicts.txt
View File

@ -59,12 +59,12 @@ exchanges.
A useful procedure would be: A useful procedure would be:
Set the DEM timestep in the LIGGGHTS input file according to the needs of the Set the DEM time step in the LIGGGHTS input file according to the needs of the
pure DEM problem. :olb,l pure DEM problem. :olb,l
Set the {couplingInterval}, which refers to the DEM timesteps. Depending on the Set the {couplingInterval}, which refers to the DEM time steps. Depending on the
problem you will need to have a close (small couplingInterval) or loose problem you will need to have a close (small couplingInterval) or loose
coupling. :l coupling. :l
Choose the CFD timestep in the controlDict. It must be equal to or smaller than Choose the CFD time step in the controlDict. It must be equal to or smaller than
the coupling time, otherwise you will get the error: "Error - TS bigger than the coupling time, otherwise you will get the error: "Error - TS bigger than
coupling interval!". :l,ole coupling interval!". :l,ole

4
doc/CFDEMcoupling_models.txt
View File

@ -199,12 +199,12 @@ conductivity of the fluid phase in the presence of particles.
SyamlalThermCond, SyamlalThermCond,
ZehnerSchluenderThermCond, ZehnerSchluenderThermCond,
noTherm :tb(c=2,ea=c) off :tb(c=2,ea=c)
6.17 Void fraction models :h4 6.17 Void fraction models :h4
The "voidfractionModel"_voidFractionModel.html keyword entry specifies the model The "voidFractionModel"_voidFractionModel.html keyword entry specifies the model
accounting for the volume of the particles in the CFD domain. accounting for the volume of the particles in the CFD domain.
"Gauss"_voidFractionModel_GaussVoidFraction.html, "Gauss"_voidFractionModel_GaussVoidFraction.html,

4
doc/CFDEMcoupling_tutorials.txt
View File

@ -12,7 +12,7 @@
Each solver of CFDEMcoupling comes with at least one tutorial example, showing Each solver of CFDEMcoupling comes with at least one tutorial example, showing
its functionality and correct usage. Provided that the installation is correct, its functionality and correct usage. Provided that the installation is correct,
the tutorials can be run via "Allrun.sh" shell scripts. These scripts perform the tutorials can be run via "Allrun.sh" shell scripts. These scripts perform
all necessary steps (preprocessing, run, postprocessing, visualization). all necessary steps (pre-processing, run, post-processing, visualization).
[Location:] [Location:]
@ -22,7 +22,7 @@ which can be reached by typing {cfdemTut} in a CLI terminal.
[Structure:] [Structure:]
Each case is structured in a directory called "CFD" covering the CFD relevant Each case is structured in a directory called "CFD" covering the CFD relevant
settings and data, and a dirctory called "DEM" covering the DEM relevant settings and data, and a directory called "DEM" covering the DEM relevant
settings and data. This allows to easily expand a pure CFD or DEM simulation settings and data. This allows to easily expand a pure CFD or DEM simulation
case to a coupled case. case to a coupled case.

2
doc/IOModel_sophIO.txt
View File

@ -21,7 +21,7 @@ IOModel sophIO; :pre
[Description:] [Description:]
The {sophIO} model is based on the "basicIO"_IOModel_basicIO.html model and The {sophIO} model is based on the "basicIO"_IOModel_basicIO.html model and
additionally writes voidfraction, implicit forces and explicit forces. additionally writes void fraction, implicit forces and explicit forces.
Data is written every write time of the CFD simulation. Data is written every write time of the CFD simulation.

4
doc/cfdemSolverPiso.txt
View File

@ -15,7 +15,7 @@ cfdemSolverPiso command :h3
[Description:] [Description:]
<!-- HTML_ONLY --> <!-- HTML_ONLY -->
"cfdemSolverPiso" is a coupled CFD-DEM solver using CFDEMcoupling, an open "cfdemSolverPiso" is a coupled CFD-DEM solver using CFDEMcoupling, an open-\
source parallel coupled CFD-DEM framework. Based on pisoFoam&reg;(*), a finite source parallel coupled CFD-DEM framework. Based on pisoFoam&reg;(*), a finite
volume based solver for turbulent Navier-Stokes equations applying the PISO volume based solver for turbulent Navier-Stokes equations applying the PISO
algorithm, "cfdemSolverPiso" has additional functionality for a coupling to the algorithm, "cfdemSolverPiso" has additional functionality for a coupling to the
@ -24,7 +24,7 @@ DEM code "LIGGGHTS".
<!-- RST <!-- RST
"cfdemSolverPiso" is a coupled CFD-DEM solver using CFDEMcoupling, an open "cfdemSolverPiso" is a coupled CFD-DEM solver using CFDEMcoupling, an open-\
source parallel coupled CFD-DEM framework. Based on pisoFoam\ |reg|\ (*), a finite source parallel coupled CFD-DEM framework. Based on pisoFoam\ |reg|\ (*), a finite
volume based solver for turbulent Navier-Stokes equations applying the PISO volume based solver for turbulent Navier-Stokes equations applying the PISO
algorithm, "cfdemSolverPiso" has additional functionality for a coupling to the algorithm, "cfdemSolverPiso" has additional functionality for a coupling to the

4
doc/chemistryModel_species.txt
View File

@ -31,7 +31,7 @@ speciesProps
{ChemistryFile} = path to file, where the reacting species are listed :ulb,l {ChemistryFile} = path to file, where the reacting species are listed :ulb,l
{T} = name of the finite volume temperature field, it is already added in default and doesn't need to be specified if name is the same :l {T} = name of the finite volume temperature field, it is already added in default and doesn't need to be specified if name is the same :l
{rho} = name of the finite volume density field, it is already added in default and doesn't need to be specified if name is the same :l {rho} = name of the finite volume density field, it is already added in default and doesn't need to be specified if name is the same :l
{voidfraction} = name of the finite volume voidfraction field, it is already added in default and doesn't need to be specified if name is the same :l {voidfraction} = name of the finite volume void fraction field, it is already added in default and doesn't need to be specified if name is the same :l
{molarConc} = name of the finite volume molar concentration field, it is already added in default and doesn't need to be specified if name is the same :l {molarConc} = name of the finite volume molar concentration field, it is already added in default and doesn't need to be specified if name is the same :l
{partTemp} = name of the finite volume cell averaged particle temperature field, it is already added in default and doesn't need to be specified if name is the same :l {partTemp} = name of the finite volume cell averaged particle temperature field, it is already added in default and doesn't need to be specified if name is the same :l
{partRho} = name of the finite volume cell averaged density temperature field, it is already added in default and doesn't need to be specified if name is the same :l {partRho} = name of the finite volume cell averaged density temperature field, it is already added in default and doesn't need to be specified if name is the same :l
@ -54,7 +54,7 @@ speciesProps
The chemistry model performs the calculation of chemical reactional effects The chemistry model performs the calculation of chemical reactional effects
acting on each DEM particle. The species model is the model, where the specified acting on each DEM particle. The species model is the model, where the specified
species fields (from the foam.inp folder) are intialized, and information such species fields (from the foam.inp folder) are initialized, and information such
as temperature, density, molar concentration and more importantly the molar as temperature, density, molar concentration and more importantly the molar
fractions are transferred to DEM side. fractions are transferred to DEM side.

2
doc/forceModel_ArchimedesIB.txt
View File

@ -25,7 +25,7 @@ ArchimedesIBProps
\} :pre \} :pre
{gravity} = name of the finite volume gravity field :ulb,l {gravity} = name of the finite volume gravity field :ulb,l
{voidfraction} = name of the finite volume voidfraction field :l {voidfraction} = name of the finite volume void fraction field :l
{twoDimensional} = optional keyword for conducting a two dimensional calculation :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 {switch1} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l
:ule :ule

4
doc/forceModel_BeetstraDrag.txt
View File

@ -40,7 +40,7 @@ BeetstraDragProps
\} :pre \} :pre
{U} = name of the finite volume fluid velocity field :ulb,l {U} = name of the finite volume fluid velocity field :ulb,l
{voidfraction} = name of the finite volume voidfraction field :l {voidfraction} = name of the finite volume void fraction field :l
{minVoidfraction} = minimum void fraction value to ensure meaningful interpolated void fraction (default = 0.1) :l {minVoidfraction} = minimum void fraction value to ensure meaningful interpolated void fraction (default = 0.1) :l
{Us} = name of the finite volume cell averaged particle velocity field :l {Us} = name of the finite volume cell averaged particle velocity field :l
@ -56,7 +56,7 @@ BeetstraDragProps
{kValue} = factor for parcels size effect (default = 0.05; must be defined if useParcelSizeDependentFilteredDrag is used) :l {kValue} = factor for parcels size effect (default = 0.05; must be defined if useParcelSizeDependentFilteredDrag is used) :l
{interpolation} = flag to use interpolated voidfraction and fluid velocity values (normally off) :l {interpolation} = flag to use interpolated void fraction and fluid velocity values (normally off) :l
{treatForceExplicit} = switch to force explicit treatment of force (normally off) :l {treatForceExplicit} = switch to force explicit treatment of force (normally off) :l
{implForceDEM} = flag to use implicit formulation of drag on DEM side (normally off, if on, this switch will force {treatForceExplicit} to be off) :l {implForceDEM} = flag to use implicit formulation of drag on DEM side (normally off, if on, this switch will force {treatForceExplicit} to be off) :l
{verbose} = switch to force display of data on screen (default: off; typically used for debug purposes) :l {verbose} = switch to force display of data on screen (default: off; typically used for debug purposes) :l

4
doc/forceModel_DiFeliceDrag.txt
View File

@ -31,7 +31,7 @@ DiFeliceDragProps
\} :pre \} :pre
{U} = name of the finite volume fluid velocity field :ulb,l {U} = name of the finite volume fluid velocity field :ulb,l
{voidfraction} = name of the finite volume voidfraction field :l {voidfraction} = name of the finite volume void fraction field :l
{Us} = name of the finite volume granular velocity 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. {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 scale=coarse-graining factor. d_real= particle diameter as it is measured. :l
@ -39,7 +39,7 @@ scale=coarse-graining factor. d_real= particle diameter as it is measured. :l
{switch1} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :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 {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 {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 {switch4} = (optional, default false) flag to use interpolated void fraction and velocity values :l
{switch5} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l {switch5} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l
:ule :ule

6
doc/forceModel_GidaspowDrag.txt
View File

@ -33,16 +33,16 @@ GidaspowDragProps
\} :pre \} :pre
{U} = name of the finite volume fluid velocity field :ulb,l {U} = name of the finite volume fluid velocity field :ulb,l
{voidfraction} = name of the finite volume voidfraction field :l {voidfraction} = name of the finite volume void fraction field :l
{Us} = name of the finite volume cell averaged particle velocity field :l {Us} = name of the finite volume cell averaged particle velocity field :l
{scalar1} = drag correction factor (in doubt 1) :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 {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 {scalar3} = (optional, default 1.0) scaling of drag law :l
{scalar4} = (optional, default 0.8) voidfraction above which dilute formulation will be used :l {scalar4} = (optional, default 0.8) void fraction above which dilute formulation will be used :l
{switch1} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :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 {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 {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 {switch4} = (optional, default false) flag to use interpolated void fraction and fluid velocity values :l
{switch5} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l {switch5} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l
:ule :ule

4
doc/forceModel_KochHillDrag.txt
View File

@ -30,12 +30,12 @@ KochHillDragProps
\} :pre \} :pre
{U} = name of the finite volume fluid velocity field :ulb,l {U} = name of the finite volume fluid velocity field :ulb,l
{voidfraction} = name of the finite volume voidfraction field :l {voidfraction} = name of the finite volume void fraction field :l
{Us} = (optional, default "Us") name of finite volume granular velocity field :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 {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 {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 {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 {switch4} = (optional, default false) flag to use interpolated void fraction and fluid velocity values :l
{switch5} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :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 {switch6} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l
:ule :ule

8
doc/forceModel_LaEuScalarTemp.txt
View File

@ -33,14 +33,14 @@ LaEuScalarTempProps
{U} = name of the finite volume fluid velocity field :ulb,l {U} = name of the finite volume fluid velocity field :ulb,l
{T} = name of the finite volume scalar temperature field :l {T} = name of the finite volume scalar temperature field :l
{voidfraction} = name of the finite volume voidfraction field :l {voidfraction} = name of the finite volume void fraction field :l
{Temp} = name of the DEM data representing the particles temperature :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 {convectiveHeatFlux} = name of the DEM data representing the particle-fluid convective heat flux :l
{scalar1} = fluid thermal conductivity \[W/(m*K)\] :l {scalar1} = fluid thermal conductivity \[W/(m*K)\] :l
{scalar2} = fluid specific heat capacity \[W*s/(kg*K)\] :l {scalar2} = fluid specific heat capacity \[W*s/(kg*K)\] :l
{scalar3} = (optional, default 1e30) limit maximal turbulence :l {scalar3} = (optional, default 1e30) limit maximal turbulence :l
{switch1} = (optional, default false) for verbose run :l {switch1} = (optional, default false) for verbose run :l
{switch2} = (optional, default false) flag to use interpolated voidfraction and fluid velocity values :l {switch2} = (optional, default false) flag to use interpolated void fraction and fluid velocity values :l
{switch3} = (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
:ule :ule
@ -64,7 +64,7 @@ LaEuScalarTempProps
[Description:] [Description:]
This "force model" does not influence the particles or the fluid flow! Using the This "force model" does not influence the particles or the fluid flow! Using the
particles' temperature a scalar field representing "particle-fluid heatflux" is particles' temperature a scalar field representing "particle-fluid heat flux" is
calculated. The solver then uses this source field in the scalar transport calculated. The solver then uses this source field in the scalar transport
equation for the temperature. The model for convective heat transfer is based on equation for the temperature. The model for convective heat transfer is based on
Li and Mason (2000), A computational investigation of transient heat transfer in Li and Mason (2000), A computational investigation of transient heat transfer in
@ -72,7 +72,7 @@ pneumatic transport of granular particles, Pow.Tech 112
[Restrictions:] [Restrictions:]
Goes only with cfdemSolverScalar. The force model has to be the second (!!!) Goes only with cfdemSolverPisoScalar. The force model has to be the second (!!!)
model in the forces list. model in the forces list.
[Related commands:] [Related commands:]

2
doc/forceModel_fieldStore.txt
View File

@ -54,7 +54,7 @@ fieldStoreProps
This "force model" does not influence the particles or the flow - it is a tool This "force model" does not influence the particles or the flow - it is a tool
to store a scalar/vector field! This is especially useful if you use a boundary to store a scalar/vector field! This is especially useful if you use a boundary
condition which cannot interpreted correctly in your postporcessor (e.g. paraview). condition which cannot interpreted correctly in your post-processor (e.g. paraview).
[Restrictions:] [Restrictions:]

2
doc/forceModel_fieldTimeAverage.txt
View File

@ -55,7 +55,7 @@ fieldTimeAverageProps
[Description:] [Description:]
This "force model" does not influence the particles or the simulation - it is a This "force model" does not influence the particles or the simulation - it is a
postprocessing tool! Starting at start time the specified fields are temporally post-processing tool! Starting at start time the specified fields are temporally
averaged and written at "writeTime". They can then be probed using standard averaged and written at "writeTime". They can then be probed using standard
function object probes. The output name is timeAverage_scalarField, where function object probes. The output name is timeAverage_scalarField, where
scalarField is the name of the original field. scalarField is the name of the original field.

2
doc/forceModel_particleCellVolume.txt
View File

@ -45,7 +45,7 @@ particleCellVolumeProps
[Description:] [Description:]
This "force model" does not influence the particles or the simulation - it is a This "force model" does not influence the particles or the simulation - it is a
postprocessing tool! The total volume of the particles as they are represented post-processing tool! The total volume of the particles as they are represented
on the CFD mesh is calculated. Further the total volume of the cells particles on the CFD mesh is calculated. Further the total volume of the cells particles
are in is calculated. are in is calculated.

2
doc/forceModel_volWeightedAverage.txt
View File

@ -63,7 +63,7 @@ volWeightedAverageProps
[Description:] [Description:]
This "forceModel" does not influence the particles or the simulation - it is a This "forceModel" does not influence the particles or the simulation - it is a
postprocessing tool! Starting at start time the volume weighted averages of post-processing tool! Starting at start time the volume weighted averages of
those cells of the fields within the threshold are calculated. those cells of the fields within the threshold are calculated.
At "writeTime" a field named volAverage_field, where scalarField is the name of At "writeTime" a field named volAverage_field, where scalarField is the name of

6
doc/forceSubModel.txt
View File

@ -5,7 +5,7 @@
:line :line
forceSubModel command :h3 forceSubModels command :h3
[Syntax:] [Syntax:]
@ -46,7 +46,7 @@ semi-implicitly; default off) :ulb,l
{implForceDEM} - If true, the fluid velocity and drag coefficient are communicated {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 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. 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 If false, a force term is communicated to the DEM calculation at each coupling
time step, the term is constant for one coupling interval. time step, the term is constant for one coupling interval.
(on -> DEM forces are updated every DEM step; default off) :l (on -> DEM forces are updated every DEM step; default off) :l
{verbose} - switch for debug output to screen (on -> enable debug output; default {verbose} - switch for debug output to screen (on -> enable debug output; default
@ -64,7 +64,7 @@ switch, drag force values of each DEM time step are accumulated and passed on to
the CFD-calculation. (default off) :l the CFD-calculation. (default off) :l
{scalarViscosity} - switch for the usage of a user-defined viscosity nu for the {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 calculation of the drag force; The CFD calculation always uses the value of the
transport model. (off -> use tranportProperties nu; default off) :l transport model. (off -> use transportProperties nu; default off) :l
:ule :ule
[Restrictions:] [Restrictions:]

2
doc/forceSubModel_ImEx.txt
View File

@ -41,7 +41,7 @@ treatForceExplicit true; // optional for some force models. :pre
If no force sub-model is applied {ImEx} is used as default. If the keyword If no force sub-model is applied {ImEx} is used as default. If the keyword
"forceSubModels" is provided, a choice of sub model is demanded. Depending on "forceSubModels" is provided, a choice of sub model is demanded. Depending on
the force model different keywords are read and can therefrore be set the force model different keywords are read and can therefore be set
(see the log file). If the keyword is provided, its value is used. (see the log file). If the keyword is provided, its value is used.
[Restrictions:] [Restrictions:]

4
doc/githubAccess_public.txt
View File

@ -7,7 +7,7 @@
:line :line
githubAccess_public :h3 Github access :h3
[Description:] [Description:]
@ -125,7 +125,7 @@ Changes in $CFDEM_TUT_DIR will be lost after every {git stash}!
[Additional Installations:] [Additional Installations:]
Optionally you can install lpp which will help you convert the DEM (dump) data to VTK format. For standard CFD-DEM runs this will not be necessary. To get the DEM postprocessing tool "lpp" you need python-numpy package installed: Optionally you can install lpp which will help you convert the DEM (dump) data to VTK format. For standard CFD-DEM runs this will not be necessary. To get the DEM post-processing tool "lpp" you need python-numpy package installed:
sudo apt-get install python-numpy :pre sudo apt-get install python-numpy :pre

2
doc/liggghtsCommandModel.txt
View File

@ -5,7 +5,7 @@
:line :line
liggghtsCommandModel command :h3 liggghtsCommandModels command :h3
[Syntax:] [Syntax:]

2
doc/liggghtsCommandModel_execute.txt
View File

@ -77,7 +77,7 @@ executeProps1
[Description:] [Description:]
The {execute} liggghtsCommand Model can be used to execute a LIGGGHTS command The {execute} liggghtsCommandModel can be used to execute a LIGGGHTS command
during a CFD run. In above example {execute_0} for instance executes during a CFD run. In above example {execute_0} for instance executes
"run $couplingInterval" every coupling step. {$couplingInterval} is automatically "run $couplingInterval" every coupling step. {$couplingInterval} is automatically
replaced by the correct number of DEM steps. Additionally, {execute_1} executes replaced by the correct number of DEM steps. Additionally, {execute_1} executes

2
doc/liggghtsCommandModel_runLiggghts.txt
View File

@ -32,7 +32,7 @@ liggghtsCommandModels
[Description:] [Description:]
The liggghtsCommand models can be used to execute a LIGGGHTS command during a The LIGGGHTS command models can be used to execute a LIGGGHTS command during a
CFD run. The {runLiggghts} command executes the command "run $nrDEMsteps", where CFD run. The {runLiggghts} command executes the command "run $nrDEMsteps", where
$nrDEMsteps is automatically set according to the coupling intervals, every $nrDEMsteps is automatically set according to the coupling intervals, every
coupling step. coupling step.

2
doc/liggghtsCommandModel_writeLiggghts.txt
View File

@ -43,7 +43,7 @@ liggghtsCommandModels
[Description:] [Description:]
The liggghtsCommand models can be used to execute a LIGGGHTS command during a The LIGGGHTS command models can be used to execute a LIGGGHTS command during a
CFD write. The {writeLiggghts} command executes the command CFD write. The {writeLiggghts} command executes the command
"write_restart $name" - where $name is the name of the restart file - every "write_restart $name" - where $name is the name of the restart file - every
write step. write step.

2
doc/meshMotionModel_noMeshMotion.txt
View File

@ -20,7 +20,7 @@ meshMotionModel noMeshMotion; :pre
[Description:] [Description:]
The {noMeshMotion} model is a dummy meshMotion model. The {noMeshMotion} model is a dummy mesh motion model.
[Restrictions:] [Restrictions:]

2
doc/momCoupleModel.txt
View File

@ -50,7 +50,7 @@ in an explicit fashion.
Note that the switch {treatVoidCellsAsExplicitForce true;} can be set in the Note that the switch {treatVoidCellsAsExplicitForce true;} can be set in the
couplingProperties in order to change the treatment of cells which are void of couplingProperties in order to change the treatment of cells which are void of
particles. This is only relevant if (i) smoothing is used, and (ii) implicit particles. This is only relevant if (i) smoothing is used, and (ii) implicit
force coupling is performed. By default, the particle veloctiy field (Us) will force coupling is performed. By default, the particle velocity field (Us) will
be smoothed to obtain a meaningful reference quantity for the implicit force be smoothed to obtain a meaningful reference quantity for the implicit force
coupling. In case {treatVoidCellsAsExplicitForce true;} is set, however, Us will coupling. In case {treatVoidCellsAsExplicitForce true;} is set, however, Us will
not be smoothed and implicit forces (after the smoothing has been performed) in not be smoothed and implicit forces (after the smoothing has been performed) in

2
doc/momCoupleModel_implicitCouple.txt
View File

@ -27,7 +27,7 @@ implicitCoupleProps
{U} = name of the finite volume fluid velocity field :ulb,l {U} = name of the finite volume fluid velocity field :ulb,l
{Us} = name of the finite volume granular velocity field :l {Us} = name of the finite volume granular velocity field :l
{voidfraction} = name of the finite volume voidfraction field :l {voidfraction} = name of the finite volume void fraction field :l
{scalar1} = (optional, default 1e10) limit implicit momentum exchange field :l {scalar1} = (optional, default 1e10) limit implicit momentum exchange field :l
{scalar2} = (optional, default SMALL) minimum value for local particle volume fraction to calculate the exchange field :l {scalar2} = (optional, default SMALL) minimum value for local particle volume fraction to calculate the exchange field :l
:ule :ule

2
doc/smoothingModel.txt
View File

@ -33,7 +33,7 @@ an error.
[Description:] [Description:]
The {smoothingModel} is the base class for models that smoothen the exchange The {smoothingModel} is the base class for models that smoothen the exchange
fields (i.e., voidfraction and the Ksl field in case of implicit force coupling). fields (i.e., void fraction and the Ksl field in case of implicit force coupling).
This is relevant in case one uses a small grid resolution compared to the local This is relevant in case one uses a small grid resolution compared to the local
particle diameter (or parcel diameter in case one uses a parcel approach). particle diameter (or parcel diameter in case one uses a parcel approach).

2
doc/smoothingModel_constDiffSmoothing.txt
View File

@ -43,7 +43,7 @@ constDiffSmoothingProps
The {constDiffSmoothing} model is a basic smoothingModel model which reads a The {constDiffSmoothing} model is a basic smoothingModel model which reads a
smoothing length scale being used for smoothing the exchange fields smoothing length scale being used for smoothing the exchange fields
(voidfraction, Ksl, f if present). This model can be used for smoothing explicit (void fraction, Ksl, f if present). This model can be used for smoothing explicit
force coupling fields, as well as implicit force coupling algorithms. force coupling fields, as well as implicit force coupling algorithms.
Smoothing for reference fields is performed to "fill in" values in cells in Smoothing for reference fields is performed to "fill in" values in cells in
which these reference fields are not specified. Values calculated in the cells which these reference fields are not specified. Values calculated in the cells

12
doc/voidFractionModel.txt
View File

@ -5,27 +5,27 @@
:line :line
voidfractionModel command :h3 voidFractionModel command :h3
[Syntax:] [Syntax:]
Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties
dictionary. dictionary.
voidfractionModel model; :pre voidFractionModel model; :pre
model = name of the voidfractionModel to be applied :ul model = name of the voidFractionModel to be applied :ul
[Examples:] [Examples:]
voidfractionModel centre; :pre voidFractionModel centre; :pre
NOTE: This examples list might not be complete - please look for other models NOTE: This examples list might not be complete - please look for other models
(voidfractionModel XY) in this documentation. (voidFractionModel XY) in this documentation.
[Description:] [Description:]
The {voidfractionModel} is the base class for models to represent the DEM The {voidFractionModel} is the base class for models to represent the DEM
particle's volume in the CFD domain via a void fraction field. particle's volume in the CFD domain via a void fraction field.
[Restrictions:] [Restrictions:]

16
doc/voidFractionModel_GaussVoidFraction.txt
View File

@ -5,14 +5,14 @@
:line :line
voidfractionModel Gauss command :h3 voidFractionModel Gauss command :h3
[Syntax:] [Syntax:]
Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties
dictionary. dictionary.
voidfractionModel Gauss; voidFractionModel Gauss;
GaussProps GaussProps
\{ \{
maxCellsPerParticle number1; maxCellsPerParticle number1;
@ -22,14 +22,14 @@ GaussProps
\} :pre \} :pre
{number1} = maximum number of cells covered by a particle (search will fail when more than {number1} cells are covered by the particle) :ulb,l {number1} = maximum number of cells covered by a particle (search will fail when more than {number1} cells are covered by the particle) :ulb,l
{number2} = minimum limit for voidfraction :l {number2} = minimum limit for void fraction :l
{number3} = (optional, default 1.0) scaling of the particle volume to account for porosity or agglomerations. :l {number3} = (optional, default 1.0) scaling of the particle volume to account for porosity or agglomerations. :l
{number4} = (optional, default 1.0) diameter of the particle's representation is artificially increased according to {number2} * Vparticle, volume remains unaltered! :l {number4} = (optional, default 1.0) diameter of the particle's representation is artificially increased according to {number2} * Vparticle, volume remains unaltered! :l
:ule :ule
[Examples:] [Examples:]
voidfractionModel Gauss; voidFractionModel Gauss;
GaussProps GaussProps
\{ \{
maxCellsPerParticle 1000; maxCellsPerParticle 1000;
@ -40,14 +40,14 @@ GaussProps
[Description:] [Description:]
The {Gauss} voidFraction model is supposed to be used when a particle (or its The {Gauss} void fraction model is supposed to be used when a particle (or its
representation) is bigger than a CFD cell. The voidfraction field is set in representation) is bigger than a CFD cell. The void fraction field is set in
those cell whose centres are inside the particle. The volume is here distributed those cell whose centres are inside the particle. The volume is here distributed
according to a Gaussian distribution. according to a Gaussian distribution.
The region of influence of a particle can be increased artificially by The region of influence of a particle can be increased artificially by
"porosity", which blows up the particles, but keeps their volume (for "porosity", which blows up the particles, but keeps their volume (for
voidfraction calculation) constant. void fraction calculation) constant.
The particle volume occupied in the CFD domain can be adjusted by the parameter The particle volume occupied in the CFD domain can be adjusted by the parameter
"weight", using Vparticle=dsphere^3*pi/6*weight. "weight", using Vparticle=dsphere^3*pi/6*weight.
@ -58,6 +58,6 @@ none
[Related commands:] [Related commands:]
"voidfractionModel"_voidFractionModel.html, "voidFractionModel"_voidFractionModel.html,
"bigParticle"_voidFractionModel_bigParticleVoidFraction.html "bigParticle"_voidFractionModel_bigParticleVoidFraction.html

20
doc/voidFractionModel_IBVoidFraction.txt
View File

@ -5,14 +5,14 @@
:line :line
voidfractionModel IB command :h3 voidFractionModel IB command :h3
[Syntax:] [Syntax:]
Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties
dictionary. dictionary.
voidfractionModel IB; voidFractionModel IB;
IBProps IBProps
\{ \{
maxCellsPerParticle number1; maxCellsPerParticle number1;
@ -22,14 +22,14 @@ IBProps
{number1} = maximum number of cells covered by a particle (search will fail when {number1} = maximum number of cells covered by a particle (search will fail when
more than {number1} cells are covered by the particle) :ulb,l more than {number1} cells are covered by the particle) :ulb,l
{number2} = minimum limit for voidfraction :l {number2} = minimum limit for void fraction :l
{number3} = diameter of the particle's representation is artificially increased {number3} = diameter of the particle's representation is artificially increased
according to {number3} * Vparticle, volume remains unaltered! :l according to {number3} * Vparticle, volume remains unaltered! :l
:ule :ule
[Examples:] [Examples:]
voidfractionModel IB; voidFractionModel IB;
IBProps IBProps
\{ \{
maxCellsPerParticle 1000; maxCellsPerParticle 1000;
@ -39,16 +39,16 @@ IBProps
[Description:] [Description:]
The {IB} voidFraction model is supposed to be used when a particle (or its The {IB} void fraction model is supposed to be used when a particle (or its
representation) is bigger than a CFD cell. The voidfraction field is set in representation) is bigger than a CFD cell. The void fraction field is set in
those cell whose centres are inside the particle. The model is specially those cell whose centres are inside the particle. The model is specially
designed for cfdemSolverIB and creates a smooth transition of the voidfraction designed for cfdemSolverIB and creates a smooth transition of the void fraction
at the particle surface. Cells which are only partially covered by solid are at the particle surface. Cells which are only partially covered by solid are
marked by voidfraction values between 0 and 1 respectively. marked by void fraction values between 0 and 1 respectively.
The region of influence of a particle can be increased artificially by The region of influence of a particle can be increased artificially by
"scaleUpVol", which blows up the particles, but keeps their volume (for "scaleUpVol", which blows up the particles, but keeps their volume (for
voidfraction calculation) constant. void fraction calculation) constant.
Code of this sub-model was contributed by Alice Hager, JKU. Code of this sub-model was contributed by Alice Hager, JKU.
@ -58,5 +58,5 @@ none
[Related commands:] [Related commands:]
"voidfractionModel"_voidFractionModel.html "voidFractionModel"_voidFractionModel.html

18
doc/voidFractionModel_bigParticleVoidFraction.txt
View File

@ -5,14 +5,14 @@
:line :line
voidfractionModel bigParticle command :h3 voidFractionModel bigParticle command :h3
[Syntax:] [Syntax:]
Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties
dictionary. dictionary.
voidfractionModel bigParticle; voidFractionModel bigParticle;
bigParticleProps bigParticleProps
\{ \{
maxCellsPerParticle number1; maxCellsPerParticle number1;
@ -22,14 +22,14 @@ bigParticleProps
\} :pre \} :pre
{number1} = maximum number of cells covered by a particle (search will fail when more than {number1} cells are covered by the particle) :ulb,l {number1} = maximum number of cells covered by a particle (search will fail when more than {number1} cells are covered by the particle) :ulb,l
{number2} = minimum limit for voidfraction :l {number2} = minimum limit for void fraction :l
{number3} = (optional, default 1.0) scaling of the particle volume to account for porosity or agglomerations. :l {number3} = (optional, default 1.0) scaling of the particle volume to account for porosity or agglomerations. :l
{number4} = (optional, default 1.0) diameter of the particle's representation is artificially increased according to {number2} * Vparticle, volume remains unaltered! :l {number4} = (optional, default 1.0) diameter of the particle's representation is artificially increased according to {number2} * Vparticle, volume remains unaltered! :l
:ule :ule
[Examples:] [Examples:]
voidfractionModel bigParticle; voidFractionModel bigParticle;
bigParticleProps bigParticleProps
\{ \{
maxCellsPerParticle 1000; maxCellsPerParticle 1000;
@ -40,16 +40,16 @@ bigParticleProps
[Description:] [Description:]
The {bigParticle} voidFraction model is supposed to be used when a particle (or The {bigParticle} void fraction model is supposed to be used when a particle (or
its representation) is bigger than a CFD cell. The voidfraction field is set in its representation) is bigger than a CFD cell. The void fraction field is set in
those cell whose centres are inside the particle which results in a stairstep those cell whose centres are inside the particle which results in a stairstep
representation of the bodies within the mesh (i.e. voidfraction is either 1 representation of the bodies within the mesh (i.e. void fraction is either 1
(fluid) of zero (solid)). For archiving accurate results, approx. 8 cells per (fluid) of zero (solid)). For archiving accurate results, approx. 8 cells per
particle diameter are necessary. particle diameter are necessary.
The region of influence of a particle can be increased artificially by The region of influence of a particle can be increased artificially by
"porosity", which blows up the particles, but keeps their volume (for "porosity", which blows up the particles, but keeps their volume (for
voidfraction calculation) constant. void fraction calculation) constant.
The particle volume occupied in the CFD domain can be adjusted by the parameter The particle volume occupied in the CFD domain can be adjusted by the parameter
"weight", using Vparticle=dsphere^3*pi/6*weight. "weight", using Vparticle=dsphere^3*pi/6*weight.
@ -62,5 +62,5 @@ none
[Related commands:] [Related commands:]
"voidfractionModel"_voidFractionModel.html "voidFractionModel"_voidFractionModel.html

12
doc/voidFractionModel_centreVoidFraction.txt
View File

@ -5,27 +5,27 @@
:line :line
voidfractionModel centre command :h3 voidFractionModel centre command :h3
[Syntax:] [Syntax:]
Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties
dictionary. dictionary.
voidfractionModel centre; voidFractionModel centre;
centreProps centreProps
\{ \{
alphaMin number1; alphaMin number1;
weight number2; weight number2;
\} :pre \} :pre
{number1} = minimum limit for voidfraction :ulb,l {number1} = minimum limit for void fraction :ulb,l
{number2} = (optional) scaling of the particle volume to account for porosity or agglomerations. :l {number2} = (optional) scaling of the particle volume to account for porosity or agglomerations. :l
:ule :ule
[Examples:] [Examples:]
voidfractionModel centre; voidFractionModel centre;
centreProps centreProps
\{ \{
alphaMin 0.1; alphaMin 0.1;
@ -34,7 +34,7 @@ centreProps
[Description:] [Description:]
The {centre} voidFraction model calculates the voidfraction in a CFD cell The {centre} void fraction model calculates the void fraction in a CFD cell
accounting for the volume of the particles whose centres are inside the cell. accounting for the volume of the particles whose centres are inside the cell.
The particle volume occupied in the CFD domain can be adjusted by the parameter The particle volume occupied in the CFD domain can be adjusted by the parameter
@ -46,5 +46,5 @@ none
[Related commands:] [Related commands:]
"voidfractionModel"_voidFractionModel.html "voidFractionModel"_voidFractionModel.html

14
doc/voidFractionModel_dividedVoidFraction.txt
View File

@ -5,14 +5,14 @@
:line :line
voidfractionModel divided command :h3 voidFractionModel divided command :h3
[Syntax:] [Syntax:]
Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties
dictionary. dictionary.
voidfractionModel divided; voidFractionModel divided;
dividedProps dividedProps
\{ \{
alphaMin number1; alphaMin number1;
@ -23,8 +23,8 @@ dividedProps
verbose; verbose;
\} :pre \} :pre
{number1} = minimum limit for voidfraction :ulb,l {number1} = minimum limit for void fraction :ulb,l
{interpolation} = flag to interpolate voidfraction to particle positions (normally off) :l {interpolation} = flag to interpolate void fraction to particle positions (normally off) :l
{number2} = (optional) scaling of the particle volume to account for porosity or agglomerations. :l {number2} = (optional) scaling of the particle volume to account for porosity or agglomerations. :l
{number3} = (optional) diameter of the particle's representation is artificially increased according to {number2} * Vparticle, volume remains unaltered! :l {number3} = (optional) diameter of the particle's representation is artificially increased according to {number2} * Vparticle, volume remains unaltered! :l
{switch1} = (optional, default false) allow for correction at processor boundaries. This requires the use of engineIB and vice versa. :l {switch1} = (optional, default false) allow for correction at processor boundaries. This requires the use of engineIB and vice versa. :l
@ -33,7 +33,7 @@ dividedProps
[Examples:] [Examples:]
voidfractionModel divided; voidFractionModel divided;
dividedProps dividedProps
\{ \{
alphaMin 0.2; alphaMin 0.2;
@ -41,7 +41,7 @@ dividedProps
[Description:] [Description:]
The {divided} voidFraction model is supposed to be used when a particle (or its The {divided} void fraction model is supposed to be used when a particle (or its
representation) is in the size range of a CFD cell. Satellite points are used to representation) is in the size range of a CFD cell. Satellite points are used to
divide the particle's volume to the touched cells. divide the particle's volume to the touched cells.
@ -93,5 +93,5 @@ none
[Related commands:] [Related commands:]
"voidfractionModel"_voidFractionModel.html "voidFractionModel"_voidFractionModel.html