mirror of
https://github.com/ParticulateFlow/CFDEMcoupling-PFM.git
synced 2025-12-08 06:37:44 +00:00
[DOC] fix up typos and formatting of model syntax/example
This commit is contained in:
@ -12,13 +12,13 @@ IOModel command :h3
|
|||||||
Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties
|
Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties
|
||||||
dictionary.
|
dictionary.
|
||||||
|
|
||||||
IOModel "model"; :pre
|
IOModel model; :pre
|
||||||
|
|
||||||
model = name of IO-model to be applied :ul
|
model = name of IO-model to be applied :ul
|
||||||
|
|
||||||
[Examples:]
|
[Examples:]
|
||||||
|
|
||||||
IOModel "off";
|
IOModel off; :pre
|
||||||
|
|
||||||
Note: This examples list might not be complete - please look for other models (IOModel_XY) in this documentation.
|
Note: This examples list might not be complete - please look for other models (IOModel_XY) in this documentation.
|
||||||
|
|
||||||
|
|||||||
@ -12,11 +12,12 @@ IOModel basicIO command :h3
|
|||||||
Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties
|
Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties
|
||||||
dictionary.
|
dictionary.
|
||||||
|
|
||||||
IOModel "basicIO"; :pre
|
IOModel basicIO; :pre
|
||||||
|
|
||||||
[Examples:]
|
[Examples:]
|
||||||
|
|
||||||
IOModel "basicIO"; :pre
|
IOModel basicIO;
|
||||||
|
serialOutput; :pre
|
||||||
|
|
||||||
[Description:]
|
[Description:]
|
||||||
|
|
||||||
|
|||||||
@ -12,11 +12,11 @@ IOModel off command :h3
|
|||||||
Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties
|
Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties
|
||||||
dictionary.
|
dictionary.
|
||||||
|
|
||||||
IOModel "off"; :pre
|
IOModel off; :pre
|
||||||
|
|
||||||
[Examples:]
|
[Examples:]
|
||||||
|
|
||||||
IOModel "off"; :pre
|
IOModel off; :pre
|
||||||
|
|
||||||
[Description:]
|
[Description:]
|
||||||
|
|
||||||
|
|||||||
@ -12,11 +12,11 @@ IOModel sophIO command :h3
|
|||||||
Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties
|
Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties
|
||||||
dictionary.
|
dictionary.
|
||||||
|
|
||||||
IOModel "sophIO"; :pre
|
IOModel sophIO; :pre
|
||||||
|
|
||||||
[Examples:]
|
[Examples:]
|
||||||
|
|
||||||
IOModel "sophIO"; :pre
|
IOModel sophIO; :pre
|
||||||
|
|
||||||
[Description:]
|
[Description:]
|
||||||
|
|
||||||
|
|||||||
@ -12,11 +12,11 @@ IOModel trackIO command :h3
|
|||||||
Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties
|
Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties
|
||||||
dictionary.
|
dictionary.
|
||||||
|
|
||||||
IOModel "trackIO"; :pre
|
IOModel trackIO; :pre
|
||||||
|
|
||||||
[Examples:]
|
[Examples:]
|
||||||
|
|
||||||
IOModel "trackIO"; :pre
|
IOModel trackIO; :pre
|
||||||
|
|
||||||
[Description:]
|
[Description:]
|
||||||
|
|
||||||
|
|||||||
@ -18,10 +18,10 @@ chemistryModels
|
|||||||
);
|
);
|
||||||
diffusionCoefficientsProps
|
diffusionCoefficientsProps
|
||||||
\{
|
\{
|
||||||
verbose switch1;
|
verbose switch1;
|
||||||
ChemistryFile "$casePath/CFD/constant/foam.inp";
|
ChemistryFile "$casePath/CFD/constant/foam.inp";
|
||||||
diffusantGasNames ( speciesNames );
|
diffusantGasNames ( speciesNames );
|
||||||
\}; :pre
|
\} :pre
|
||||||
|
|
||||||
{switch1} = (optional, normally off) flag to give information :l
|
{switch1} = (optional, normally off) flag to give information :l
|
||||||
{ChemistryFile} = path to file, where the reacting species are listed :ulb,l
|
{ChemistryFile} = path to file, where the reacting species are listed :ulb,l
|
||||||
@ -34,13 +34,13 @@ chemistryModels
|
|||||||
(
|
(
|
||||||
diffusionCoefficients
|
diffusionCoefficients
|
||||||
);
|
);
|
||||||
speciesProps
|
diffusionCoefficientsProps
|
||||||
\{
|
\{
|
||||||
verbose false;
|
verbose false;
|
||||||
ChemistryFile "$casePath/CFD/constant/foam.inp";
|
ChemistryFile "$casePath/CFD/constant/foam.inp";
|
||||||
diffusantGasNames ( CO
|
diffusantGasNames ( CO
|
||||||
H2
|
H2
|
||||||
);
|
);
|
||||||
\} :pre
|
\} :pre
|
||||||
|
|
||||||
[Description:]
|
[Description:]
|
||||||
|
|||||||
@ -16,10 +16,10 @@ chemistryModels
|
|||||||
(
|
(
|
||||||
massTransferCoeff
|
massTransferCoeff
|
||||||
);
|
);
|
||||||
diffusionCoefficientsProps
|
massTransferCoeffProps
|
||||||
\{
|
\{
|
||||||
verbose switch1;
|
verbose switch1;
|
||||||
\}; :pre
|
\} :pre
|
||||||
|
|
||||||
{switch1} = (optional, normally off) flag to give information :l
|
{switch1} = (optional, normally off) flag to give information :l
|
||||||
:ule
|
:ule
|
||||||
@ -32,7 +32,7 @@ chemistryModels
|
|||||||
);
|
);
|
||||||
massTransferCoeffProps
|
massTransferCoeffProps
|
||||||
\{
|
\{
|
||||||
verbose false;
|
verbose false;
|
||||||
\} :pre
|
\} :pre
|
||||||
|
|
||||||
[Description:]
|
[Description:]
|
||||||
|
|||||||
@ -18,15 +18,15 @@ chemistryModels
|
|||||||
);
|
);
|
||||||
speciesProps
|
speciesProps
|
||||||
\{
|
\{
|
||||||
ChemistryFile "$casePath/CFD/constant/foam.inp";
|
ChemistryFile "$casePath/CFD/constant/foam.inp";
|
||||||
verbose switch1;
|
tempFieldName "T";
|
||||||
tempFieldName "T";
|
densityFieldName "rho";
|
||||||
densityFieldName "rho"
|
voidfractionFieldName "voidfraction";
|
||||||
voidfractionFieldName "voidfraction"
|
totalMoleFieldName "molarConc";
|
||||||
totalMoleFieldName "molarConc"
|
partTempName "partTemp";
|
||||||
partTempName "partTemp"
|
partRhoName "partRho";
|
||||||
partRhoName "partRho"
|
verbose switch1;
|
||||||
\}; :pre
|
\} :pre
|
||||||
|
|
||||||
{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
|
||||||
@ -46,8 +46,8 @@ chemistryModels
|
|||||||
);
|
);
|
||||||
speciesProps
|
speciesProps
|
||||||
\{
|
\{
|
||||||
ChemistryFile "$casePath/CFD/constant/foam.inp";
|
ChemistryFile "$casePath/CFD/constant/foam.inp";
|
||||||
verbose false;
|
verbose false;
|
||||||
\} :pre
|
\} :pre
|
||||||
|
|
||||||
[Description:]
|
[Description:]
|
||||||
|
|||||||
@ -15,11 +15,11 @@ dictionary.
|
|||||||
dataExchangeModel oneWayVTK;
|
dataExchangeModel oneWayVTK;
|
||||||
oneWayVTKProps
|
oneWayVTKProps
|
||||||
\{
|
\{
|
||||||
DEMts timeStep;
|
DEMts timeStep;
|
||||||
relativePath "path";
|
relativePath "path";
|
||||||
couplingFilename "filename";
|
couplingFilename "filename";
|
||||||
maxNumberOfParticles number;
|
maxNumberOfParticles number;
|
||||||
\}; :pre
|
\} :pre
|
||||||
|
|
||||||
{timeStep} = time step size of stored DEM data :ulb,l
|
{timeStep} = time step size of stored DEM data :ulb,l
|
||||||
{path} = path to the VTK data files relative do simulation directory :l
|
{path} = path to the VTK data files relative do simulation directory :l
|
||||||
@ -32,10 +32,10 @@ oneWayVTKProps
|
|||||||
dataExchangeModel oneWayVTK;
|
dataExchangeModel oneWayVTK;
|
||||||
oneWayVTKProps
|
oneWayVTKProps
|
||||||
\{
|
\{
|
||||||
DEMts 0.0001;
|
DEMts 0.0001;
|
||||||
relativePath "../DEM/post";
|
relativePath "../DEM/post";
|
||||||
couplingFilename "vtk_out%4.4d.vtk";
|
couplingFilename "vtk_out%4.4d.vtk";
|
||||||
maxNumberOfParticles 30000;
|
maxNumberOfParticles 30000;
|
||||||
\} :pre
|
\} :pre
|
||||||
|
|
||||||
[Description:]
|
[Description:]
|
||||||
|
|||||||
@ -15,9 +15,9 @@ dictionary.
|
|||||||
dataExchangeModel twoWayFiles;
|
dataExchangeModel twoWayFiles;
|
||||||
twoWayFilesProps
|
twoWayFilesProps
|
||||||
\{
|
\{
|
||||||
couplingFilename "filename";
|
couplingFilename "filename";
|
||||||
maxNumberOfParticles number;
|
maxNumberOfParticles number;
|
||||||
\}; :pre
|
\} :pre
|
||||||
|
|
||||||
{filename} = filename of the VTK file series :ulb,l
|
{filename} = filename of the VTK file series :ulb,l
|
||||||
{number} = maximum number of particles in DEM simulation :l
|
{number} = maximum number of particles in DEM simulation :l
|
||||||
@ -28,8 +28,8 @@ twoWayFilesProps
|
|||||||
dataExchangeModel twoWayFiles;
|
dataExchangeModel twoWayFiles;
|
||||||
twoWayFilesProps
|
twoWayFilesProps
|
||||||
\{
|
\{
|
||||||
couplingFilename "vtk_out%4.4d.vtk";
|
couplingFilename "vtk_out%4.4d.vtk";
|
||||||
maxNumberOfParticles 30000;
|
maxNumberOfParticles 30000;
|
||||||
\} :pre
|
\} :pre
|
||||||
|
|
||||||
[Description:]
|
[Description:]
|
||||||
|
|||||||
@ -16,7 +16,7 @@ dataExchangeModel twoWayMPI;
|
|||||||
twoWayMPIProps
|
twoWayMPIProps
|
||||||
\{
|
\{
|
||||||
liggghtsPath "path";
|
liggghtsPath "path";
|
||||||
\}; :pre
|
\} :pre
|
||||||
|
|
||||||
{path} = path to the DEM simulation input file :ulb,l
|
{path} = path to the DEM simulation input file :ulb,l
|
||||||
:ule
|
:ule
|
||||||
|
|||||||
@ -16,7 +16,7 @@ dataExchangeModel twoWayMany2Many;
|
|||||||
twoWayMany2ManyProps
|
twoWayMany2ManyProps
|
||||||
\{
|
\{
|
||||||
liggghtsPath "path";
|
liggghtsPath "path";
|
||||||
\}; :pre
|
\} :pre
|
||||||
|
|
||||||
{path} = path to the DEM simulation input file :ulb,l
|
{path} = path to the DEM simulation input file :ulb,l
|
||||||
:ule
|
:ule
|
||||||
|
|||||||
@ -19,7 +19,7 @@ forceModels
|
|||||||
ArchimedesProps
|
ArchimedesProps
|
||||||
\{
|
\{
|
||||||
gravityFieldName "gravity";
|
gravityFieldName "gravity";
|
||||||
\}; :pre
|
\} :pre
|
||||||
|
|
||||||
{gravity} = name of the finite volume gravity field :ulb,l
|
{gravity} = name of the finite volume gravity field :ulb,l
|
||||||
:ule
|
:ule
|
||||||
|
|||||||
@ -18,9 +18,9 @@ forceModels
|
|||||||
);
|
);
|
||||||
ArchimedesIBProps
|
ArchimedesIBProps
|
||||||
\{
|
\{
|
||||||
gravityFieldName "gravity";
|
gravityFieldName "gravity";
|
||||||
voidfractionFieldName "voidfraction";
|
voidfractionFieldName "voidfraction";
|
||||||
\}; :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 voidfraction field :l
|
||||||
@ -34,8 +34,8 @@ forceModels
|
|||||||
);
|
);
|
||||||
ArchimedesIBProps
|
ArchimedesIBProps
|
||||||
\{
|
\{
|
||||||
gravityFieldName "g";
|
gravityFieldName "g";
|
||||||
voidfractionFieldName "voidfractionNext";
|
voidfractionFieldName "voidfractionNext";
|
||||||
\} :pre
|
\} :pre
|
||||||
|
|
||||||
[Description:]
|
[Description:]
|
||||||
|
|||||||
@ -18,9 +18,9 @@ forceModels
|
|||||||
);
|
);
|
||||||
DiFeliceDragProps
|
DiFeliceDragProps
|
||||||
\{
|
\{
|
||||||
velFieldName "U";
|
velFieldName "U";
|
||||||
interpolation switch1;
|
interpolation switch1;
|
||||||
\}; :pre
|
\} :pre
|
||||||
|
|
||||||
{U} = name of the finite volume fluid velocity field :ulb,l
|
{U} = name of the finite volume fluid velocity field :ulb,l
|
||||||
{switch1} = flag to use interpolated voidfraction and velocity values (normally off) :l
|
{switch1} = flag to use interpolated voidfraction and velocity values (normally off) :l
|
||||||
@ -34,7 +34,7 @@ forceModels
|
|||||||
);
|
);
|
||||||
DiFeliceDragProps
|
DiFeliceDragProps
|
||||||
\{
|
\{
|
||||||
velFieldName "U";
|
velFieldName "U";
|
||||||
interpolation true;
|
interpolation true;
|
||||||
\} :pre
|
\} :pre
|
||||||
|
|
||||||
|
|||||||
@ -18,13 +18,13 @@ forceModels
|
|||||||
);
|
);
|
||||||
GidaspowDragProps
|
GidaspowDragProps
|
||||||
\{
|
\{
|
||||||
velFieldName "U";
|
velFieldName "U";
|
||||||
voidfractionFieldName "voidfraction";
|
voidfractionFieldName "voidfraction";
|
||||||
granVelFieldName "Us";
|
granVelFieldName "Us";
|
||||||
phi "scalar";
|
phi scalar;
|
||||||
interpolation switch1;
|
interpolation switch1;
|
||||||
implForceDEM switch2;
|
implForceDEM switch2;
|
||||||
\}; :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 voidfraction field :l
|
||||||
@ -42,9 +42,9 @@ forceModels
|
|||||||
);
|
);
|
||||||
GidaspowDragProps
|
GidaspowDragProps
|
||||||
\{
|
\{
|
||||||
velFieldName "U";
|
velFieldName "U";
|
||||||
voidfractionFieldName "voidfraction";
|
voidfractionFieldName "voidfraction";
|
||||||
granVelFieldName "Us";
|
granVelFieldName "Us";
|
||||||
\} :pre
|
\} :pre
|
||||||
|
|
||||||
[Description:]
|
[Description:]
|
||||||
|
|||||||
@ -18,16 +18,16 @@ forceModels
|
|||||||
);
|
);
|
||||||
KochHillDragProps
|
KochHillDragProps
|
||||||
\{
|
\{
|
||||||
velFieldName "U";
|
velFieldName "U";
|
||||||
voidfractionFieldName "voidfraction";
|
voidfractionFieldName "voidfraction";
|
||||||
interpolation "bool1";
|
interpolation switch1;
|
||||||
implForceDEM "bool2";
|
implForceDEM switch2;
|
||||||
\}; :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 voidfraction field :l
|
||||||
{bool1} = (optional, normally off) flag to use interpolated voidfraction and fluid velocity values :l
|
{switch1} = (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
|
{switch2} = (optional, normally off) flag to use implicit formulation of drag on DEM side :l
|
||||||
:ule
|
:ule
|
||||||
|
|
||||||
[Examples:]
|
[Examples:]
|
||||||
|
|||||||
@ -18,16 +18,16 @@ forceModels
|
|||||||
);
|
);
|
||||||
LaEuScalarTempProps
|
LaEuScalarTempProps
|
||||||
\{
|
\{
|
||||||
velFieldName "U";
|
velFieldName "U";
|
||||||
tempFieldName "T";
|
tempFieldName "T";
|
||||||
voidfractionFieldName "voidfraction";
|
voidfractionFieldName "voidfraction";
|
||||||
partTempName "Temp";
|
partTempName "Temp";
|
||||||
partHeatFluxName "convectiveHeatFlux";
|
partHeatFluxName "convectiveHeatFlux";
|
||||||
lambda value;
|
lambda value;
|
||||||
Cp value1;
|
Cp value1;
|
||||||
interpolation "switch1";
|
interpolation "switch1";
|
||||||
verbose "switch2";
|
verbose "switch2";
|
||||||
\}; :pre
|
\} :pre
|
||||||
|
|
||||||
{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
|
||||||
@ -48,13 +48,13 @@ forceModels
|
|||||||
);
|
);
|
||||||
LaEuScalarTempProps
|
LaEuScalarTempProps
|
||||||
\{
|
\{
|
||||||
velFieldName "U";
|
velFieldName "U";
|
||||||
tempFieldName "T";
|
tempFieldName "T";
|
||||||
voidfractionFieldName "voidfraction";
|
voidfractionFieldName "voidfraction";
|
||||||
partTempName "Temp";
|
partTempName "Temp";
|
||||||
partHeatFluxName "convectiveHeatFlux";
|
partHeatFluxName "convectiveHeatFlux";
|
||||||
lambda 0.0256;
|
lambda 0.0256;
|
||||||
Cp 1007;
|
Cp 1007;
|
||||||
\} :pre
|
\} :pre
|
||||||
|
|
||||||
[Description:]
|
[Description:]
|
||||||
|
|||||||
@ -18,11 +18,11 @@ forceModels
|
|||||||
);
|
);
|
||||||
MeiLiftProps
|
MeiLiftProps
|
||||||
\{
|
\{
|
||||||
velFieldName "U";
|
velFieldName "U";
|
||||||
useSecondOrderTerms;
|
useSecondOrderTerms;
|
||||||
interpolation "switch1";
|
interpolation switch1;
|
||||||
verbose "switch2";
|
verbose switch2;
|
||||||
\}; :pre
|
\} :pre
|
||||||
|
|
||||||
{U} = name of the finite volume fluid velocity field :ulb,l
|
{U} = name of the finite volume fluid velocity field :ulb,l
|
||||||
{useSecondOrderTerms} = switch to activate second order terms in the lift force model :l
|
{useSecondOrderTerms} = switch to activate second order terms in the lift force model :l
|
||||||
@ -38,10 +38,10 @@ forceModels
|
|||||||
);
|
);
|
||||||
MeiLiftProps
|
MeiLiftProps
|
||||||
\{
|
\{
|
||||||
velFieldName "U";
|
velFieldName "U";
|
||||||
useSecondOrderTerms;
|
useSecondOrderTerms;
|
||||||
interpolation true;
|
interpolation true;
|
||||||
verbose true;
|
verbose true;
|
||||||
\} :pre
|
\} :pre
|
||||||
|
|
||||||
[Description:]
|
[Description:]
|
||||||
|
|||||||
@ -19,7 +19,7 @@ forceModels
|
|||||||
SchillerNaumannDragProps
|
SchillerNaumannDragProps
|
||||||
\{
|
\{
|
||||||
velFieldName "U";
|
velFieldName "U";
|
||||||
\}; :pre
|
\} :pre
|
||||||
|
|
||||||
{U} = name of the finite volume fluid velocity field :ulb,l
|
{U} = name of the finite volume fluid velocity field :ulb,l
|
||||||
:ule
|
:ule
|
||||||
|
|||||||
@ -20,7 +20,7 @@ ShirgaonkarIBProps
|
|||||||
\{
|
\{
|
||||||
velFieldName "U";
|
velFieldName "U";
|
||||||
pressureFieldName "pressure";
|
pressureFieldName "pressure";
|
||||||
\}; :pre
|
\} :pre
|
||||||
|
|
||||||
{U} = name of the finite volume fluid velocity field :ulb,l
|
{U} = name of the finite volume fluid velocity field :ulb,l
|
||||||
{pressure} = name of the finite volume pressure field :l
|
{pressure} = name of the finite volume pressure field :l
|
||||||
|
|||||||
@ -22,10 +22,10 @@ dSauterProps
|
|||||||
(
|
(
|
||||||
X Y Z
|
X Y Z
|
||||||
);
|
);
|
||||||
\}; :pre
|
\} :pre
|
||||||
|
|
||||||
{coarseGrainingFactors} = list of coarse graining factors by type, separated by whitespace, optional :ulb,l
|
|
||||||
|
|
||||||
|
{coarseGrainingFactors} = list of coarse graining factors by type, separated by
|
||||||
|
whitespace, optional :ulb,l
|
||||||
:ule
|
:ule
|
||||||
|
|
||||||
[Description:]
|
[Description:]
|
||||||
|
|||||||
@ -26,7 +26,7 @@ fieldStoreProps
|
|||||||
(
|
(
|
||||||
"vectorField"
|
"vectorField"
|
||||||
);
|
);
|
||||||
\}; :pre
|
\} :pre
|
||||||
|
|
||||||
{scalarField} = names of the finite volume scalar fields to be stored :ulb,l
|
{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
|
{vectorField} = names of the finite volume vector fields to be stored :l
|
||||||
|
|||||||
@ -18,10 +18,10 @@ forceModels
|
|||||||
);
|
);
|
||||||
gradPForceProps
|
gradPForceProps
|
||||||
\{
|
\{
|
||||||
pFieldName "pressure";
|
pFieldName "pressure";
|
||||||
velocityFieldName "U";
|
velocityFieldName "U";
|
||||||
interpolation switch1;
|
interpolation switch1;
|
||||||
\}; :pre
|
\} :pre
|
||||||
|
|
||||||
{pressure} = name of the finite volume fluid pressure field :ulb,l
|
{pressure} = name of the finite volume fluid pressure field :ulb,l
|
||||||
{U} = name of the finite volume fluid velocity field :l
|
{U} = name of the finite volume fluid velocity field :l
|
||||||
@ -36,9 +36,9 @@ forceModels
|
|||||||
);
|
);
|
||||||
gradPForceProps
|
gradPForceProps
|
||||||
\{
|
\{
|
||||||
pFieldName "p";
|
pFieldName "p";
|
||||||
velocityFieldName "U";
|
velocityFieldName "U";
|
||||||
interpolation true;
|
interpolation true;
|
||||||
\} :pre
|
\} :pre
|
||||||
|
|
||||||
[Description:]
|
[Description:]
|
||||||
|
|||||||
@ -16,18 +16,24 @@ forceModels
|
|||||||
(
|
(
|
||||||
noDrag
|
noDrag
|
||||||
); :pre
|
); :pre
|
||||||
|
noDragProps (optional)
|
||||||
|
\{
|
||||||
|
noDEMForce; (optional)
|
||||||
|
keepCFDForce; (optional)
|
||||||
|
\} :pre
|
||||||
|
|
||||||
|
|
||||||
[Examples:]
|
[Examples:]
|
||||||
|
|
||||||
forceModels
|
forceModels
|
||||||
(
|
(
|
||||||
noDrag
|
noDrag
|
||||||
); :pre
|
)
|
||||||
|
noDragProps
|
||||||
noDragProps (optional)
|
|
||||||
\{
|
\{
|
||||||
noDEMForce; (optional)
|
noDEMForce;
|
||||||
\}; :pre
|
\} :pre
|
||||||
|
|
||||||
|
|
||||||
[Description:]
|
[Description:]
|
||||||
|
|
||||||
|
|||||||
@ -21,7 +21,7 @@ particleCellVolumeProps
|
|||||||
upperThreshold value;
|
upperThreshold value;
|
||||||
lowerThreshold value2;
|
lowerThreshold value2;
|
||||||
verbose;
|
verbose;
|
||||||
\}; :pre
|
\} :pre
|
||||||
|
|
||||||
{value} = only cells with a field value (magnitude) lower than this upper threshold are considered :l
|
{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
|
{value2} = only cells with a field value (magnitude) greater than this lower threshold are considered :l
|
||||||
|
|||||||
@ -27,7 +27,7 @@ pdCorrelationProps
|
|||||||
A B C
|
A B C
|
||||||
);
|
);
|
||||||
runOnWriteOnly true;
|
runOnWriteOnly true;
|
||||||
\}; :pre
|
\} :pre
|
||||||
|
|
||||||
{coarseGrainingFactors} = list of coarse graining factors by type, separated by whitespace, optional :ulb,l
|
{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
|
{particleDensities} = list of particle densities by type, separated by whitespace, optional :l
|
||||||
|
|||||||
@ -19,7 +19,7 @@ forceModels
|
|||||||
virtualMassForceProps
|
virtualMassForceProps
|
||||||
\{
|
\{
|
||||||
velFieldName "U";
|
velFieldName "U";
|
||||||
\}; :pre
|
\} :pre
|
||||||
|
|
||||||
{U} = name of the finite volume fluid velocity field :ulb,l
|
{U} = name of the finite volume fluid velocity field :ulb,l
|
||||||
:ule
|
:ule
|
||||||
|
|||||||
@ -19,8 +19,8 @@ forceModels
|
|||||||
viscForceProps
|
viscForceProps
|
||||||
\{
|
\{
|
||||||
velocityFieldName "U";
|
velocityFieldName "U";
|
||||||
interpolation "switch";
|
interpolation switch;
|
||||||
\}; :pre
|
\} :pre
|
||||||
|
|
||||||
{U} = name of the finite volume fluid velocity field :ulb,l
|
{U} = name of the finite volume fluid velocity field :ulb,l
|
||||||
{switch} = flag to use interpolated stress values (normally off) :l
|
{switch} = flag to use interpolated stress values (normally off) :l
|
||||||
|
|||||||
@ -15,11 +15,11 @@ sub-dictionary of the force model in use.
|
|||||||
forceSubModels
|
forceSubModels
|
||||||
(
|
(
|
||||||
ImEx;
|
ImEx;
|
||||||
);
|
); :pre
|
||||||
|
|
||||||
treatExplicit true; // optional for some force models.
|
treatExplicit true; // optional for some force models.
|
||||||
treatDEM 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:]
|
[Examples:]
|
||||||
|
|
||||||
@ -27,7 +27,7 @@ forceSubModels
|
|||||||
(
|
(
|
||||||
ImEx;
|
ImEx;
|
||||||
);
|
);
|
||||||
treatExplicit true; // optional for some force models.
|
treatExplicit true; // optional for some force models. :pre
|
||||||
|
|
||||||
[Description:]
|
[Description:]
|
||||||
|
|
||||||
|
|||||||
@ -16,11 +16,10 @@ forceSubModels
|
|||||||
(
|
(
|
||||||
ImExCorr;
|
ImExCorr;
|
||||||
);
|
);
|
||||||
|
|
||||||
treatExplicit true; // optional for some force models.
|
treatExplicit true; // optional for some force models.
|
||||||
treatDEM 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.
|
||||||
explicitInterpCorr true; // optional for some force models.
|
explicitInterpCorr true; // optional for some force models. :pre
|
||||||
|
|
||||||
[Examples:]
|
[Examples:]
|
||||||
|
|
||||||
@ -28,7 +27,7 @@ forceSubModels
|
|||||||
(
|
(
|
||||||
ImExCorr;
|
ImExCorr;
|
||||||
);
|
);
|
||||||
treatExplicit true; // optional for some force models.
|
treatExplicit true; // optional for some force models. :pre
|
||||||
|
|
||||||
[Description:]
|
[Description:]
|
||||||
|
|
||||||
|
|||||||
@ -23,10 +23,10 @@ executeProps0
|
|||||||
run
|
run
|
||||||
$couplingInterval
|
$couplingInterval
|
||||||
);
|
);
|
||||||
runFirst switch1;
|
runFirst switch1;
|
||||||
runLast switch2;
|
runLast switch2;
|
||||||
runEveryCouplingStep switch3;
|
runEveryCouplingStep switch3;
|
||||||
runEveryWriteStep switch4;
|
runEveryWriteStep switch4;
|
||||||
verbose;
|
verbose;
|
||||||
\} :pre
|
\} :pre
|
||||||
|
|
||||||
@ -52,8 +52,8 @@ executeProps0
|
|||||||
run
|
run
|
||||||
$couplingInterval
|
$couplingInterval
|
||||||
);
|
);
|
||||||
runFirst off;
|
runFirst off;
|
||||||
runLast off;
|
runLast off;
|
||||||
runEveryCouplingStep on;
|
runEveryCouplingStep on;
|
||||||
\}
|
\}
|
||||||
executeProps1
|
executeProps1
|
||||||
@ -69,10 +69,10 @@ executeProps1
|
|||||||
liggghts.restart_
|
liggghts.restart_
|
||||||
timeStamp
|
timeStamp
|
||||||
);
|
);
|
||||||
runFirst off;
|
runFirst off;
|
||||||
runLast off;
|
runLast off;
|
||||||
runEveryCouplingStep off;
|
runEveryCouplingStep off;
|
||||||
runEveryWriteStep on;
|
runEveryWriteStep on;
|
||||||
\} :pre
|
\} :pre
|
||||||
|
|
||||||
[Description:]
|
[Description:]
|
||||||
|
|||||||
@ -27,7 +27,6 @@ readLiggghtsDataProps0
|
|||||||
liggghtsCommandModels
|
liggghtsCommandModels
|
||||||
(
|
(
|
||||||
readLiggghtsData
|
readLiggghtsData
|
||||||
readLiggghtsData
|
|
||||||
);
|
);
|
||||||
readLiggghtsDataProps0
|
readLiggghtsDataProps0
|
||||||
\{
|
\{
|
||||||
|
|||||||
@ -19,7 +19,7 @@ engineIBProps
|
|||||||
\{
|
\{
|
||||||
treeSearch switch1;
|
treeSearch switch1;
|
||||||
\}
|
\}
|
||||||
zSplit value1;
|
zSplit value1;
|
||||||
xySplit value2;
|
xySplit value2;
|
||||||
\} :pre
|
\} :pre
|
||||||
|
|
||||||
@ -37,7 +37,7 @@ engineIBProps
|
|||||||
\{
|
\{
|
||||||
treeSearch false;
|
treeSearch false;
|
||||||
\}
|
\}
|
||||||
zSplit 8;
|
zSplit 8;
|
||||||
xySplit 16;
|
xySplit 16;
|
||||||
\} :pre
|
\} :pre
|
||||||
|
|
||||||
|
|||||||
@ -18,10 +18,10 @@ momCoupleModels
|
|||||||
);
|
);
|
||||||
implicitCoupleProps
|
implicitCoupleProps
|
||||||
\{
|
\{
|
||||||
velFieldName "U";
|
velFieldName "U";
|
||||||
granVelFieldName "Us";
|
granVelFieldName "Us";
|
||||||
voidfractionFieldName "voidfraction";
|
voidfractionFieldName "voidfraction";
|
||||||
minAlphaP number;
|
minAlphaP number;
|
||||||
\} :pre
|
\} :pre
|
||||||
|
|
||||||
{U} = name of the finite volume fluid velocity field :ulb,l
|
{U} = name of the finite volume fluid velocity field :ulb,l
|
||||||
@ -38,8 +38,8 @@ momCoupleModels
|
|||||||
);
|
);
|
||||||
implicitCoupleProps
|
implicitCoupleProps
|
||||||
\{
|
\{
|
||||||
velFieldName "U";
|
velFieldName "U";
|
||||||
granVelFieldName "Us";
|
granVelFieldName "Us";
|
||||||
voidfractionFieldName "voidfraction";
|
voidfractionFieldName "voidfraction";
|
||||||
\} :pre
|
\} :pre
|
||||||
|
|
||||||
|
|||||||
@ -9,21 +9,19 @@ probeModel command :h3
|
|||||||
|
|
||||||
[Syntax:]
|
[Syntax:]
|
||||||
|
|
||||||
To be activated via couplingProperties dictionary.
|
Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties
|
||||||
|
dictionary.
|
||||||
|
|
||||||
probeModel myProbeModel; :pre
|
probeModel model;
|
||||||
|
modelProps
|
||||||
Use probe model "off" to disable this feature.
|
\{
|
||||||
|
\} :pre
|
||||||
myProbeModelProps :pre
|
|
||||||
\{ :pre
|
|
||||||
|
|
||||||
\}; :pre
|
|
||||||
|
|
||||||
|
model = name of the probeModel to be applied :ul
|
||||||
|
|
||||||
[Examples:]
|
[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.
|
Note: This examples list might not be complete - please check below for the list of force models that can perform particle probing.
|
||||||
|
|
||||||
|
|||||||
@ -12,12 +12,7 @@ probeModel off command :h3
|
|||||||
Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties
|
Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties
|
||||||
dictionary.
|
dictionary.
|
||||||
|
|
||||||
forceModels
|
probeModel off; :pre
|
||||||
\{
|
|
||||||
myForceModel1
|
|
||||||
myForceModel2
|
|
||||||
myForceModel3
|
|
||||||
\}; :pre
|
|
||||||
|
|
||||||
[Examples:]
|
[Examples:]
|
||||||
|
|
||||||
|
|||||||
@ -18,8 +18,8 @@ model = name of the smoothingModel to be applied :ul
|
|||||||
|
|
||||||
[Examples:]
|
[Examples:]
|
||||||
|
|
||||||
smoothingModel off; :pre
|
smoothingModel off;
|
||||||
smoothingModel constDiffSmoothing; :pre
|
smoothingModel constDiffSmoothing; :pre
|
||||||
|
|
||||||
Note: This examples list might not be complete - please look for other models (smoothingModel_XY) in this documentation.
|
Note: This examples list might not be complete - please look for other models (smoothingModel_XY) in this documentation.
|
||||||
|
|
||||||
|
|||||||
@ -15,9 +15,9 @@ dictionary.
|
|||||||
smoothingModel constDiffSmoothing;
|
smoothingModel constDiffSmoothing;
|
||||||
constDiffSmoothingProps
|
constDiffSmoothingProps
|
||||||
\{
|
\{
|
||||||
lowerLimit number1;
|
lowerLimit number1;
|
||||||
upperLimit number2;
|
upperLimit number2;
|
||||||
smoothingLength lengthScale;
|
smoothingLength lengthScale;
|
||||||
smoothingLengthReferenceField lengthScaleRefField;
|
smoothingLengthReferenceField lengthScaleRefField;
|
||||||
\} :pre
|
\} :pre
|
||||||
|
|
||||||
@ -31,9 +31,9 @@ constDiffSmoothingProps
|
|||||||
|
|
||||||
constDiffSmoothingProps
|
constDiffSmoothingProps
|
||||||
\{
|
\{
|
||||||
lowerLimit 0.1;
|
lowerLimit 0.1;
|
||||||
upperLimit 1e10;
|
upperLimit 1e10;
|
||||||
smoothingLength 1500e-6;
|
smoothingLength 1500e-6;
|
||||||
smoothingLengthReferenceField 9000e-6;
|
smoothingLengthReferenceField 9000e-6;
|
||||||
\} :pre
|
\} :pre
|
||||||
|
|
||||||
|
|||||||
@ -16,9 +16,9 @@ voidfractionModel Gauss;
|
|||||||
GaussProps
|
GaussProps
|
||||||
\{
|
\{
|
||||||
maxCellsPerParticle number1;
|
maxCellsPerParticle number1;
|
||||||
alphaMin number2;
|
alphaMin number2;
|
||||||
weight number3;
|
weight number3;
|
||||||
porosity number4;
|
porosity number4;
|
||||||
\} :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
|
||||||
@ -33,9 +33,9 @@ voidfractionModel Gauss;
|
|||||||
GaussProps
|
GaussProps
|
||||||
\{
|
\{
|
||||||
maxCellsPerParticle 1000;
|
maxCellsPerParticle 1000;
|
||||||
alphaMin 0.10;
|
alphaMin 0.10;
|
||||||
weight 1.;
|
weight 1.0;
|
||||||
porosity 1.;
|
porosity 1.0;
|
||||||
\} :pre
|
\} :pre
|
||||||
|
|
||||||
[Description:]
|
[Description:]
|
||||||
|
|||||||
@ -16,8 +16,8 @@ voidfractionModel IB;
|
|||||||
IBProps
|
IBProps
|
||||||
\{
|
\{
|
||||||
maxCellsPerParticle number1;
|
maxCellsPerParticle number1;
|
||||||
alphaMin number2;
|
alphaMin number2;
|
||||||
scaleUpVol number3;
|
scaleUpVol number3;
|
||||||
\} :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
|
||||||
@ -31,8 +31,8 @@ voidfractionModel IB;
|
|||||||
IBProps
|
IBProps
|
||||||
\{
|
\{
|
||||||
maxCellsPerParticle 1000;
|
maxCellsPerParticle 1000;
|
||||||
alphaMin 0.10;
|
alphaMin 0.10;
|
||||||
scaleUpVol 5.0;
|
scaleUpVol 5.0;
|
||||||
\} :pre
|
\} :pre
|
||||||
|
|
||||||
[Description:]
|
[Description:]
|
||||||
|
|||||||
@ -16,9 +16,9 @@ voidfractionModel bigParticle;
|
|||||||
bigParticleProps
|
bigParticleProps
|
||||||
\{
|
\{
|
||||||
maxCellsPerParticle number1;
|
maxCellsPerParticle number1;
|
||||||
alphaMin number2;
|
alphaMin number2;
|
||||||
weight number3;
|
weight number3;
|
||||||
porosity number4;
|
porosity number4;
|
||||||
\} :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
|
||||||
@ -33,9 +33,9 @@ voidfractionModel bigParticle;
|
|||||||
bigParticleProps
|
bigParticleProps
|
||||||
\{
|
\{
|
||||||
maxCellsPerParticle 1000;
|
maxCellsPerParticle 1000;
|
||||||
alphaMin 0.10;
|
alphaMin 0.10;
|
||||||
weight 1.;
|
weight 1.;
|
||||||
porosity 5.0;
|
porosity 5.0;
|
||||||
\} :pre
|
\} :pre
|
||||||
|
|
||||||
[Description:]
|
[Description:]
|
||||||
|
|||||||
@ -16,7 +16,7 @@ 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 voidfraction :ulb,l
|
||||||
@ -29,7 +29,7 @@ voidfractionModel centre;
|
|||||||
centreProps
|
centreProps
|
||||||
\{
|
\{
|
||||||
alphaMin 0.1;
|
alphaMin 0.1;
|
||||||
weight 1.;
|
weight 1.0;
|
||||||
\} :pre
|
\} :pre
|
||||||
|
|
||||||
[Description:]
|
[Description:]
|
||||||
|
|||||||
@ -15,10 +15,10 @@ dictionary.
|
|||||||
voidfractionModel divided;
|
voidfractionModel divided;
|
||||||
dividedProps
|
dividedProps
|
||||||
\{
|
\{
|
||||||
alphaMin number1;
|
alphaMin number1;
|
||||||
interpolation;
|
interpolation;
|
||||||
weight number2;
|
weight number2;
|
||||||
porosity number3;
|
porosity number3;
|
||||||
\} :pre
|
\} :pre
|
||||||
|
|
||||||
{number1} = minimum limit for voidfraction :ulb,l
|
{number1} = minimum limit for voidfraction :ulb,l
|
||||||
|
|||||||
Reference in New Issue
Block a user