From 26d30e122d10ecf19d551b5d89427c594bddc21d Mon Sep 17 00:00:00 2001 From: danielque Date: Wed, 18 Jul 2018 14:08:26 +0200 Subject: [PATCH] [DOC] add cross-linking --- doc/IOModel.txt | 7 +++++-- doc/IOModel_basicIO.txt | 3 ++- doc/IOModel_noIO.txt | 3 ++- doc/IOModel_sophIO.txt | 5 +++-- doc/IOModel_trackIO.txt | 5 +++-- doc/averagingModel.txt | 3 ++- doc/averagingModel_dense.txt | 3 ++- doc/averagingModel_dilute.txt | 3 ++- doc/chemistryModel.txt | 7 +++++-- doc/chemistryModel_diffusionCoefficients.txt | 6 ++++-- doc/chemistryModel_massTransferCoeff.txt | 8 +++++--- doc/chemistryModel_species.txt | 3 ++- doc/clockModel.txt | 3 ++- doc/clockModel_noClock.txt | 3 ++- doc/clockModel_standardClock.txt | 3 ++- doc/dataExchangeModel.txt | 8 ++++++-- doc/dataExchangeModel_noDataExchange.txt | 3 ++- doc/dataExchangeModel_oneWayVTK.txt | 3 ++- doc/dataExchangeModel_twoWayFiles.txt | 3 ++- doc/dataExchangeModel_twoWayMPI.txt | 3 ++- doc/dataExchangeModel_twoWayMany2Many.txt | 6 ++++-- doc/forceModel.txt | 7 +++++-- doc/forceModel_Archimedes.txt | 3 ++- doc/forceModel_ArchimedesIB.txt | 3 ++- doc/forceModel_DiFeliceDrag.txt | 3 ++- doc/forceModel_GidaspowDrag.txt | 3 ++- doc/forceModel_KochHillDrag.txt | 3 ++- doc/forceModel_LaEuScalarTemp.txt | 3 ++- doc/forceModel_MeiLift.txt | 3 ++- doc/forceModel_SchillerNaumannDrag.txt | 3 ++- doc/forceModel_ShirgaonkarIB.txt | 3 ++- doc/forceModel_dSauter.txt | 3 ++- doc/forceModel_fieldStore.txt | 3 ++- doc/forceModel_gradPForce.txt | 3 ++- doc/forceModel_noDrag.txt | 3 ++- doc/forceModel_particleCellVolume.txt | 3 ++- doc/forceModel_pdCorrelation.txt | 6 ++++-- doc/forceModel_virtualMassForce.txt | 3 ++- doc/forceModel_viscForce.txt | 3 ++- doc/forceSubModel_ImEx.txt | 3 ++- doc/forceSubModel_ImExCorr.txt | 3 ++- doc/liggghtsCommandModel.txt | 3 ++- doc/liggghtsCommandModel_execute.txt | 3 ++- doc/liggghtsCommandModel_readLiggghtsData.txt | 3 ++- doc/liggghtsCommandModel_runLiggghts.txt | 3 ++- doc/liggghtsCommandModel_writeLiggghts.txt | 3 ++- doc/locateModel.txt | 3 ++- doc/locateModel_engineSearch.txt | 3 ++- doc/locateModel_engineSearchIB.txt | 3 ++- doc/locateModel_engineSearchMany2Many.txt | 3 ++- doc/locateModel_standardSearch.txt | 3 ++- doc/locateModel_turboEngineSearch.txt | 3 ++- doc/meshMotionModel.txt | 3 ++- doc/meshMotionModel_noMeshMotion.txt | 3 ++- doc/momCoupleModel.txt | 3 ++- doc/momCoupleModel_explicitCouple.txt | 3 ++- doc/momCoupleModel_implicitCouple.txt | 3 ++- doc/momCoupleModel_noCouple.txt | 3 ++- doc/probeModel.txt | 5 +++++ doc/probeModel_noProbe.txt | 3 ++- doc/regionModel.txt | 7 +++++-- doc/regionModel_allRegion.txt | 5 ++++- doc/smoothingModel.txt | 3 ++- doc/smoothingModel_constDiffSmoothing.txt | 3 ++- doc/smoothingModel_noSmoothing.txt | 3 ++- doc/voidFractionModel.txt | 3 ++- doc/voidFractionModel_GaussVoidFraction.txt | 3 ++- doc/voidFractionModel_IBVoidFraction.txt | 3 ++- doc/voidFractionModel_bigParticleVoidFraction.txt | 3 ++- doc/voidFractionModel_centreVoidFraction.txt | 3 ++- doc/voidFractionModel_dividedVoidFraction.txt | 3 ++- 71 files changed, 174 insertions(+), 82 deletions(-) diff --git a/doc/IOModel.txt b/doc/IOModel.txt index a5815f21..9e9ea7ce 100644 --- a/doc/IOModel.txt +++ b/doc/IOModel.txt @@ -9,7 +9,8 @@ IOModel command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. IOModel "model"; :pre @@ -31,6 +32,8 @@ none. [Related commands:] -Note: This examples list may be incomplete - please look for other models (IOModel_XY) in this documentation. +"IOModel basicIO"_IOModel_basicIO.html, "IOModel off"_IOModel_noIO.html, +"IOModel sophIO"_IOModel_sophIO.html, "IOModel trackIO"_IOModel_trackIO.html + [Default:] none. diff --git a/doc/IOModel_basicIO.txt b/doc/IOModel_basicIO.txt index 2f71d38b..039f15c0 100644 --- a/doc/IOModel_basicIO.txt +++ b/doc/IOModel_basicIO.txt @@ -9,7 +9,8 @@ IOModel basicIO command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. IOModel "basicIO"; :pre diff --git a/doc/IOModel_noIO.txt b/doc/IOModel_noIO.txt index a19bc274..9efd00b8 100644 --- a/doc/IOModel_noIO.txt +++ b/doc/IOModel_noIO.txt @@ -9,7 +9,8 @@ IOModel off command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. IOModel "off"; :pre diff --git a/doc/IOModel_sophIO.txt b/doc/IOModel_sophIO.txt index 49b718d9..fc5e5bec 100644 --- a/doc/IOModel_sophIO.txt +++ b/doc/IOModel_sophIO.txt @@ -9,7 +9,8 @@ IOModel sophIO command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. IOModel "sophIO"; :pre @@ -25,5 +26,5 @@ The sophIO-model is based on basicIO model and additionally writes voidfraction, [Related commands:] -"IOModel"_IOModel.html +"IOModel"_IOModel.html, "IOModel basicIO"_IOModel_basicIO.html diff --git a/doc/IOModel_trackIO.txt b/doc/IOModel_trackIO.txt index 474ac414..946d3f34 100644 --- a/doc/IOModel_trackIO.txt +++ b/doc/IOModel_trackIO.txt @@ -9,7 +9,8 @@ IOModel trackIO command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. IOModel "trackIO"; :pre @@ -25,5 +26,5 @@ The trackIO-model is based on sophIO model and additionally writes fields necess [Related commands:] -"IOModel"_IOModel.html +"IOModel"_IOModel.html, "IOModel sophIO"_IOModel_sophIO.html diff --git a/doc/averagingModel.txt b/doc/averagingModel.txt index 56b98f97..5e9f6ddf 100644 --- a/doc/averagingModel.txt +++ b/doc/averagingModel.txt @@ -9,7 +9,8 @@ averagingModel command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. averagingModel model; :pre diff --git a/doc/averagingModel_dense.txt b/doc/averagingModel_dense.txt index 4bde4180..5dcd41f8 100644 --- a/doc/averagingModel_dense.txt +++ b/doc/averagingModel_dense.txt @@ -9,7 +9,8 @@ averagingModel dense command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. averagingModel dense; :pre diff --git a/doc/averagingModel_dilute.txt b/doc/averagingModel_dilute.txt index 0e293967..54dab770 100644 --- a/doc/averagingModel_dilute.txt +++ b/doc/averagingModel_dilute.txt @@ -9,7 +9,8 @@ averagingModel dilute command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. averagingModel dilute; :pre diff --git a/doc/chemistryModel.txt b/doc/chemistryModel.txt index d0b686d4..1f535a94 100644 --- a/doc/chemistryModel.txt +++ b/doc/chemistryModel.txt @@ -9,7 +9,8 @@ chemistryModel command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. chemistryModels ( @@ -38,6 +39,8 @@ None. [Related commands:] -"species"_chemistryModel_species.html, "diffusionCoefficient"_chemistryModel_diffusionCoefficients.html, "massTransferCoeff"_chemistryModel_massTransferCoeff.html +"diffusionCoefficient"_chemistryModel_diffusionCoefficients.html, +"massTransferCoeff"_chemistryModel_massTransferCoeff.html, +"species"_chemistryModel_species.html [Default:] none. diff --git a/doc/chemistryModel_diffusionCoefficients.txt b/doc/chemistryModel_diffusionCoefficients.txt index 7c107706..0fca99a9 100644 --- a/doc/chemistryModel_diffusionCoefficients.txt +++ b/doc/chemistryModel_diffusionCoefficients.txt @@ -9,7 +9,8 @@ chemistryModel diffusionCoefficients command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. chemistryModels ( @@ -52,5 +53,6 @@ Species model needs to be active. [Related commands:] -"chemistryModel"_chemistryModel.html +"chemistryModel"_chemistryModel.html, +"chemistryModel species"_chemistryModel_species.html diff --git a/doc/chemistryModel_massTransferCoeff.txt b/doc/chemistryModel_massTransferCoeff.txt index cd57a5a5..92c118c6 100644 --- a/doc/chemistryModel_massTransferCoeff.txt +++ b/doc/chemistryModel_massTransferCoeff.txt @@ -9,7 +9,8 @@ chemistryModel massTransferCoeff command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. chemistryModels ( @@ -40,9 +41,10 @@ The chemistry model performs the calculation of chemical reactional effects acti [Restrictions:] -Species model needs to be active. +The "species"_chemistryModel_species.html model needs to be active. [Related commands:] -"chemistryModel"_chemistryModel.html +"chemistryModel"_chemistryModel.html, +"chemistryModel species"_chemistryModel_species.html diff --git a/doc/chemistryModel_species.txt b/doc/chemistryModel_species.txt index bf58240d..2c25111a 100644 --- a/doc/chemistryModel_species.txt +++ b/doc/chemistryModel_species.txt @@ -9,7 +9,8 @@ chemistryModel species command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. chemistryModels ( diff --git a/doc/clockModel.txt b/doc/clockModel.txt index 60c92988..642a2c98 100644 --- a/doc/clockModel.txt +++ b/doc/clockModel.txt @@ -9,7 +9,8 @@ clockModel command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. clockModel model; :pre diff --git a/doc/clockModel_noClock.txt b/doc/clockModel_noClock.txt index fb9ab97e..97088e16 100644 --- a/doc/clockModel_noClock.txt +++ b/doc/clockModel_noClock.txt @@ -9,7 +9,8 @@ clockModel off command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. clockModel off; :pre diff --git a/doc/clockModel_standardClock.txt b/doc/clockModel_standardClock.txt index a2d0b458..2f483248 100644 --- a/doc/clockModel_standardClock.txt +++ b/doc/clockModel_standardClock.txt @@ -9,7 +9,8 @@ clockModel standardClock command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. clockModel standardClock; :pre diff --git a/doc/dataExchangeModel.txt b/doc/dataExchangeModel.txt index 5d0be12e..59d13adb 100644 --- a/doc/dataExchangeModel.txt +++ b/doc/dataExchangeModel.txt @@ -9,7 +9,8 @@ dataExchangeModel command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. dataExchangeModel model; :pre @@ -32,6 +33,9 @@ None. [Related commands:] -"noDataExchange"_dataExchangeModel_noDataExchange.html, "oneWayVTK"_dataExchangeModel_oneWayVTK.html, "twoWayFiles"_dataExchangeModel_twoWayFiles.html, "twoWayMPI"_dataExchangeModel_twoWayMPI.html +"noDataExchange"_dataExchangeModel_noDataExchange.html, +"oneWayVTK"_dataExchangeModel_oneWayVTK.html, +"twoWayFiles"_dataExchangeModel_twoWayFiles.html, +"twoWayMPI"_dataExchangeModel_twoWayMPI.html [Default:] none diff --git a/doc/dataExchangeModel_noDataExchange.txt b/doc/dataExchangeModel_noDataExchange.txt index b4788b1b..0e2a0ac4 100644 --- a/doc/dataExchangeModel_noDataExchange.txt +++ b/doc/dataExchangeModel_noDataExchange.txt @@ -9,7 +9,8 @@ dataExchangeModel noDataExchange command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. dataExchangeModel noDataExchange; :pre diff --git a/doc/dataExchangeModel_oneWayVTK.txt b/doc/dataExchangeModel_oneWayVTK.txt index b1e53308..4b75bfc4 100644 --- a/doc/dataExchangeModel_oneWayVTK.txt +++ b/doc/dataExchangeModel_oneWayVTK.txt @@ -9,7 +9,8 @@ dataExchangeModel oneWayVTK command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. dataExchangeModel oneWayVTK; oneWayVTKProps diff --git a/doc/dataExchangeModel_twoWayFiles.txt b/doc/dataExchangeModel_twoWayFiles.txt index b343b0ae..9387e401 100644 --- a/doc/dataExchangeModel_twoWayFiles.txt +++ b/doc/dataExchangeModel_twoWayFiles.txt @@ -9,7 +9,8 @@ dataExchangeModel twoWayFiles command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. dataExchangeModel twoWayFiles; twoWayFilesProps diff --git a/doc/dataExchangeModel_twoWayMPI.txt b/doc/dataExchangeModel_twoWayMPI.txt index cc9383f0..9dadc820 100644 --- a/doc/dataExchangeModel_twoWayMPI.txt +++ b/doc/dataExchangeModel_twoWayMPI.txt @@ -9,7 +9,8 @@ dataExchangeModel twoWayMPI command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. dataExchangeModel twoWayMPI; twoWayMPIProps diff --git a/doc/dataExchangeModel_twoWayMany2Many.txt b/doc/dataExchangeModel_twoWayMany2Many.txt index 85bacc73..fd4323b8 100644 --- a/doc/dataExchangeModel_twoWayMany2Many.txt +++ b/doc/dataExchangeModel_twoWayMany2Many.txt @@ -9,7 +9,8 @@ dataExchangeModel twoWayMany2Many command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. dataExchangeModel twoWayMany2Many; twoWayMany2ManyProps @@ -34,7 +35,8 @@ The data exchange model performs the data exchange between the DEM code and the [Restrictions:] -Must be used in combination with the engineSearchMany2Many locate model! +Must be used in combination with the +"engineSearchMany2Many"_locateModel_engineSearchMany2Many.html locate model! [Related commands:] diff --git a/doc/forceModel.txt b/doc/forceModel.txt index 611c9a65..f267c05a 100644 --- a/doc/forceModel.txt +++ b/doc/forceModel.txt @@ -9,7 +9,8 @@ forceModel command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. forceModels ( @@ -38,6 +39,8 @@ None. [Related commands:] -"Archimedes"_forceModel_Archimedes.html, "DiFeliceDrag"_forceModel_DiFeliceDrag.html, "gradPForce"_forceModel_gradPForce.html, "viscForce"_forceModel_viscForce.html,"dSauter"_forceModel_dSauter.html +"Archimedes"_forceModel_Archimedes.html, "DiFeliceDrag"_forceModel_DiFeliceDrag.html, +"gradPForce"_forceModel_gradPForce.html, "viscForce"_forceModel_viscForce.html, +"dSauter"_forceModel_dSauter.html [Default:] none. diff --git a/doc/forceModel_Archimedes.txt b/doc/forceModel_Archimedes.txt index dce1a5fa..eb9a5a2f 100644 --- a/doc/forceModel_Archimedes.txt +++ b/doc/forceModel_Archimedes.txt @@ -9,7 +9,8 @@ forceModel Archimedes command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. forceModels ( diff --git a/doc/forceModel_ArchimedesIB.txt b/doc/forceModel_ArchimedesIB.txt index 8614b74a..efa194bb 100644 --- a/doc/forceModel_ArchimedesIB.txt +++ b/doc/forceModel_ArchimedesIB.txt @@ -9,7 +9,8 @@ forceModel ArchimedesIB command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. forceModels ( diff --git a/doc/forceModel_DiFeliceDrag.txt b/doc/forceModel_DiFeliceDrag.txt index 16a916d4..6a7e353d 100644 --- a/doc/forceModel_DiFeliceDrag.txt +++ b/doc/forceModel_DiFeliceDrag.txt @@ -9,7 +9,8 @@ forceModel DiFeliceDrag command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. forceModels ( diff --git a/doc/forceModel_GidaspowDrag.txt b/doc/forceModel_GidaspowDrag.txt index 1f1422d6..0d24035d 100644 --- a/doc/forceModel_GidaspowDrag.txt +++ b/doc/forceModel_GidaspowDrag.txt @@ -9,7 +9,8 @@ forceModel GidaspowDrag command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. forceModels ( diff --git a/doc/forceModel_KochHillDrag.txt b/doc/forceModel_KochHillDrag.txt index c44ee8c6..d24b878b 100644 --- a/doc/forceModel_KochHillDrag.txt +++ b/doc/forceModel_KochHillDrag.txt @@ -9,7 +9,8 @@ forceModel KochHillDrag command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. forceModels ( diff --git a/doc/forceModel_LaEuScalarTemp.txt b/doc/forceModel_LaEuScalarTemp.txt index ff87cbfe..e4a8c730 100644 --- a/doc/forceModel_LaEuScalarTemp.txt +++ b/doc/forceModel_LaEuScalarTemp.txt @@ -9,7 +9,8 @@ forceModel LaEuScalarTemp command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. forceModels ( diff --git a/doc/forceModel_MeiLift.txt b/doc/forceModel_MeiLift.txt index 3a84ece4..f423da1e 100644 --- a/doc/forceModel_MeiLift.txt +++ b/doc/forceModel_MeiLift.txt @@ -9,7 +9,8 @@ forceModel MeiLift command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. forceModels ( diff --git a/doc/forceModel_SchillerNaumannDrag.txt b/doc/forceModel_SchillerNaumannDrag.txt index c7dc1c25..1a52456e 100644 --- a/doc/forceModel_SchillerNaumannDrag.txt +++ b/doc/forceModel_SchillerNaumannDrag.txt @@ -9,7 +9,8 @@ forceModel SchillerNaumannDrag command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. forceModels ( diff --git a/doc/forceModel_ShirgaonkarIB.txt b/doc/forceModel_ShirgaonkarIB.txt index 0e9a9c8e..3378babb 100644 --- a/doc/forceModel_ShirgaonkarIB.txt +++ b/doc/forceModel_ShirgaonkarIB.txt @@ -9,7 +9,8 @@ forceModel ShirgaonkarIB command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. forceModels ( diff --git a/doc/forceModel_dSauter.txt b/doc/forceModel_dSauter.txt index 2fa23889..1d7669bd 100644 --- a/doc/forceModel_dSauter.txt +++ b/doc/forceModel_dSauter.txt @@ -9,7 +9,8 @@ forceModel dSauter command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. forceModels ( diff --git a/doc/forceModel_fieldStore.txt b/doc/forceModel_fieldStore.txt index 4911d3a7..d9ada63a 100644 --- a/doc/forceModel_fieldStore.txt +++ b/doc/forceModel_fieldStore.txt @@ -9,7 +9,8 @@ forceModel fieldStore command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. forceModels ( diff --git a/doc/forceModel_gradPForce.txt b/doc/forceModel_gradPForce.txt index adc7254e..7c38dccf 100644 --- a/doc/forceModel_gradPForce.txt +++ b/doc/forceModel_gradPForce.txt @@ -9,7 +9,8 @@ forceModel gradPForce command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. forceModels ( diff --git a/doc/forceModel_noDrag.txt b/doc/forceModel_noDrag.txt index 520f0498..dde3e521 100644 --- a/doc/forceModel_noDrag.txt +++ b/doc/forceModel_noDrag.txt @@ -9,7 +9,8 @@ forceModel noDrag command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. forceModels ( diff --git a/doc/forceModel_particleCellVolume.txt b/doc/forceModel_particleCellVolume.txt index bf2847b6..e444726b 100644 --- a/doc/forceModel_particleCellVolume.txt +++ b/doc/forceModel_particleCellVolume.txt @@ -9,7 +9,8 @@ forceModel particleCellVolume command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. forceModels ( diff --git a/doc/forceModel_pdCorrelation.txt b/doc/forceModel_pdCorrelation.txt index ccc29daf..ccd581fa 100644 --- a/doc/forceModel_pdCorrelation.txt +++ b/doc/forceModel_pdCorrelation.txt @@ -9,7 +9,8 @@ forceModel pdCorrelation :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. forceModels ( @@ -50,4 +51,5 @@ none. [Related commands:] -"forceModel"_forceModel.html \ No newline at end of file +"forceModel"_forceModel.html + diff --git a/doc/forceModel_virtualMassForce.txt b/doc/forceModel_virtualMassForce.txt index 6992feeb..8de1f198 100644 --- a/doc/forceModel_virtualMassForce.txt +++ b/doc/forceModel_virtualMassForce.txt @@ -9,7 +9,8 @@ forceModel virtualMassForce command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. forceModels ( diff --git a/doc/forceModel_viscForce.txt b/doc/forceModel_viscForce.txt index 7fb313d9..e0b26ded 100644 --- a/doc/forceModel_viscForce.txt +++ b/doc/forceModel_viscForce.txt @@ -9,7 +9,8 @@ forceModel viscForce command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. forceModels ( diff --git a/doc/forceSubModel_ImEx.txt b/doc/forceSubModel_ImEx.txt index cba23ba1..ae28a469 100644 --- a/doc/forceSubModel_ImEx.txt +++ b/doc/forceSubModel_ImEx.txt @@ -9,7 +9,8 @@ forceSubModel ImEx command :h3 [Syntax:] -Defined in couplingProperties sub-dictionary of the force model in use. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +sub-dictionary of the force model in use. forceSubModels ( diff --git a/doc/forceSubModel_ImExCorr.txt b/doc/forceSubModel_ImExCorr.txt index 429c5620..9418960a 100644 --- a/doc/forceSubModel_ImExCorr.txt +++ b/doc/forceSubModel_ImExCorr.txt @@ -9,7 +9,8 @@ forceSubModel ImExCorr command :h3 [Syntax:] -Defined in couplingProperties sub-dictionary of the force model in use. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +sub-dictionary of the force model in use. forceSubModels ( diff --git a/doc/liggghtsCommandModel.txt b/doc/liggghtsCommandModel.txt index bcf23504..15dbe72b 100644 --- a/doc/liggghtsCommandModel.txt +++ b/doc/liggghtsCommandModel.txt @@ -9,7 +9,8 @@ liggghtsCommandModel command :h3 [Syntax:] -Defined in liggghtsCommmands dictionary. +Defined in "liggghtsCommmands"_CFDEMcoupling_dicts.html#liggghtsCommands +dictionary. liggghtsCommandModels ( diff --git a/doc/liggghtsCommandModel_execute.txt b/doc/liggghtsCommandModel_execute.txt index 93e94124..9e06f0a6 100644 --- a/doc/liggghtsCommandModel_execute.txt +++ b/doc/liggghtsCommandModel_execute.txt @@ -9,7 +9,8 @@ liggghtsCommandModel execute command :h3 [Syntax:] -Defined in liggghtsCommmands dictionary. +Defined in "liggghtsCommmands"_CFDEMcoupling_dicts.html#liggghtsCommands +dictionary. liggghtsCommandModels ( diff --git a/doc/liggghtsCommandModel_readLiggghtsData.txt b/doc/liggghtsCommandModel_readLiggghtsData.txt index 0f6caf17..33ab9300 100644 --- a/doc/liggghtsCommandModel_readLiggghtsData.txt +++ b/doc/liggghtsCommandModel_readLiggghtsData.txt @@ -9,7 +9,8 @@ liggghtsCommandModel readLiggghtsData command :h3 [Syntax:] -Defined in liggghtsCommmands dictionary. +Defined in "liggghtsCommmands"_CFDEMcoupling_dicts.html#liggghtsCommands +dictionary. liggghtsCommandModels ( diff --git a/doc/liggghtsCommandModel_runLiggghts.txt b/doc/liggghtsCommandModel_runLiggghts.txt index bf3f6e54..1b438d9e 100644 --- a/doc/liggghtsCommandModel_runLiggghts.txt +++ b/doc/liggghtsCommandModel_runLiggghts.txt @@ -9,7 +9,8 @@ liggghtsCommandModel runLiggghts command :h3 [Syntax:] -Defined in liggghtsCommmands dictionary. +Defined in "liggghtsCommmands"_CFDEMcoupling_dicts.html#liggghtsCommands +dictionary. liggghtsCommandModels ( diff --git a/doc/liggghtsCommandModel_writeLiggghts.txt b/doc/liggghtsCommandModel_writeLiggghts.txt index d1f0b24b..84ec10dc 100644 --- a/doc/liggghtsCommandModel_writeLiggghts.txt +++ b/doc/liggghtsCommandModel_writeLiggghts.txt @@ -9,7 +9,8 @@ liggghtsCommandModel writeLiggghts command :h3 [Syntax:] -Defined in liggghtsCommmands dictionary. +Defined in "liggghtsCommmands"_CFDEMcoupling_dicts.html#liggghtsCommands +dictionary. liggghtsCommandModels ( diff --git a/doc/locateModel.txt b/doc/locateModel.txt index 604c0722..46d5a1f2 100644 --- a/doc/locateModel.txt +++ b/doc/locateModel.txt @@ -9,7 +9,8 @@ locateModel command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. locateModel model; :pre diff --git a/doc/locateModel_engineSearch.txt b/doc/locateModel_engineSearch.txt index 376ea8e3..993bf121 100644 --- a/doc/locateModel_engineSearch.txt +++ b/doc/locateModel_engineSearch.txt @@ -9,7 +9,8 @@ locateModel engine command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. locateModel engine; engineProps diff --git a/doc/locateModel_engineSearchIB.txt b/doc/locateModel_engineSearchIB.txt index 6d29f768..acf540da 100644 --- a/doc/locateModel_engineSearchIB.txt +++ b/doc/locateModel_engineSearchIB.txt @@ -9,7 +9,8 @@ locateModel engineIB command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. locateModel engineIB; engineIBProps diff --git a/doc/locateModel_engineSearchMany2Many.txt b/doc/locateModel_engineSearchMany2Many.txt index e8948ce8..4456656c 100644 --- a/doc/locateModel_engineSearchMany2Many.txt +++ b/doc/locateModel_engineSearchMany2Many.txt @@ -9,7 +9,8 @@ locateModel engineSearchMany2Many command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. locateModel engineSearchMany2Many; engineSearchMany2ManyProps diff --git a/doc/locateModel_standardSearch.txt b/doc/locateModel_standardSearch.txt index 7804e941..72ec5d93 100644 --- a/doc/locateModel_standardSearch.txt +++ b/doc/locateModel_standardSearch.txt @@ -9,7 +9,8 @@ locateModel standard command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. locateModel standard; :pre diff --git a/doc/locateModel_turboEngineSearch.txt b/doc/locateModel_turboEngineSearch.txt index ae030485..b7c4fa7f 100644 --- a/doc/locateModel_turboEngineSearch.txt +++ b/doc/locateModel_turboEngineSearch.txt @@ -9,7 +9,8 @@ locateModel turboEngine command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. locateModel turboEngine; turboEngineProps diff --git a/doc/meshMotionModel.txt b/doc/meshMotionModel.txt index 22053fbb..b16f8ce9 100644 --- a/doc/meshMotionModel.txt +++ b/doc/meshMotionModel.txt @@ -9,7 +9,8 @@ meshMotionModel command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. meshMotionModel model; :pre diff --git a/doc/meshMotionModel_noMeshMotion.txt b/doc/meshMotionModel_noMeshMotion.txt index 3617a72e..f339c095 100644 --- a/doc/meshMotionModel_noMeshMotion.txt +++ b/doc/meshMotionModel_noMeshMotion.txt @@ -9,7 +9,8 @@ meshMotionModel noMeshMotion command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. meshMotionModel noMeshMotion; :pre diff --git a/doc/momCoupleModel.txt b/doc/momCoupleModel.txt index 79b272e5..23dd9bcb 100644 --- a/doc/momCoupleModel.txt +++ b/doc/momCoupleModel.txt @@ -9,7 +9,8 @@ momCoupleModel command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. momCoupleModels ( diff --git a/doc/momCoupleModel_explicitCouple.txt b/doc/momCoupleModel_explicitCouple.txt index e6c87679..05491988 100644 --- a/doc/momCoupleModel_explicitCouple.txt +++ b/doc/momCoupleModel_explicitCouple.txt @@ -9,7 +9,8 @@ momCoupleModel explicitCouple command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. momCoupleModels ( diff --git a/doc/momCoupleModel_implicitCouple.txt b/doc/momCoupleModel_implicitCouple.txt index 21775bad..67751937 100644 --- a/doc/momCoupleModel_implicitCouple.txt +++ b/doc/momCoupleModel_implicitCouple.txt @@ -9,7 +9,8 @@ momCoupleModel implicitCouple command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. momCoupleModels ( diff --git a/doc/momCoupleModel_noCouple.txt b/doc/momCoupleModel_noCouple.txt index 25ce6fbf..22bcfcdd 100644 --- a/doc/momCoupleModel_noCouple.txt +++ b/doc/momCoupleModel_noCouple.txt @@ -9,7 +9,8 @@ momCoupleModel off command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. momCoupleModels ( diff --git a/doc/probeModel.txt b/doc/probeModel.txt index 152b2c05..02a29b4b 100644 --- a/doc/probeModel.txt +++ b/doc/probeModel.txt @@ -35,4 +35,9 @@ The probeModel feature allows to implement various probing features in CFDEM. Cu None. +[Related commands:] + +"probeModel off"_probeModel_noProbe.html, +"probeModel particleProbe"_probeModel_particleProbe.html + [Default:] none. diff --git a/doc/probeModel_noProbe.txt b/doc/probeModel_noProbe.txt index 3f40ea29..f77f66df 100644 --- a/doc/probeModel_noProbe.txt +++ b/doc/probeModel_noProbe.txt @@ -9,7 +9,8 @@ probeModel off command :h3 [Syntax:] -To be activated via couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. forceModels \{ diff --git a/doc/regionModel.txt b/doc/regionModel.txt index 475353b1..88787cab 100644 --- a/doc/regionModel.txt +++ b/doc/regionModel.txt @@ -7,9 +7,12 @@ regionModel command :h3 -[Syntax:] +NOTE: In the current CFDEMcoupling version, this model is no longer used. -Note: In the current CFDEMcoupling version, this model is no longer used. Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. + +[Syntax:] regionModel model; :pre diff --git a/doc/regionModel_allRegion.txt b/doc/regionModel_allRegion.txt index b0c266d3..90dd11f5 100644 --- a/doc/regionModel_allRegion.txt +++ b/doc/regionModel_allRegion.txt @@ -9,7 +9,10 @@ regionModel allRegion command :h3 [Syntax:] -Note: In the current CFDEMcoupling version, this model is no longer used. Defined in couplingProperties dictionary. +NOTE: In the current CFDEMcoupling version, this model is no longer used. + +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. regionModel allRegion; :pre diff --git a/doc/smoothingModel.txt b/doc/smoothingModel.txt index c78f26c3..dcc6c8fc 100644 --- a/doc/smoothingModel.txt +++ b/doc/smoothingModel.txt @@ -9,7 +9,8 @@ smoothingModel command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. smoothingModel model; :pre diff --git a/doc/smoothingModel_constDiffSmoothing.txt b/doc/smoothingModel_constDiffSmoothing.txt index 00adfc82..e1855973 100644 --- a/doc/smoothingModel_constDiffSmoothing.txt +++ b/doc/smoothingModel_constDiffSmoothing.txt @@ -9,7 +9,8 @@ smoothingModel constDiffSmoothing command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. smoothingModel constDiffSmoothing; constDiffSmoothingProps diff --git a/doc/smoothingModel_noSmoothing.txt b/doc/smoothingModel_noSmoothing.txt index 444e5df5..9faa8a23 100644 --- a/doc/smoothingModel_noSmoothing.txt +++ b/doc/smoothingModel_noSmoothing.txt @@ -9,7 +9,8 @@ smoothingModel off command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. smoothingModel off; :pre diff --git a/doc/voidFractionModel.txt b/doc/voidFractionModel.txt index 6e627f11..3e20c564 100644 --- a/doc/voidFractionModel.txt +++ b/doc/voidFractionModel.txt @@ -9,7 +9,8 @@ voidfractionModel command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. voidfractionModel model; :pre diff --git a/doc/voidFractionModel_GaussVoidFraction.txt b/doc/voidFractionModel_GaussVoidFraction.txt index 01bc0963..48dd029d 100644 --- a/doc/voidFractionModel_GaussVoidFraction.txt +++ b/doc/voidFractionModel_GaussVoidFraction.txt @@ -9,7 +9,8 @@ voidfractionModel Gauss command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. voidfractionModel Gauss; GaussProps diff --git a/doc/voidFractionModel_IBVoidFraction.txt b/doc/voidFractionModel_IBVoidFraction.txt index 9d254da1..c7cbce63 100644 --- a/doc/voidFractionModel_IBVoidFraction.txt +++ b/doc/voidFractionModel_IBVoidFraction.txt @@ -9,7 +9,8 @@ voidfractionModel IB command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. voidfractionModel IB; IBProps diff --git a/doc/voidFractionModel_bigParticleVoidFraction.txt b/doc/voidFractionModel_bigParticleVoidFraction.txt index 63c53f9e..62927931 100644 --- a/doc/voidFractionModel_bigParticleVoidFraction.txt +++ b/doc/voidFractionModel_bigParticleVoidFraction.txt @@ -9,7 +9,8 @@ voidfractionModel bigParticle command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. voidfractionModel bigParticle; bigParticleProps diff --git a/doc/voidFractionModel_centreVoidFraction.txt b/doc/voidFractionModel_centreVoidFraction.txt index 7fd19116..12843df4 100644 --- a/doc/voidFractionModel_centreVoidFraction.txt +++ b/doc/voidFractionModel_centreVoidFraction.txt @@ -9,7 +9,8 @@ voidfractionModel centre command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. voidfractionModel centre; centreProps diff --git a/doc/voidFractionModel_dividedVoidFraction.txt b/doc/voidFractionModel_dividedVoidFraction.txt index 1487c81d..c3903761 100644 --- a/doc/voidFractionModel_dividedVoidFraction.txt +++ b/doc/voidFractionModel_dividedVoidFraction.txt @@ -9,7 +9,8 @@ voidfractionModel divided command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. voidfractionModel divided; dividedProps