From 29278314c21fa42340b27cb7857c003ca7b01d72 Mon Sep 17 00:00:00 2001 From: danielque Date: Wed, 18 Jul 2018 14:51:29 +0200 Subject: [PATCH] [DOC] formatting / fix links --- doc/CFDEMcoupling_about.txt | 2 +- doc/CFDEMcoupling_dicts.txt | 24 +++++++++++--------- doc/CFDEMcoupling_tutorials.txt | 19 ++++++++-------- doc/IOModel.txt | 2 +- doc/chemistryModel_diffusionCoefficients.txt | 2 +- doc/locateModel_engineSearchMany2Many.txt | 3 ++- doc/meshMotionModel_noMeshMotion.txt | 2 +- doc/regionModel_allRegion.txt | 2 +- 8 files changed, 30 insertions(+), 26 deletions(-) diff --git a/doc/CFDEMcoupling_about.txt b/doc/CFDEMcoupling_about.txt index dab62d4b..bf2ff476 100644 --- a/doc/CFDEMcoupling_about.txt +++ b/doc/CFDEMcoupling_about.txt @@ -34,7 +34,7 @@ The file structure: {tutorials} directory including basic tutorial cases showing the functionality :l :ule -Details on installation are given on the "CFDEMproject WWW Site"_lig . +Details on installation are given on the "CFDEMproject Website"_lig . The functionality of this CFD-DEM framework is described via "tutorial cases"_CFDEMcoupling_tutorials.html showing how to use different solvers and models. diff --git a/doc/CFDEMcoupling_dicts.txt b/doc/CFDEMcoupling_dicts.txt index a82faff0..f5d8a855 100644 --- a/doc/CFDEMcoupling_dicts.txt +++ b/doc/CFDEMcoupling_dicts.txt @@ -7,11 +7,11 @@ 4. Dictionaries :link(1_4),h3 -4.1 "couplingProperties" dictionary :link(couplingProperties),h4 +4.1 couplingProperties dictionary :link(couplingProperties),h4 [General:] -In the "couplingProperties" dictionary the setup of the coupling routines of the +In the {couplingProperties} dictionary the setup of the coupling routines of the CFD-DEM simulation are defined. [Location:] $caseDir/CFD/constant @@ -42,7 +42,7 @@ specific parameters. [Settings:] -Reasonable example settings for the "couplingProperties" dictionary are given in +Reasonable example settings for the {couplingProperties} dictionary are given in the tutorial cases. modelType :pre @@ -69,29 +69,31 @@ Choose the CFD timestep in the controlDict. It must be equal to or smaller than the coupling time, otherwise you will get the error: "Error - TS bigger than coupling interval!". :l,ole -Example: DEMts=0.00001s, couplingInterval=10 exchange data (=couple) will happen -every 0.0001s. +[Example:] + +Choosing DEMts=0.00001s and couplingInterval=10 means that an exchange of data +(=coupling) will happen every 0.0001s. :line -4.2 "liggghtsCommands" dictionary :link(liggghtsCommands),h4 +4.2 liggghtsCommands dictionary :link(liggghtsCommands),h4 [General:] -In the "liggghtsCommands" dictionary liggghts commands being executed during a -coupled CFD-DEM simulation are specified. +In the {liggghtsCommands} dictionary LIGGGHTS commands which are to be executed +during a coupled CFD-DEM simulation are specified. [Location:] $caseDir/CFD/constant [Structure:] The dictionary is divided into two parts, first a list of -"liggghtsCommandModels" is defined, then the settings for each model must be -specified. +"liggghtsCommandModels"_CFDEMcoupling_models.html#lcm is defined, then the +settings for each model must be specified. [Settings:] -Reasonable example settings for the "liggghtsCommands" dictionary are given in +Reasonable example settings for the {liggghtsCommands} dictionary are given in the tutorial cases. diff --git a/doc/CFDEMcoupling_tutorials.txt b/doc/CFDEMcoupling_tutorials.txt index 9f1944fb..092f7ae3 100644 --- a/doc/CFDEMcoupling_tutorials.txt +++ b/doc/CFDEMcoupling_tutorials.txt @@ -9,15 +9,15 @@ [General:] -Each solver of the CFDEMcoupling comes with at least one tutorial example, -showing its functionality and correct usage. Provided that the installation is -correct, the tutorials can be run via "Allrun.sh" shell scripts. These scripts -perform all necessary steps (preprocessing, run, postprocessing, visualization). +Each solver of CFDEMcoupling comes with at least one tutorial example, showing +its functionality and correct usage. Provided that the installation is correct, +the tutorials can be run via "Allrun.sh" shell scripts. These scripts perform +all necessary steps (preprocessing, run, postprocessing, visualization). [Location:] -The tutorials can be found in the directory $CFDEM_PROJECT_DIR/tutorials, which -can be reached by typing "cfdemTut" +The tutorials can be found in the directory $CFDEM_PROJECT_DIR/tutorials, +which can be reached by typing {cfdemTut} in a CLI terminal. [Structure:] @@ -46,9 +46,10 @@ fvSchemes, controlDict). You can find more information on that in "OpenFOAM(R)(*)"_of documentations. Settings of the coupling routines are defined in -$caseDir/CFD/constant/"couplingProperies"_#1_3 (e.g. force models, data exchange -model, etc.) and $caseDir/CFD/constant/"liggghtsCommands"_#1_3 (allows to -execute a LIGGGHTS command during a coupled simulation). +$caseDir/CFD/constant/"couplingProperies"_CFDEMcoupling_dicts.html#couplingProperties +(e.g. force models, data exchange model, etc.) and +$caseDir/CFD/constant/"liggghtsCommands"_CFDEMcoupling_dicts.html#liggghtsCommands +(allows to execute a LIGGGHTS command during a coupled simulation). NOTE: (*) This offering is not approved or endorsed by OpenCFD Limited, producer and diff --git a/doc/IOModel.txt b/doc/IOModel.txt index 09b972be..bc82cc1c 100644 --- a/doc/IOModel.txt +++ b/doc/IOModel.txt @@ -25,7 +25,7 @@ in this documentation. [Description:] -The IO-model is the base class to write data (e.g. particle properties) to files. +{IOModel} is the base class to write data (e.g. particle properties) to files. [Restrictions:] diff --git a/doc/chemistryModel_diffusionCoefficients.txt b/doc/chemistryModel_diffusionCoefficients.txt index 3b1754ce..df64243b 100644 --- a/doc/chemistryModel_diffusionCoefficients.txt +++ b/doc/chemistryModel_diffusionCoefficients.txt @@ -52,7 +52,7 @@ Fuller-Schettler-Giddings correlation. [Restrictions:] -Species model needs to be active. +The "species"_chemistryModel_species.html model needs to be active. [Related commands:] diff --git a/doc/locateModel_engineSearchMany2Many.txt b/doc/locateModel_engineSearchMany2Many.txt index 7beb3267..b05110c4 100644 --- a/doc/locateModel_engineSearchMany2Many.txt +++ b/doc/locateModel_engineSearchMany2Many.txt @@ -40,7 +40,8 @@ engineSearchMany2ManyProps The locateModel "engine" locates the CFD cell and cellID corresponding to a given position. -The engineSearchMany2Many locateModel can be used with different settings to use different algorithms: +The {engineSearchMany2Many} locateModel can be used with different settings to +use different algorithms: treeSearch false; will execute some geometric (linear) search using the last known cellID (recommended) :ulb,l diff --git a/doc/meshMotionModel_noMeshMotion.txt b/doc/meshMotionModel_noMeshMotion.txt index 6e923c84..35acfac6 100644 --- a/doc/meshMotionModel_noMeshMotion.txt +++ b/doc/meshMotionModel_noMeshMotion.txt @@ -20,7 +20,7 @@ meshMotionModel noMeshMotion; :pre [Description:] -The noMeshMotion-model is a dummy meshMotion model. +The {noMeshMotion} model is a dummy meshMotion model. [Restrictions:] diff --git a/doc/regionModel_allRegion.txt b/doc/regionModel_allRegion.txt index 91892578..92e88a7c 100644 --- a/doc/regionModel_allRegion.txt +++ b/doc/regionModel_allRegion.txt @@ -22,7 +22,7 @@ regionModel allRegion; :pre [Description:] -The allRegion-model is a region model including the whole CFD region for the coupling. +The {allRegion} model is a region model including the whole CFD region for the coupling. [Restrictions:]