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 -->
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
selected and combined by dictionary settings.

4
doc/CFDEMcoupling_models.txt
View File

@ -199,12 +199,12 @@ conductivity of the fluid phase in the presence of particles.
SyamlalThermCond,
ZehnerSchluenderThermCond,
noTherm :tb(c=2,ea=c)
off :tb(c=2,ea=c)
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.
"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
its functionality and correct usage. Provided that the installation is correct,
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:]
@ -22,7 +22,7 @@ which can be reached by typing {cfdemTut} in a CLI terminal.
[Structure:]
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
case to a coupled case.

4
doc/cfdemSolverPiso.txt
View File

@ -15,7 +15,7 @@ cfdemSolverPiso command :h3
[Description:]
<!-- 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
volume based solver for turbulent Navier-Stokes equations applying the PISO
algorithm, "cfdemSolverPiso" has additional functionality for a coupling to the
@ -24,7 +24,7 @@ DEM code "LIGGGHTS".
<!-- 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
volume based solver for turbulent Navier-Stokes equations applying the PISO
algorithm, "cfdemSolverPiso" has additional functionality for a coupling to the

2
doc/chemistryModel_species.txt
View File

@ -54,7 +54,7 @@ speciesProps
The chemistry model performs the calculation of chemical reactional effects
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
fractions are transferred to DEM side.

2
doc/forceModel_LaEuScalarTemp.txt
View File

