diff --git a/doc/IOModel.txt b/doc/IOModel.txt index 9e9ea7ce..216c2f4f 100644 --- a/doc/IOModel.txt +++ b/doc/IOModel.txt @@ -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. diff --git a/doc/IOModel_basicIO.txt b/doc/IOModel_basicIO.txt index 039f15c0..26b5e62d 100644 --- a/doc/IOModel_basicIO.txt +++ b/doc/IOModel_basicIO.txt @@ -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:] diff --git a/doc/IOModel_noIO.txt b/doc/IOModel_noIO.txt index 9efd00b8..a3c8a03f 100644 --- a/doc/IOModel_noIO.txt +++ b/doc/IOModel_noIO.txt @@ -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:] diff --git a/doc/IOModel_sophIO.txt b/doc/IOModel_sophIO.txt index fc5e5bec..68f55711 100644 --- a/doc/IOModel_sophIO.txt +++ b/doc/IOModel_sophIO.txt @@ -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:] diff --git a/doc/IOModel_trackIO.txt b/doc/IOModel_trackIO.txt index 946d3f34..0a173a66 100644 --- a/doc/IOModel_trackIO.txt +++ b/doc/IOModel_trackIO.txt @@ -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:] diff --git a/doc/chemistryModel_diffusionCoefficients.txt b/doc/chemistryModel_diffusionCoefficients.txt index 0fca99a9..3c665bb8 100644 --- a/doc/chemistryModel_diffusionCoefficients.txt +++ b/doc/chemistryModel_diffusionCoefficients.txt @@ -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 @@ -30,17 +30,17 @@ diffusionCoefficientsProps [Examples:] -chemistryModels +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:] diff --git a/doc/chemistryModel_massTransferCoeff.txt b/doc/chemistryModel_massTransferCoeff.txt index 92c118c6..96f1c54b 100644 --- a/doc/chemistryModel_massTransferCoeff.txt +++ b/doc/chemistryModel_massTransferCoeff.txt @@ -16,23 +16,23 @@ chemistryModels ( massTransferCoeff ); -diffusionCoefficientsProps +massTransferCoeffProps \{ - verbose switch1; -\}; :pre + verbose switch1; +\} :pre {switch1} = (optional, normally off) flag to give information :l :ule [Examples:] -chemistryModels +chemistryModels ( massTransferCoeff ); massTransferCoeffProps \{ - verbose false; + verbose false; \} :pre [Description:] diff --git a/doc/chemistryModel_species.txt b/doc/chemistryModel_species.txt index 2c25111a..9c48ca0e 100644 --- a/doc/chemistryModel_species.txt +++ b/doc/chemistryModel_species.txt @@ -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 @@ -40,14 +40,14 @@ speciesProps [Examples:] -chemistryModels +chemistryModels ( species ); speciesProps \{ - ChemistryFile "$casePath/CFD/constant/foam.inp"; - verbose false; + ChemistryFile "$casePath/CFD/constant/foam.inp"; + verbose false; \} :pre [Description:] diff --git a/doc/dataExchangeModel_oneWayVTK.txt b/doc/dataExchangeModel_oneWayVTK.txt index 4b75bfc4..21c8b382 100644 --- a/doc/dataExchangeModel_oneWayVTK.txt +++ b/doc/dataExchangeModel_oneWayVTK.txt @@ -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:] diff --git a/doc/dataExchangeModel_twoWayFiles.txt b/doc/dataExchangeModel_twoWayFiles.txt index 9387e401..7bc53f37 100644 --- a/doc/dataExchangeModel_twoWayFiles.txt +++ b/doc/dataExchangeModel_twoWayFiles.txt @@ -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:] diff --git a/doc/dataExchangeModel_twoWayMPI.txt b/doc/dataExchangeModel_twoWayMPI.txt index 9dadc820..0f847d57 100644 --- a/doc/dataExchangeModel_twoWayMPI.txt +++ b/doc/dataExchangeModel_twoWayMPI.txt @@ -16,7 +16,7 @@ dataExchangeModel twoWayMPI; twoWayMPIProps \{ liggghtsPath "path"; -\}; :pre +\} :pre {path} = path to the DEM simulation input file :ulb,l :ule diff --git a/doc/dataExchangeModel_twoWayMany2Many.txt b/doc/dataExchangeModel_twoWayMany2Many.txt index fd4323b8..155121c5 100644 --- a/doc/dataExchangeModel_twoWayMany2Many.txt +++ b/doc/dataExchangeModel_twoWayMany2Many.txt @@ -16,7 +16,7 @@ dataExchangeModel twoWayMany2Many; twoWayMany2ManyProps \{ liggghtsPath "path"; -\}; :pre +\} :pre {path} = path to the DEM simulation input file :ulb,l :ule diff --git a/doc/forceModel_Archimedes.txt b/doc/forceModel_Archimedes.txt index eb9a5a2f..a3ffceda 100644 --- a/doc/forceModel_Archimedes.txt +++ b/doc/forceModel_Archimedes.txt @@ -19,7 +19,7 @@ forceModels ArchimedesProps \{ gravityFieldName "gravity"; -\}; :pre +\} :pre {gravity} = name of the finite volume gravity field :ulb,l :ule diff --git a/doc/forceModel_ArchimedesIB.txt b/doc/forceModel_ArchimedesIB.txt index efa194bb..a72477e6 100644 --- a/doc/forceModel_ArchimedesIB.txt +++ b/doc/forceModel_ArchimedesIB.txt @@ -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:] diff --git a/doc/forceModel_DiFeliceDrag.txt b/doc/forceModel_DiFeliceDrag.txt index 6a7e353d..7b874d7a 100644 --- a/doc/forceModel_DiFeliceDrag.txt +++ b/doc/forceModel_DiFeliceDrag.txt @@ -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 diff --git a/doc/forceModel_GidaspowDrag.txt b/doc/forceModel_GidaspowDrag.txt index 0d24035d..5e036791 100644 --- a/doc/forceModel_GidaspowDrag.txt +++ b/doc/forceModel_GidaspowDrag.txt @@ -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:] diff --git a/doc/forceModel_KochHillDrag.txt b/doc/forceModel_KochHillDrag.txt index d24b878b..2d05c4dd 100644 --- a/doc/forceModel_KochHillDrag.txt +++ b/doc/forceModel_KochHillDrag.txt @@ -18,16 +18,16 @@ forceModels ); KochHillDragProps \{ - velFieldName "U"; - voidfractionFieldName "voidfraction"; - interpolation "bool1"; - implForceDEM "bool2"; -\}; :pre + velFieldName "U"; + voidfractionFieldName "voidfraction"; + 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:] @@ -39,7 +39,7 @@ forceModels KochHillDragProps \{ velFieldName "U"; - voidfractionFieldName "voidfraction"; + voidfractionFieldName "voidfraction"; \} :pre [Description:] diff --git a/doc/forceModel_LaEuScalarTemp.txt b/doc/forceModel_LaEuScalarTemp.txt index e4a8c730..89cbf2cc 100644 --- a/doc/forceModel_LaEuScalarTemp.txt +++ b/doc/forceModel_LaEuScalarTemp.txt @@ -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:] diff --git a/doc/forceModel_MeiLift.txt b/doc/forceModel_MeiLift.txt index f423da1e..380263bb 100644 --- a/doc/forceModel_MeiLift.txt +++ b/doc/forceModel_MeiLift.txt @@ -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:] diff --git a/doc/forceModel_SchillerNaumannDrag.txt b/doc/forceModel_SchillerNaumannDrag.txt index 1a52456e..0950da69 100644 --- a/doc/forceModel_SchillerNaumannDrag.txt +++ b/doc/forceModel_SchillerNaumannDrag.txt @@ -19,7 +19,7 @@ forceModels SchillerNaumannDragProps \{ velFieldName "U"; -\}; :pre +\} :pre {U} = name of the finite volume fluid velocity field :ulb,l :ule diff --git a/doc/forceModel_ShirgaonkarIB.txt b/doc/forceModel_ShirgaonkarIB.txt index 3378babb..42ddcb7b 100644 --- a/doc/forceModel_ShirgaonkarIB.txt +++ b/doc/forceModel_ShirgaonkarIB.txt @@ -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 diff --git a/doc/forceModel_dSauter.txt b/doc/forceModel_dSauter.txt index 1d7669bd..d565ee2a 100644 --- a/doc/forceModel_dSauter.txt +++ b/doc/forceModel_dSauter.txt @@ -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:] diff --git a/doc/forceModel_fieldStore.txt b/doc/forceModel_fieldStore.txt index d9ada63a..479f5ea5 100644 --- a/doc/forceModel_fieldStore.txt +++ b/doc/forceModel_fieldStore.txt @@ -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 diff --git a/doc/forceModel_gradPForce.txt b/doc/forceModel_gradPForce.txt index 7c38dccf..bd22dcd1 100644 --- a/doc/forceModel_gradPForce.txt +++ b/doc/forceModel_gradPForce.txt @@ -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:] diff --git a/doc/forceModel_noDrag.txt b/doc/forceModel_noDrag.txt index dde3e521..6b2190fe 100644 --- a/doc/forceModel_noDrag.txt +++ b/doc/forceModel_noDrag.txt @@ -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:] diff --git a/doc/forceModel_particleCellVolume.txt b/doc/forceModel_particleCellVolume.txt index e444726b..878d4c9f 100644 --- a/doc/forceModel_particleCellVolume.txt +++ b/doc/forceModel_particleCellVolume.txt @@ -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 diff --git a/doc/forceModel_pdCorrelation.txt b/doc/forceModel_pdCorrelation.txt index ccd581fa..d46b54fd 100644 --- a/doc/forceModel_pdCorrelation.txt +++ b/doc/forceModel_pdCorrelation.txt @@ -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 diff --git a/doc/forceModel_virtualMassForce.txt b/doc/forceModel_virtualMassForce.txt index 8de1f198..ae27acc3 100644 --- a/doc/forceModel_virtualMassForce.txt +++ b/doc/forceModel_virtualMassForce.txt @@ -19,7 +19,7 @@ forceModels virtualMassForceProps \{ velFieldName "U"; -\}; :pre +\} :pre {U} = name of the finite volume fluid velocity field :ulb,l :ule diff --git a/doc/forceModel_viscForce.txt b/doc/forceModel_viscForce.txt index e0b26ded..d6dcfba7 100644 --- a/doc/forceModel_viscForce.txt +++ b/doc/forceModel_viscForce.txt @@ -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 diff --git a/doc/forceSubModel_ImEx.txt b/doc/forceSubModel_ImEx.txt index ae28a469..46bb6c21 100644 --- a/doc/forceSubModel_ImEx.txt +++ b/doc/forceSubModel_ImEx.txt @@ -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:] diff --git a/doc/forceSubModel_ImExCorr.txt b/doc/forceSubModel_ImExCorr.txt index 9418960a..4e223358 100644 --- a/doc/forceSubModel_ImExCorr.txt +++ b/doc/forceSubModel_ImExCorr.txt @@ -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:] diff --git a/doc/liggghtsCommandModel_execute.txt b/doc/liggghtsCommandModel_execute.txt index 9e06f0a6..993f541d 100644 --- a/doc/liggghtsCommandModel_execute.txt +++ b/doc/liggghtsCommandModel_execute.txt @@ -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:] diff --git a/doc/liggghtsCommandModel_readLiggghtsData.txt b/doc/liggghtsCommandModel_readLiggghtsData.txt index 33ab9300..4adc1e1d 100644 --- a/doc/liggghtsCommandModel_readLiggghtsData.txt +++ b/doc/liggghtsCommandModel_readLiggghtsData.txt @@ -27,7 +27,6 @@ readLiggghtsDataProps0 liggghtsCommandModels ( readLiggghtsData - readLiggghtsData ); readLiggghtsDataProps0 \{ diff --git a/doc/locateModel_engineSearchIB.txt b/doc/locateModel_engineSearchIB.txt index acf540da..c426e576 100644 --- a/doc/locateModel_engineSearchIB.txt +++ b/doc/locateModel_engineSearchIB.txt @@ -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 diff --git a/doc/momCoupleModel_implicitCouple.txt b/doc/momCoupleModel_implicitCouple.txt index 67751937..4e2bd997 100644 --- a/doc/momCoupleModel_implicitCouple.txt +++ b/doc/momCoupleModel_implicitCouple.txt @@ -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 diff --git a/doc/probeModel.txt b/doc/probeModel.txt index 02a29b4b..0bd9ef39 100644 --- a/doc/probeModel.txt +++ b/doc/probeModel.txt @@ -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. diff --git a/doc/probeModel_noProbe.txt b/doc/probeModel_noProbe.txt index f77f66df..62c44b19 100644 --- a/doc/probeModel_noProbe.txt +++ b/doc/probeModel_noProbe.txt @@ -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:] diff --git a/doc/smoothingModel.txt b/doc/smoothingModel.txt index dcc6c8fc..5d9d98ca 100644 --- a/doc/smoothingModel.txt +++ b/doc/smoothingModel.txt @@ -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. diff --git a/doc/smoothingModel_constDiffSmoothing.txt b/doc/smoothingModel_constDiffSmoothing.txt index e1855973..0c19bdbe 100644 --- a/doc/smoothingModel_constDiffSmoothing.txt +++ b/doc/smoothingModel_constDiffSmoothing.txt @@ -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 diff --git a/doc/voidFractionModel_GaussVoidFraction.txt b/doc/voidFractionModel_GaussVoidFraction.txt index 48dd029d..5f8ac5d9 100644 --- a/doc/voidFractionModel_GaussVoidFraction.txt +++ b/doc/voidFractionModel_GaussVoidFraction.txt @@ -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:] diff --git a/doc/voidFractionModel_IBVoidFraction.txt b/doc/voidFractionModel_IBVoidFraction.txt index c7cbce63..b72bbe2d 100644 --- a/doc/voidFractionModel_IBVoidFraction.txt +++ b/doc/voidFractionModel_IBVoidFraction.txt @@ -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:] diff --git a/doc/voidFractionModel_bigParticleVoidFraction.txt b/doc/voidFractionModel_bigParticleVoidFraction.txt index 62927931..7f0a2caf 100644 --- a/doc/voidFractionModel_bigParticleVoidFraction.txt +++ b/doc/voidFractionModel_bigParticleVoidFraction.txt @@ -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:] diff --git a/doc/voidFractionModel_centreVoidFraction.txt b/doc/voidFractionModel_centreVoidFraction.txt index 12843df4..7fe59820 100644 --- a/doc/voidFractionModel_centreVoidFraction.txt +++ b/doc/voidFractionModel_centreVoidFraction.txt @@ -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:] diff --git a/doc/voidFractionModel_dividedVoidFraction.txt b/doc/voidFractionModel_dividedVoidFraction.txt index c3903761..e769600e 100644 --- a/doc/voidFractionModel_dividedVoidFraction.txt +++ b/doc/voidFractionModel_dividedVoidFraction.txt @@ -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