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 up typos and formatting of model syntax/example

Browse Source
This commit is contained in:
danielque
2018-07-18 14:17:27 +02:00
parent 26d30e122d
commit b56390e3de
44 changed files with 187 additions and 189 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
doc/IOModel.txt
View File

@ -12,13 +12,13 @@ IOModel command :h3
Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties
dictionary.
IOModel "model"; :pre
IOModel model; :pre
model = name of IO-model to be applied :ul
[Examples:]
IOModel "off";
IOModel off; :pre
Note: This examples list might not be complete - please look for other models (IOModel_XY) in this documentation.

5
doc/IOModel_basicIO.txt
View File

@ -12,11 +12,12 @@ IOModel basicIO command :h3
Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties
dictionary.
IOModel "basicIO"; :pre
IOModel basicIO; :pre
[Examples:]
IOModel "basicIO"; :pre
IOModel basicIO;
serialOutput; :pre
[Description:]

4
doc/IOModel_noIO.txt
View File

@ -12,11 +12,11 @@ IOModel off command :h3
Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties
dictionary.
IOModel "off"; :pre
IOModel off; :pre
[Examples:]
IOModel "off"; :pre
IOModel off; :pre
[Description:]

4
doc/IOModel_sophIO.txt
View File

@ -12,11 +12,11 @@ IOModel sophIO command :h3
Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties
dictionary.
IOModel "sophIO"; :pre
IOModel sophIO; :pre
[Examples:]
IOModel "sophIO"; :pre
IOModel sophIO; :pre
[Description:]

4
doc/IOModel_trackIO.txt
View File

@ -12,11 +12,11 @@ IOModel trackIO command :h3
Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties
dictionary.
IOModel "trackIO"; :pre
IOModel trackIO; :pre
[Examples:]
IOModel "trackIO"; :pre
IOModel trackIO; :pre
[Description:]

20
doc/chemistryModel_diffusionCoefficients.txt
View File

@ -18,10 +18,10 @@ chemistryModels
);
diffusionCoefficientsProps
\{
verbose switch1;
ChemistryFile "$casePath/CFD/constant/foam.inp";
diffusantGasNames ( speciesNames );
\}; :pre
verbose switch1;
ChemistryFile "$casePath/CFD/constant/foam.inp";
diffusantGasNames ( speciesNames );
\} :pre
{switch1} = (optional, normally off) flag to give information :l
{ChemistryFile} = path to file, where the reacting species are listed :ulb,l
@ -34,13 +34,13 @@ chemistryModels
(
diffusionCoefficients
);
speciesProps
diffusionCoefficientsProps
\{
verbose false;
ChemistryFile "$casePath/CFD/constant/foam.inp";
diffusantGasNames ( CO
H2
);
verbose false;
ChemistryFile "$casePath/CFD/constant/foam.inp";
diffusantGasNames ( CO
H2
);
\} :pre
[Description:]

8
doc/chemistryModel_massTransferCoeff.txt
View File

@ -16,10 +16,10 @@ chemistryModels
(
massTransferCoeff
);
diffusionCoefficientsProps
massTransferCoeffProps
\{
verbose switch1;
\}; :pre
verbose switch1;
\} :pre
{switch1} = (optional, normally off) flag to give information :l
:ule
@ -32,7 +32,7 @@ chemistryModels
);
massTransferCoeffProps
\{
verbose false;
verbose false;
\} :pre
[Description:]

22
doc/chemistryModel_species.txt
View File

@ -18,15 +18,15 @@ chemistryModels
);
speciesProps
\{
ChemistryFile "$casePath/CFD/constant/foam.inp";
verbose switch1;
tempFieldName "T";
densityFieldName "rho"
voidfractionFieldName "voidfraction"
totalMoleFieldName "molarConc"
partTempName "partTemp"
partRhoName "partRho"
\}; :pre
ChemistryFile "$casePath/CFD/constant/foam.inp";
tempFieldName "T";
densityFieldName "rho";
voidfractionFieldName "voidfraction";
totalMoleFieldName "molarConc";
partTempName "partTemp";
partRhoName "partRho";
verbose switch1;
\} :pre
{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
@ -46,8 +46,8 @@ chemistryModels
);
speciesProps
\{
ChemistryFile "$casePath/CFD/constant/foam.inp";
verbose false;
ChemistryFile "$casePath/CFD/constant/foam.inp";
verbose false;
\} :pre
[Description:]