@ -72,7 +72,7 @@ pneumatic transport of granular particles, Pow.Tech 112
[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.
[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
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:]

2
doc/forceModel_fieldTimeAverage.txt
View File

@ -55,7 +55,7 @@ fieldTimeAverageProps
[Description:]
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
function object probes. The output name is timeAverage_scalarField, where
scalarField is the name of the original field.

2
doc/forceModel_particleCellVolume.txt
View File

@ -45,7 +45,7 @@ particleCellVolumeProps
[Description:]
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
are in is calculated.

2
doc/forceModel_volWeightedAverage.txt
View File

@ -63,7 +63,7 @@ volWeightedAverageProps
[Description:]
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.
At "writeTime" a field named volAverage_field, where scalarField is the name of

6
doc/forceSubModel.txt
View File

@ -5,7 +5,7 @@
:line
forceSubModel command :h3
forceSubModels command :h3
[Syntax:]
@ -46,7 +46,7 @@ semi-implicitly; default off) :ulb,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
If false, a force term is communicated 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
@ -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
{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
transport model. (off -> use transportProperties nu; default off) :l
:ule
[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
"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.
[Restrictions:]

4
doc/githubAccess_public.txt
View File

@ -7,7 +7,7 @@
:line
githubAccess_public :h3
Github access :h3
[Description:]
@ -125,7 +125,7 @@ Changes in $CFDEM_TUT_DIR will be lost after every {git stash}!
[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

2
doc/liggghtsCommandModel.txt
View File

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

2
doc/liggghtsCommandModel_runLiggghts.txt
View File

@ -32,7 +32,7 @@ liggghtsCommandModels
[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
$nrDEMsteps is automatically set according to the coupling intervals, every
coupling step.

2
doc/liggghtsCommandModel_writeLiggghts.txt
View File

@ -43,7 +43,7 @@ liggghtsCommandModels
[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
"write_restart $name" - where $name is the name of the restart file - every
write step.

2
doc/meshMotionModel_noMeshMotion.txt
View File

@ -20,7 +20,7 @@ meshMotionModel noMeshMotion; :pre
[Description:]
The {noMeshMotion} model is a dummy meshMotion model.
The {noMeshMotion} model is a dummy mesh motion model.
[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
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
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
coupling. In case {treatVoidCellsAsExplicitForce true;} is set, however, Us will
not be smoothed and implicit forces (after the smoothing has been performed) in

12
doc/voidFractionModel.txt
View File

@ -5,27 +5,27 @@
:line
voidfractionModel command :h3
voidFractionModel command :h3
[Syntax:]
Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties
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:]
voidfractionModel centre; :pre
voidFractionModel centre; :pre
NOTE: This examples list might not be complete - please look for other models
(voidfractionModel XY) in this documentation.
(voidFractionModel XY) in this documentation.
[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.
[Restrictions:]

10
doc/voidFractionModel_GaussVoidFraction.txt
View File

@ -5,14 +5,14 @@
:line
voidfractionModel Gauss command :h3
voidFractionModel Gauss command :h3
[Syntax:]
Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties
dictionary.
voidfractionModel Gauss;
voidFractionModel Gauss;
GaussProps
\{
maxCellsPerParticle number1;
@ -29,7 +29,7 @@ GaussProps
[Examples:]
voidfractionModel Gauss;
voidFractionModel Gauss;
GaussProps
\{
maxCellsPerParticle 1000;
@ -40,7 +40,7 @@ GaussProps
[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 void fraction field is set in
those cell whose centres are inside the particle. The volume is here distributed
according to a Gaussian distribution.
@ -58,6 +58,6 @@ none
[Related commands:]
"voidfractionModel"_voidFractionModel.html,
"voidFractionModel"_voidFractionModel.html,
"bigParticle"_voidFractionModel_bigParticleVoidFraction.html

10
doc/voidFractionModel_IBVoidFraction.txt
View File

@ -5,14 +5,14 @@
:line
voidfractionModel IB command :h3
voidFractionModel IB command :h3
[Syntax:]
Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties
dictionary.
voidfractionModel IB;
voidFractionModel IB;
IBProps
\{
maxCellsPerParticle number1;
@ -29,7 +29,7 @@ according to {number3} * Vparticle, volume remains unaltered! :l
[Examples:]
voidfractionModel IB;
voidFractionModel IB;
IBProps
\{
maxCellsPerParticle 1000;
@ -39,7 +39,7 @@ IBProps
[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 void fraction field is set in
those cell whose centres are inside the particle. The model is specially
designed for cfdemSolverIB and creates a smooth transition of the void fraction
@ -58,5 +58,5 @@ none
[Related commands:]
"voidfractionModel"_voidFractionModel.html
"voidFractionModel"_voidFractionModel.html

10
doc/voidFractionModel_bigParticleVoidFraction.txt
View File

@ -5,14 +5,14 @@
:line
voidfractionModel bigParticle command :h3
voidFractionModel bigParticle command :h3
[Syntax:]
Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties
dictionary.
voidfractionModel bigParticle;
voidFractionModel bigParticle;
bigParticleProps
\{
maxCellsPerParticle number1;
@ -29,7 +29,7 @@ bigParticleProps
[Examples:]
voidfractionModel bigParticle;
voidFractionModel bigParticle;
bigParticleProps
\{
maxCellsPerParticle 1000;
@ -40,7 +40,7 @@ bigParticleProps
[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 void fraction field is set in
those cell whose centres are inside the particle which results in a stairstep
representation of the bodies within the mesh (i.e. void fraction is either 1
@ -62,5 +62,5 @@ none
[Related commands:]
"voidfractionModel"_voidFractionModel.html
"voidFractionModel"_voidFractionModel.html

10
doc/voidFractionModel_centreVoidFraction.txt
View File

@ -5,14 +5,14 @@
:line
voidfractionModel centre command :h3
voidFractionModel centre command :h3
[Syntax:]
Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties
dictionary.
voidfractionModel centre;
voidFractionModel centre;
centreProps
\{
alphaMin number1;
@ -25,7 +25,7 @@ centreProps
[Examples:]
voidfractionModel centre;
voidFractionModel centre;
centreProps
\{
alphaMin 0.1;
@ -34,7 +34,7 @@ centreProps
[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.
The particle volume occupied in the CFD domain can be adjusted by the parameter
@ -46,5 +46,5 @@ none
[Related commands:]
"voidfractionModel"_voidFractionModel.html
"voidFractionModel"_voidFractionModel.html

10
doc/voidFractionModel_dividedVoidFraction.txt
View File

@ -5,14 +5,14 @@
:line
voidfractionModel divided command :h3
voidFractionModel divided command :h3
[Syntax:]
Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties
dictionary.
voidfractionModel divided;
voidFractionModel divided;
dividedProps
\{
alphaMin number1;
@ -33,7 +33,7 @@ dividedProps
[Examples:]
voidfractionModel divided;
voidFractionModel divided;
dividedProps
\{
alphaMin 0.2;
@ -41,7 +41,7 @@ dividedProps
[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
divide the particle's volume to the touched cells.
@ -93,5 +93,5 @@ none
[Related commands:]
"voidfractionModel"_voidFractionModel.html
"voidFractionModel"_voidFractionModel.html