diff --git a/doc/IOModel.txt b/doc/IOModel.txt index 216c2f4f..04fec29a 100644 --- a/doc/IOModel.txt +++ b/doc/IOModel.txt @@ -20,7 +20,8 @@ model = name of IO-model to be applied :ul 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 IO models +in this documentation. [Description:] diff --git a/doc/averagingModel.txt b/doc/averagingModel.txt index 5e9f6ddf..655dd43e 100644 --- a/doc/averagingModel.txt +++ b/doc/averagingModel.txt @@ -21,7 +21,9 @@ model = name of averaging model to be applied :ul averagingModel dense; averagingModel dilute; :pre -Note: This examples list might not be complete - please look for other averaging models (averagingModel_XY) in this documentation. +NOTE: +This examples list might not be complete - please look for other averaging +models in this documentation. [Description:] diff --git a/doc/clockModel.txt b/doc/clockModel.txt index 642a2c98..e3d261b5 100644 --- a/doc/clockModel.txt +++ b/doc/clockModel.txt @@ -20,7 +20,8 @@ model = name of the clockModel to be applied :ul clockModel standardClock; :pre -Note: This examples list might not be complete - please look for other models (clockModel_XY) in this documentation. +NOTE: This examples list might not be complete - please look for other clock +models in this documentation. [Description:] diff --git a/doc/dataExchangeModel.txt b/doc/dataExchangeModel.txt index 59d13adb..8c07412d 100644 --- a/doc/dataExchangeModel.txt +++ b/doc/dataExchangeModel.txt @@ -21,7 +21,8 @@ model = name of data exchange model to be applied :ul dataExchangeModel twoWayFiles; dataExchangeModel twoWayMPI; :pre -Note: This examples list might not be complete - please look for other models (dataExchangeModel_XY) in this documentation. +NOTE: This examples list might not be complete - please look for other models +(dataExchangeModel XY) in this documentation. [Description:] diff --git a/doc/forceModel.txt b/doc/forceModel.txt index f267c05a..ad9d5412 100644 --- a/doc/forceModel.txt +++ b/doc/forceModel.txt @@ -28,6 +28,8 @@ forceModels DiFeliceDrag ); :pre +NOTE: This examples list might not be complete - please look for other models +(forceModel XY) in this documentation. [Description:] diff --git a/doc/forceModel_virtualMassForce.txt b/doc/forceModel_virtualMassForce.txt index ae27acc3..41f56b88 100644 --- a/doc/forceModel_virtualMassForce.txt +++ b/doc/forceModel_virtualMassForce.txt @@ -39,9 +39,7 @@ virtualMassForceProps The force model performs the calculation of forces (e.g. fluid-particle interaction forces) acting on each DEM particle. The virtualMassForce model calculates the virtual mass force for each particle. -[Restrictions:] - -Model not validated! +IMPORTANT NOTE: Model not validated! [Related commands:] diff --git a/doc/forceSubModel.txt b/doc/forceSubModel.txt index fd21a4ae..768040c5 100644 --- a/doc/forceSubModel.txt +++ b/doc/forceSubModel.txt @@ -26,7 +26,8 @@ forceSubModels ImEx ); :pre -Note: This examples list might not be complete - please look for other models (forceSubModel_XY) in this documentation. +NOTE: This examples list might not be complete - please look for other models +(forceSubModel XY) in this documentation. [Description:] @@ -40,6 +41,5 @@ None. "ImEx"_forceSubModel_ImEx.html -Note: This examples list may be incomplete - please look for other models (forceSubModel_XY) in this documentation. [Default:] none. diff --git a/doc/liggghtsCommandModel.txt b/doc/liggghtsCommandModel.txt index 15dbe72b..9ad3e306 100644 --- a/doc/liggghtsCommandModel.txt +++ b/doc/liggghtsCommandModel.txt @@ -28,7 +28,8 @@ liggghtsCommandModels writeLiggghts ); :pre -Note: This examples list might not be complete - please look for other models (liggghtsCommandModel_XY) in this documentation. +NOTE: This examples list might not be complete - please look for other models +(liggghtsCommandModel XY) in this documentation. [Description:] diff --git a/doc/liggghtsCommandModel_execute.txt b/doc/liggghtsCommandModel_execute.txt index 993f541d..90c7599c 100644 --- a/doc/liggghtsCommandModel_execute.txt +++ b/doc/liggghtsCommandModel_execute.txt @@ -79,7 +79,8 @@ executeProps1 The execute liggghtsCommand Model can be used to execute a LIGGGHTS command during a CFD run. In above example execute_0 for instance executes "run $couplingInterval" every coupling step. $couplingInterval is automatically replaced by the correct number of DEM steps. Additionally execute_1 executes "write_restart ../DEM/liggghts.restart_$timeStamp" every writing step, where $timeStamp is automatically set. -These rather complex execute commands can be replaced by the "readLiggghts" and "writeLiggghts" commands! :h4 +NOTE: These rather complex execute commands can be replaced by the +{runLiggghts} and {writeLiggghts} commands! [Restrictions:] None. diff --git a/doc/liggghtsCommandModel_readLiggghtsData.txt b/doc/liggghtsCommandModel_readLiggghtsData.txt index 4adc1e1d..f7491aab 100644 --- a/doc/liggghtsCommandModel_readLiggghtsData.txt +++ b/doc/liggghtsCommandModel_readLiggghtsData.txt @@ -37,10 +37,7 @@ readLiggghtsDataProps0 The readLiggghtsData liggghtsCommand Model can be used to ??? - -[Restrictions:] - -Note: Model is not up to date. +IMPORTANT NOTE: Model is outdated. [Related commands:] diff --git a/doc/liggghtsCommandModel_runLiggghts.txt b/doc/liggghtsCommandModel_runLiggghts.txt index 1b438d9e..fb1694d6 100644 --- a/doc/liggghtsCommandModel_runLiggghts.txt +++ b/doc/liggghtsCommandModel_runLiggghts.txt @@ -34,7 +34,10 @@ liggghtsCommandModels The liggghtsCommand models can be used to execute a LIGGGHTS command during a CFD run. The "runLiggghts" command executes the command "run $nrDEMsteps", where $nrDEMsteps is automatically set according to the coupling intervals, every coupling step. Optionally a dictionary called runLiggghtsProps can be specified where the "preNo" switch can be set, which uses the command "run $nrDEMsteps pre no" for every time step except the first. -[Restrictions:] Warning: the "pre no" option can cause troubles (dump data of particles changing the domain might be erroneous)! +[Restrictions:] + +IMPORTANT NOTE: the "pre no" option can cause troubles (dump data of particles +changing the domain might be erroneous)! [Related commands:] diff --git a/doc/locateModel.txt b/doc/locateModel.txt index 46d5a1f2..2eeffd3d 100644 --- a/doc/locateModel.txt +++ b/doc/locateModel.txt @@ -20,7 +20,8 @@ model = name of the locateModel to be applied :ul locateModel engine; :pre -Note: This examples list might not be complete - please look for other models (locateModel_XY) in this documentation. +NOTE: This examples list might not be complete - please look for other models +(locateModel XY) in this documentation. [Description:] diff --git a/doc/meshMotionModel.txt b/doc/meshMotionModel.txt index b16f8ce9..aab28ff0 100644 --- a/doc/meshMotionModel.txt +++ b/doc/meshMotionModel.txt @@ -20,7 +20,8 @@ model = name of the meshMotionModel to be applied :ul meshMotionModel noMeshMotion; :pre -Note: This examples list might not be complete - please look for other models (meshMotionModel_XY) in this documentation. +NOTE: This examples list might not be complete - please look for other models +(meshMotionModel XY) in this documentation. [Description:] diff --git a/doc/momCoupleModel.txt b/doc/momCoupleModel.txt index 23dd9bcb..e02176a2 100644 --- a/doc/momCoupleModel.txt +++ b/doc/momCoupleModel.txt @@ -26,7 +26,8 @@ momCoupleModels implicitCouple ); :pre -Note: This examples list might not be complete - please look for other models (momCoupleModel_XY) in this documentation. +NOTE: This examples list might not be complete - please look for other models +(momCoupleModel XY) in this documentation. Forces can be coupled in an implicit way to the fluid solver (i.e., when solving the Navier-Stokes equations, the fluid velocity at the new time will be considered for the coupling force). This implicit coupling is typically done for the drag forces (look for "impForces()" in the implementation of the drag model). Implicit coupling is more stable (especially important for dense flows), but conflicts Newton's third law. Explicit forces are imposed on the flow solver in an explicit fashion (look for "expForces()" in the implementation of the drag model), which is less stable, but does not conflict Newton's third law. diff --git a/doc/probeModel.txt b/doc/probeModel.txt index 0bd9ef39..e3751e2e 100644 --- a/doc/probeModel.txt +++ b/doc/probeModel.txt @@ -23,7 +23,8 @@ model = name of the probeModel to be applied :ul 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 probe models that can perform particle probing. [Description:] diff --git a/doc/probeModel_noProbe.txt b/doc/probeModel_noProbe.txt index 62c44b19..1a1abd91 100644 --- a/doc/probeModel_noProbe.txt +++ b/doc/probeModel_noProbe.txt @@ -18,7 +18,8 @@ probeModel off; :pre 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 models that can perform particle probing. [Description:] diff --git a/doc/regionModel.txt b/doc/regionModel.txt index 88787cab..3fa6e262 100644 --- a/doc/regionModel.txt +++ b/doc/regionModel.txt @@ -22,7 +22,8 @@ model = name of the regionModel to be applied :ul regionModel allRegion; :pre -Note: This examples list might not be complete - please look for other models (regionModel_XY) in this documentation. +NOTE: This examples list might not be complete - please look for other models +(regionModel XY) in this documentation. [Description:] diff --git a/doc/smoothingModel.txt b/doc/smoothingModel.txt index 5d9d98ca..7fbc2d48 100644 --- a/doc/smoothingModel.txt +++ b/doc/smoothingModel.txt @@ -21,9 +21,14 @@ model = name of the smoothingModel to be applied :ul smoothingModel off; 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. -ATTENTION: In case a smoothing model is used in conjunction with "PimpleImEx" solvers, the fields "f" and "fSmooth" must be placed in the initial time directory! This is because zeroGradient boundary conditions for the fields "f" and "fSmooth" must be specified, otherwise the smoothing operation will give an Error. +IMPORTANT NOTE: In case a smoothing model is used in conjunction with +"PimpleImEx" solvers, the fields "f" and "fSmooth" must be placed in the initial +time directory! This is because zeroGradient boundary conditions for the fields +"f" and "fSmooth" must be specified, otherwise the smoothing operation will give +an error. [Description:] diff --git a/doc/smoothingModel_constDiffSmoothing.txt b/doc/smoothingModel_constDiffSmoothing.txt index 0c19bdbe..9abad593 100644 --- a/doc/smoothingModel_constDiffSmoothing.txt +++ b/doc/smoothingModel_constDiffSmoothing.txt @@ -42,10 +42,15 @@ constDiffSmoothingProps The "constDiffSmoothing" model is a basic smoothingModel model which reads a smoothing length scale being used for smoothing the exchange fields (voidfraction, Ksl, f if present). This model can be used for smoothing explicit force coupling fields, as well as implicit force coupling algorithms. Smoothing for reference fields is performed to "fill in" values in cells in which these reference fields are not specified. Values calculated in the cells (via Lagrangian-To-Euler mapping) are NOT changed! These reference fields are, e.g., the average particle velocity, which are not specified in all cells in case the flow is rather dilute. -[Restrictions:] This model is tested in a limited number of flow situations. +[Restrictions:] -ATTENTION: In case a smoothing model is used in conjunction with "PimpleImEx" solvers, the fields "f" and "fSmooth" must be placed in the initial time directory! This is because zeroGradient boundary conditions for the fields "f" and "fSmooth" must be specified, otherwise the smoothing operation will give an Error. +This model is tested in a limited number of flow situations. +IMPORTANT NOTE: In case a smoothing model is used in conjunction with +"PimpleImEx" solvers, the fields "f" and "fSmooth" must be placed in the initial +time directory! This is because zeroGradient boundary conditions for the fields +"f" and "fSmooth" must be specified, otherwise the smoothing operation will give +an error. [Related commands:] diff --git a/doc/voidFractionModel.txt b/doc/voidFractionModel.txt index 3e20c564..890ae90a 100644 --- a/doc/voidFractionModel.txt +++ b/doc/voidFractionModel.txt @@ -20,7 +20,8 @@ model = name of the voidfractionModel to be applied :ul voidfractionModel centre; :pre -Note: This examples list might not be complete - please look for other models (voidfractionModel_XY) in this documentation. +NOTE: This examples list might not be complete - please look for other models +(voidfractionModel XY) in this documentation. [Description:]