18
doc/dataExchangeModel_oneWayVTK.txt
View File

@ -15,11 +15,11 @@ dictionary.
dataExchangeModel oneWayVTK;
oneWayVTKProps
\{
DEMts timeStep;
relativePath "path";
couplingFilename "filename";
maxNumberOfParticles number;
\}; :pre
DEMts timeStep;
relativePath "path";
couplingFilename "filename";
maxNumberOfParticles number;
\} :pre
{timeStep} = time step size of stored DEM data :ulb,l
{path} = path to the VTK data files relative do simulation directory :l
@ -32,10 +32,10 @@ oneWayVTKProps
dataExchangeModel oneWayVTK;
oneWayVTKProps
\{
DEMts 0.0001;
relativePath "../DEM/post";
couplingFilename "vtk_out%4.4d.vtk";
maxNumberOfParticles 30000;
DEMts 0.0001;
relativePath "../DEM/post";
couplingFilename "vtk_out%4.4d.vtk";
maxNumberOfParticles 30000;
\} :pre
[Description:]

10
doc/dataExchangeModel_twoWayFiles.txt
View File

@ -15,9 +15,9 @@ dictionary.
dataExchangeModel twoWayFiles;
twoWayFilesProps
\{
couplingFilename "filename";
maxNumberOfParticles number;
\}; :pre
couplingFilename "filename";
maxNumberOfParticles number;
\} :pre
{filename} = filename of the VTK file series :ulb,l
{number} = maximum number of particles in DEM simulation :l
@ -28,8 +28,8 @@ twoWayFilesProps
dataExchangeModel twoWayFiles;
twoWayFilesProps
\{
couplingFilename "vtk_out%4.4d.vtk";
maxNumberOfParticles 30000;
couplingFilename "vtk_out%4.4d.vtk";
maxNumberOfParticles 30000;
\} :pre
[Description:]

2
doc/dataExchangeModel_twoWayMPI.txt
View File

@ -16,7 +16,7 @@ dataExchangeModel twoWayMPI;
twoWayMPIProps
\{
liggghtsPath "path";
\}; :pre
\} :pre
{path} = path to the DEM simulation input file :ulb,l
:ule

2
doc/dataExchangeModel_twoWayMany2Many.txt
View File

@ -16,7 +16,7 @@ dataExchangeModel twoWayMany2Many;
twoWayMany2ManyProps
\{
liggghtsPath "path";
\}; :pre
\} :pre
{path} = path to the DEM simulation input file :ulb,l
:ule

2
doc/forceModel_Archimedes.txt
View File

@ -19,7 +19,7 @@ forceModels
ArchimedesProps
\{
gravityFieldName "gravity";
\}; :pre
\} :pre
{gravity} = name of the finite volume gravity field :ulb,l
:ule

10
doc/forceModel_ArchimedesIB.txt
View File

@ -18,9 +18,9 @@ forceModels
);
ArchimedesIBProps
\{
gravityFieldName "gravity";
voidfractionFieldName "voidfraction";
\}; :pre
gravityFieldName "gravity";
voidfractionFieldName "voidfraction";
\} :pre
{gravity} = name of the finite volume gravity field :ulb,l
{voidfraction} = name of the finite volume voidfraction field :l
@ -34,8 +34,8 @@ forceModels
);
ArchimedesIBProps
\{
gravityFieldName "g";
voidfractionFieldName "voidfractionNext";
gravityFieldName "g";
voidfractionFieldName "voidfractionNext";
\} :pre
[Description:]

6
doc/forceModel_DiFeliceDrag.txt
View File

@ -18,9 +18,9 @@ forceModels
);
DiFeliceDragProps
\{
velFieldName "U";
velFieldName "U";
interpolation switch1;
\}; :pre
\} :pre
{U} = name of the finite volume fluid velocity field :ulb,l
{switch1} = flag to use interpolated voidfraction and velocity values (normally off) :l
@ -34,7 +34,7 @@ forceModels
);
DiFeliceDragProps
\{
velFieldName "U";
velFieldName "U";
interpolation true;
\} :pre

16
doc/forceModel_GidaspowDrag.txt
View File

@ -18,13 +18,13 @@ forceModels
);
GidaspowDragProps
\{
velFieldName "U";
velFieldName "U";
voidfractionFieldName "voidfraction";
granVelFieldName "Us";
phi "scalar";
interpolation switch1;
implForceDEM switch2;
\}; :pre
granVelFieldName "Us";
phi scalar;
interpolation switch1;
implForceDEM switch2;
\} :pre
{U} = name of the finite volume fluid velocity field :ulb,l
{voidfraction} = name of the finite volume voidfraction field :l
@ -42,9 +42,9 @@ forceModels
);
GidaspowDragProps
\{
velFieldName "U";
velFieldName "U";
voidfractionFieldName "voidfraction";
granVelFieldName "Us";
granVelFieldName "Us";
\} :pre
[Description:]

12
doc/forceModel_KochHillDrag.txt
View File

@ -18,16 +18,16 @@ forceModels
);
KochHillDragProps
\{
velFieldName "U";
velFieldName "U";
voidfractionFieldName "voidfraction";
interpolation "bool1";
implForceDEM "bool2";
\}; :pre
interpolation switch1;
implForceDEM switch2;
\} :pre
{U} = name of the finite volume fluid velocity field :ulb,l
{voidfraction} = name of the finite volume voidfraction field :l
{bool1} = (optional, normally off) flag to use interpolated voidfraction and fluid velocity values :l
{bool2} = (optional, normally off) flag to use implicit formulation of drag on DEM side: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
:ule
[Examples:]

30
doc/forceModel_LaEuScalarTemp.txt
View File

@ -18,16 +18,16 @@ forceModels
);
LaEuScalarTempProps
\{
velFieldName "U";
tempFieldName "T";
velFieldName "U";
tempFieldName "T";
voidfractionFieldName "voidfraction";
partTempName "Temp";
partHeatFluxName "convectiveHeatFlux";
lambda value;
Cp value1;
interpolation "switch1";
verbose "switch2";
\}; :pre
partTempName "Temp";
partHeatFluxName "convectiveHeatFlux";
lambda value;
Cp value1;
interpolation "switch1";
verbose "switch2";
\} :pre
{U} = name of the finite volume fluid velocity field :ulb,l
{T} = name of the finite volume scalar temperature field :l
@ -48,13 +48,13 @@ forceModels
);
LaEuScalarTempProps
\{
velFieldName "U";
tempFieldName "T";
velFieldName "U";
tempFieldName "T";
voidfractionFieldName "voidfraction";
partTempName "Temp";
partHeatFluxName "convectiveHeatFlux";
lambda 0.0256;
Cp 1007;
partTempName "Temp";
partHeatFluxName "convectiveHeatFlux";
lambda 0.0256;
Cp 1007;
\} :pre
[Description:]

14
doc/forceModel_MeiLift.txt
View File

@ -18,11 +18,11 @@ forceModels
);
MeiLiftProps
\{
velFieldName "U";
velFieldName "U";
useSecondOrderTerms;
interpolation "switch1";
verbose "switch2";
\}; :pre
interpolation switch1;
verbose switch2;
\} :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
@ -38,10 +38,10 @@ forceModels
);
MeiLiftProps
\{
velFieldName "U";
velFieldName "U";
useSecondOrderTerms;
interpolation true;
verbose true;
interpolation true;
verbose true;
\} :pre
[Description:]

2
doc/forceModel_SchillerNaumannDrag.txt
View File

@ -19,7 +19,7 @@ forceModels
SchillerNaumannDragProps
\{
velFieldName "U";
\}; :pre
\} :pre
{U} = name of the finite volume fluid velocity field :ulb,l
:ule

2
doc/forceModel_ShirgaonkarIB.txt
View File

@ -20,7 +20,7 @@ ShirgaonkarIBProps
\{
velFieldName "U";
pressureFieldName "pressure";
\}; :pre
\} :pre
{U} = name of the finite volume fluid velocity field :ulb,l
{pressure} = name of the finite volume pressure field :l

6
doc/forceModel_dSauter.txt
View File

@ -22,10 +22,10 @@ dSauterProps
(
X Y Z
);
\}; :pre
{coarseGrainingFactors} = list of coarse graining factors by type, separated by whitespace, optional :ulb,l
\} :pre
{coarseGrainingFactors} = list of coarse graining factors by type, separated by
whitespace, optional :ulb,l
:ule
[Description:]

2
doc/forceModel_fieldStore.txt
View File

@ -26,7 +26,7 @@ fieldStoreProps
(
"vectorField"
);
\}; :pre
\} :pre
{scalarField} = names of the finite volume scalar fields to be stored :ulb,l
{vectorField} = names of the finite volume vector fields to be stored :l

10
doc/forceModel_gradPForce.txt
View File

@ -18,10 +18,10 @@ forceModels
);
gradPForceProps
\{
pFieldName "pressure";
pFieldName "pressure";
velocityFieldName "U";
interpolation switch1;
\}; :pre
interpolation switch1;
\} :pre
{pressure} = name of the finite volume fluid pressure field :ulb,l
{U} = name of the finite volume fluid velocity field :l
@ -36,9 +36,9 @@ forceModels
);
gradPForceProps
\{
pFieldName "p";
pFieldName "p";
velocityFieldName "U";
interpolation true;
interpolation true;
\} :pre
[Description:]

16
doc/forceModel_noDrag.txt
View File

@ -16,18 +16,24 @@ forceModels
(
noDrag
); :pre
noDragProps (optional)
\{
noDEMForce; (optional)
keepCFDForce; (optional)
\} :pre
[Examples:]
forceModels
(
noDrag
); :pre
noDragProps (optional)
)
noDragProps
\{
noDEMForce; (optional)
\}; :pre
noDEMForce;
\} :pre
[Description:]

2
doc/forceModel_particleCellVolume.txt
View File

@ -21,7 +21,7 @@ particleCellVolumeProps
upperThreshold value;
lowerThreshold value2;
verbose;
\}; :pre
\} :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

2
doc/forceModel_pdCorrelation.txt
View File

@ -27,7 +27,7 @@ pdCorrelationProps
A B C
);
runOnWriteOnly true;
\}; :pre
\} :pre
{coarseGrainingFactors} = list of coarse graining factors by type, separated by whitespace, optional :ulb,l
{particleDensities} = list of particle densities by type, separated by whitespace, optional :l

2
doc/forceModel_virtualMassForce.txt
View File

@ -19,7 +19,7 @@ forceModels
virtualMassForceProps
\{
velFieldName "U";
\}; :pre
\} :pre
{U} = name of the finite volume fluid velocity field :ulb,l
:ule

4
doc/forceModel_viscForce.txt
View File

@ -19,8 +19,8 @@ forceModels
viscForceProps
\{
velocityFieldName "U";
interpolation "switch";
\}; :pre
interpolation switch;
\} :pre
{U} = name of the finite volume fluid velocity field :ulb,l
{switch} = flag to use interpolated stress values (normally off) :l

6
doc/forceSubModel_ImEx.txt
View File

@ -15,11 +15,11 @@ sub-dictionary of the force model in use.
forceSubModels
(
ImEx;
);
); :pre
treatExplicit true; // optional for some force models.
treatDEM true; // optional for some force models.
implDEM true; // optional for some force models.
implDEM true; // optional for some force models. :pre
[Examples:]
@ -27,7 +27,7 @@ forceSubModels
(
ImEx;
);
treatExplicit true; // optional for some force models.
treatExplicit true; // optional for some force models. :pre
[Description:]

5
doc/forceSubModel_ImExCorr.txt
View File

@ -16,11 +16,10 @@ forceSubModels
(
ImExCorr;
);
treatExplicit true; // optional for some force models.
treatDEM true; // optional for some force models.
implDEM true; // optional for some force models.
explicitInterpCorr true; // optional for some force models.
explicitInterpCorr true; // optional for some force models. :pre
[Examples:]
@ -28,7 +27,7 @@ forceSubModels
(
ImExCorr;
);
treatExplicit true; // optional for some force models.
treatExplicit true; // optional for some force models. :pre
[Description:]

16
doc/liggghtsCommandModel_execute.txt
View File

@ -23,10 +23,10 @@ executeProps0
run
$couplingInterval
);
runFirst switch1;
runLast switch2;
runFirst switch1;
runLast switch2;
runEveryCouplingStep switch3;
runEveryWriteStep switch4;
runEveryWriteStep switch4;
verbose;
\} :pre
@ -52,8 +52,8 @@ executeProps0
run
$couplingInterval
);
runFirst off;
runLast off;
runFirst off;
runLast off;
runEveryCouplingStep on;
\}
executeProps1
@ -69,10 +69,10 @@ executeProps1
liggghts.restart_
timeStamp
);
runFirst off;
runLast off;
runFirst off;
runLast off;
runEveryCouplingStep off;
runEveryWriteStep on;
runEveryWriteStep on;
\} :pre
[Description:]

1
doc/liggghtsCommandModel_readLiggghtsData.txt
View File

@ -27,7 +27,6 @@ readLiggghtsDataProps0
liggghtsCommandModels
(
readLiggghtsData
readLiggghtsData
);
readLiggghtsDataProps0
\{

4
doc/locateModel_engineSearchIB.txt
View File

@ -19,7 +19,7 @@ engineIBProps
\{
treeSearch switch1;
\}
zSplit value1;
zSplit value1;
xySplit value2;
\} :pre
@ -37,7 +37,7 @@ engineIBProps
\{
treeSearch false;
\}
zSplit 8;
zSplit 8;
xySplit 16;
\} :pre

10
doc/momCoupleModel_implicitCouple.txt
View File

@ -18,10 +18,10 @@ momCoupleModels
);
implicitCoupleProps
\{
velFieldName "U";
granVelFieldName "Us";
velFieldName "U";
granVelFieldName "Us";
voidfractionFieldName "voidfraction";
minAlphaP number;
minAlphaP number;
\} :pre
{U} = name of the finite volume fluid velocity field :ulb,l
@ -38,8 +38,8 @@ momCoupleModels
);
implicitCoupleProps
\{
velFieldName "U";
granVelFieldName "Us";
velFieldName "U";
granVelFieldName "Us";
voidfractionFieldName "voidfraction";
\} :pre

18
doc/probeModel.txt
View File

@ -9,21 +9,19 @@ probeModel command :h3
[Syntax:]
To be activated via couplingProperties dictionary.
Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties
dictionary.
probeModel myProbeModel; :pre
Use probe model "off" to disable this feature.
myProbeModelProps :pre
\{ :pre
\}; :pre
probeModel model;
modelProps
\{
\} :pre
model = name of the probeModel to be applied :ul
[Examples:]
See "particleProbe"_probeModel_particleProbe.html
probeModel off; :pre
Note: This examples list might not be complete - please check below for the list of force models that can perform particle probing.

7
doc/probeModel_noProbe.txt
View File

@ -12,12 +12,7 @@ probeModel off command :h3
Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties
dictionary.
forceModels
\{
myForceModel1
myForceModel2
myForceModel3
\}; :pre
probeModel off; :pre
[Examples:]

4
doc/smoothingModel.txt
View File

@ -18,8 +18,8 @@ model = name of the smoothingModel to be applied :ul
[Examples:]
smoothingModel off; :pre
smoothingModel constDiffSmoothing; :pre
smoothingModel off;
smoothingModel constDiffSmoothing; :pre
Note: This examples list might not be complete - please look for other models (smoothingModel_XY) in this documentation.

12
doc/smoothingModel_constDiffSmoothing.txt
View File

@ -15,9 +15,9 @@ dictionary.
smoothingModel constDiffSmoothing;
constDiffSmoothingProps
\{
lowerLimit number1;
upperLimit number2;
smoothingLength lengthScale;
lowerLimit number1;
upperLimit number2;
smoothingLength lengthScale;
smoothingLengthReferenceField lengthScaleRefField;
\} :pre
@ -31,9 +31,9 @@ constDiffSmoothingProps
constDiffSmoothingProps
\{
lowerLimit 0.1;
upperLimit 1e10;
smoothingLength 1500e-6;
lowerLimit 0.1;
upperLimit 1e10;
smoothingLength 1500e-6;
smoothingLengthReferenceField 9000e-6;
\} :pre

12
doc/voidFractionModel_GaussVoidFraction.txt
View File

@ -16,9 +16,9 @@ voidfractionModel Gauss;
GaussProps
\{
maxCellsPerParticle number1;
alphaMin number2;
weight number3;
porosity number4;
alphaMin number2;
weight number3;
porosity number4;
\} :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
@ -33,9 +33,9 @@ voidfractionModel Gauss;
GaussProps
\{
maxCellsPerParticle 1000;
alphaMin 0.10;
weight 1.;
porosity 1.;
alphaMin 0.10;
weight 1.0;
porosity 1.0;
\} :pre
[Description:]

8
doc/voidFractionModel_IBVoidFraction.txt
View File

@ -16,8 +16,8 @@ voidfractionModel IB;
IBProps
\{
maxCellsPerParticle number1;
alphaMin number2;
scaleUpVol number3;
alphaMin number2;
scaleUpVol number3;
\} :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
@ -31,8 +31,8 @@ voidfractionModel IB;
IBProps
\{
maxCellsPerParticle 1000;
alphaMin 0.10;
scaleUpVol 5.0;
alphaMin 0.10;
scaleUpVol 5.0;
\} :pre
[Description:]

12
doc/voidFractionModel_bigParticleVoidFraction.txt
View File

@ -16,9 +16,9 @@ voidfractionModel bigParticle;
bigParticleProps
\{
maxCellsPerParticle number1;
alphaMin number2;
weight number3;
porosity number4;
alphaMin number2;
weight number3;
porosity number4;
\} :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
@ -33,9 +33,9 @@ voidfractionModel bigParticle;
bigParticleProps
\{
maxCellsPerParticle 1000;
alphaMin 0.10;
weight 1.;
porosity 5.0;
alphaMin 0.10;
weight 1.;
porosity 5.0;
\} :pre
[Description:]

4
doc/voidFractionModel_centreVoidFraction.txt
View File

@ -16,7 +16,7 @@ voidfractionModel centre;
centreProps
\{
alphaMin number1;
weight number2;
weight number2;
\} :pre
{number1} = minimum limit for voidfraction :ulb,l
@ -29,7 +29,7 @@ voidfractionModel centre;
centreProps
\{
alphaMin 0.1;
weight 1.;
weight 1.0;
\} :pre
[Description:]

6
doc/voidFractionModel_dividedVoidFraction.txt
View File

@ -15,10 +15,10 @@ dictionary.
voidfractionModel divided;
dividedProps
\{
alphaMin number1;
alphaMin number1;
interpolation;
weight number2;
porosity number3;
weight number2;
porosity number3;
\} :pre
{number1} = minimum limit for voidfraction :ulb,l