[DOC] homogenize formatting

2025-12-08 06:37:44 +00:00 · 2018-07-18 14:33:41 +02:00
parent 61d7a88793
commit b61db3f4a9
54 changed files with 168 additions and 72 deletions
--- a/doc/IOModel.txt
+++ b/doc/IOModel.txt
@ -29,12 +29,14 @@ The IO-model is the base class to write data (e.g. particle properties) to files

 [Restrictions:]

-none.
+none

 [Related commands:]

 "IOModel basicIO"_IOModel_basicIO.html, "IOModel off"_IOModel_noIO.html,
 "IOModel sophIO"_IOModel_sophIO.html, "IOModel trackIO"_IOModel_trackIO.html

+[Default:]
+
+none

-[Default:] none.
--- a/doc/IOModel_basicIO.txt
+++ b/doc/IOModel_basicIO.txt
@ -23,7 +23,9 @@ serialOutput; :pre

 The basic IO-model writes particle positions velocities and radii to files. The default output directory ($casePath/CFD/proc*/time/lagrangian). Using the keyword "serialOutput;" in couplingProperties the IO is serial to the directory ($casePath/CFD/lagrangian). In the latter case only the data on processor 0 is written! Data is written every write time of the CFD simulation.

-[Restrictions:] None.
+[Restrictions:]
+
+none

 [Related commands:]

--- a/doc/IOModel_noIO.txt
+++ b/doc/IOModel_noIO.txt
@ -22,7 +22,9 @@ IOModel off; :pre

 The noIO-model is a dummy IO model.

-[Restrictions:] None.
+[Restrictions:]
+
+none

 [Related commands:]

--- a/doc/IOModel_sophIO.txt
+++ b/doc/IOModel_sophIO.txt
@ -22,7 +22,9 @@ IOModel sophIO; :pre

 The sophIO-model is based on basicIO model and additionally writes voidfraction, implicit forces, explicit forces. Data is written every write time of the CFD simulation.

-[Restrictions:] None.
+[Restrictions:]
+
+none

 [Related commands:]

--- a/doc/IOModel_trackIO.txt
+++ b/doc/IOModel_trackIO.txt
@ -22,7 +22,9 @@ IOModel trackIO; :pre

 The trackIO-model is based on sophIO model and additionally writes fields necessary to use the particleTracks utility (which needs a particleTrackProperties file in the constant dir). The particleTracks utility generates tracks of the particles and writes them to a vtk file.

-[Restrictions:] None.
+[Restrictions:]
+
+none

 [Related commands:]

--- a/doc/averagingModel.txt
+++ b/doc/averagingModel.txt
@ -31,10 +31,13 @@ The averaging model performs the Lagrangian->Eulerian mapping of data (e.g. part

 [Restrictions:]

-None.
+none

 [Related commands:]

 "dense"_averagingModel_dense.html, "dilute"_averagingModel_dilute.html

-[Default:] none
+[Default:]
+
+none
+
--- a/doc/chemistryModel.txt
+++ b/doc/chemistryModel.txt
@ -35,7 +35,7 @@ The chemistry model initializes the required fields for the calculation of molar

 [Restrictions:]

-None.
+none

 [Related commands:]

@ -43,4 +43,6 @@ None.
 "massTransferCoeff"_chemistryModel_massTransferCoeff.html,
 "species"_chemistryModel_species.html

-[Default:] none.
+[Default:]
+
+none
--- a/doc/chemistryModel_species.txt
+++ b/doc/chemistryModel_species.txt
@ -56,7 +56,7 @@ The chemistry model performs the calculation of chemical reactional effects acti

 [Restrictions:]

-none.
+none

 [Related commands:]

--- a/doc/clockModel.txt
+++ b/doc/clockModel.txt
@ -29,6 +29,10 @@ The clockModel is the base class for models to examine the code/algorithm with r

 Main parts of the clockModel classes are written by Josef Kerbl, JKU.

-[Restrictions:] none.
+[Restrictions:]

-[Default:] none.
+none
+
+[Default:]
+
+none
--- a/doc/clockModel_noClock.txt
+++ b/doc/clockModel_noClock.txt
@ -23,7 +23,9 @@ clockModel off; :pre
 The {off} model is a dummy clockModel model which does not measure/evaluate the
 run time.

-[Restrictions:] none.
+[Restrictions:]
+
+none

 [Related commands:]

--- a/doc/clockModel_standardClock.txt
+++ b/doc/clockModel_standardClock.txt
@ -24,7 +24,9 @@ The "standardClock" model is a basic clockModel model which measures the run tim
 Since the measurements are stored in an array, it is necessary to put a variable {arrayPos} (type integer) at the start command. Those do not need to be in ascending order and positions may be omitted. The standard size of this array is 30 and can be changed at the initialization of the standardClock class. If {arrayPos} is out of bounds, the array size will be doubled. The stop command does not need {arrayPos}, since the class remembers the positions. The string name is intended for easier evaluation afterwards an may be omitted like ".start(int arrayPos)" and ".stop()". The command ".stop(string name)" is a safety feature, because if the name is not equal to the started name, output will be produced for information.
 After the case ran you may use the matPlot.py script located in $CFDEM_UT_DIR/vizClock/ to produce a graphical output of your measurements. The usage is like 'python < matPlot.py' and you have to be in the directory of the desired time step, where there is a file called "timeEvalFull.txt", which contains averaged and maximum data with respect to the number of processes. There is an alias called "vizClock" to run this python routine for visualizing the data.

-[Restrictions:] none.
+[Restrictions:]
+
+none

 [Related commands:]

--- a/doc/dataExchangeModel.txt
+++ b/doc/dataExchangeModel.txt
@ -30,7 +30,7 @@ The data exchange model performs the data exchange between the DEM code and the

 [Restrictions:]

-None.
+none

 [Related commands:]

@ -39,4 +39,6 @@ None.
 "twoWayFiles"_dataExchangeModel_twoWayFiles.html,
 "twoWayMPI"_dataExchangeModel_twoWayMPI.html

-[Default:] none
+[Default:]
+
+none
--- a/doc/dataExchangeModel_noDataExchange.txt
+++ b/doc/dataExchangeModel_noDataExchange.txt
@ -24,7 +24,7 @@ The data exchange model performs the data exchange between the DEM code and the

 [Restrictions:]

-None.
+none

 [Related commands:]

--- a/doc/dataExchangeModel_oneWayVTK.txt
+++ b/doc/dataExchangeModel_oneWayVTK.txt
@ -44,7 +44,7 @@ The data exchange model performs the data exchange between the DEM code and the

 [Restrictions:]

-None.
+none

 [Related commands:]

--- a/doc/dataExchangeModel_twoWayMPI.txt
+++ b/doc/dataExchangeModel_twoWayMPI.txt
@ -35,7 +35,7 @@ The data exchange model performs the data exchange between the DEM code and the

 [Restrictions:]

-none.
+none

 [Related commands:]

--- a/doc/forceModel.txt
+++ b/doc/forceModel.txt
@ -37,7 +37,7 @@ The force model performs the calculation of forces (e.g. fluid-particle interact

 [Restrictions:]

-None.
+none

 [Related commands:]

@ -45,4 +45,7 @@ None.
 "gradPForce"_forceModel_gradPForce.html, "viscForce"_forceModel_viscForce.html,
 "dSauter"_forceModel_dSauter.html

-[Default:] none.
+[Default:]
+
+none
+
--- a/doc/forceModel_Archimedes.txt
+++ b/doc/forceModel_Archimedes.txt
@ -41,7 +41,7 @@ The force model performs the calculation of forces (e.g. fluid-particle interact

 [Restrictions:]

-none.
+none

 [Related commands:]

--- a/doc/forceModel_DiFeliceDrag.txt
+++ b/doc/forceModel_DiFeliceDrag.txt
@ -44,7 +44,7 @@ The force model performs the calculation of forces (e.g. fluid-particle interact

 [Restrictions:]

-none.
+none

 [Related commands:]

--- a/doc/forceModel_GidaspowDrag.txt
+++ b/doc/forceModel_GidaspowDrag.txt
@ -53,7 +53,7 @@ The force model performs the calculation of forces (e.g. fluid-particle interact

 [Restrictions:]

-none.
+none

 [Related commands:]

--- a/doc/forceModel_KochHillDrag.txt
+++ b/doc/forceModel_KochHillDrag.txt
@ -48,7 +48,7 @@ The force model performs the calculation of forces (e.g. fluid-particle interact

 [Restrictions:]

-none.
+none

 [Related commands:]

--- a/doc/forceModel_MeiLift.txt
+++ b/doc/forceModel_MeiLift.txt
@ -50,7 +50,7 @@ The force model performs the calculation of forces (e.g. fluid-particle interact

 [Restrictions:]

-None.
+none

 [Related commands:]

--- a/doc/forceModel_SchillerNaumannDrag.txt
+++ b/doc/forceModel_SchillerNaumannDrag.txt
@ -41,7 +41,7 @@ The force model performs the calculation of forces (e.g. fluid-particle interact

 [Restrictions:]

-none.
+none

 [Related commands:]

--- a/doc/forceModel_dSauter.txt
+++ b/doc/forceModel_dSauter.txt
@ -38,8 +38,9 @@ This "forceModel" does not influence the particles or the flow - it calculates t

 [Restrictions:]

-none.
+none

 [Related commands:]

-"forceModel"_forceModel.html
+"forceModel"_forceModel.html
+
--- a/doc/forceModel_fieldStore.txt
+++ b/doc/forceModel_fieldStore.txt
@ -56,7 +56,7 @@ This "forceModel" does not influence the particles or the flow - it is a tool to

 [Restrictions:]

-none.
+none

 [Related commands:]

--- a/doc/forceModel_gradPForce.txt
+++ b/doc/forceModel_gradPForce.txt
@ -47,7 +47,7 @@ The force model performs the calculation of forces (e.g. fluid-particle interact

 [Restrictions:]

-none.
+none

 [Related commands:]

--- a/doc/forceModel_noDrag.txt
+++ b/doc/forceModel_noDrag.txt
@ -41,7 +41,7 @@ The force model performs the calculation of forces (e.g. fluid-particle interact

 [Restrictions:]

-None.
+none

 [Related commands:]

--- a/doc/forceModel_particleCellVolume.txt
+++ b/doc/forceModel_particleCellVolume.txt
@ -47,7 +47,7 @@ At "writeTime" a field named particleCellVolume , where scalarField is the name

 [Restrictions:]

-None.
+none

 [Related commands:]

--- a/doc/forceModel_pdCorrelation.txt
+++ b/doc/forceModel_pdCorrelation.txt
@ -47,7 +47,7 @@ This model is sensitive to additionally pulled particle type info, and can eithe

 [Restrictions:]

-none.
+none

 [Related commands:]

--- a/doc/forceModel_viscForce.txt
+++ b/doc/forceModel_viscForce.txt
@ -43,7 +43,7 @@ The force model performs the calculation of forces (e.g. fluid-particle interact

 [Restrictions:]

-none.
+none

 [Related commands:]

--- a/doc/forceSubModel.txt
+++ b/doc/forceSubModel.txt
@ -35,11 +35,13 @@ The force sub model is designed to hold the settings a force model can have. For

 [Restrictions:]

-None.
+none

 [Related commands:]

 "ImEx"_forceSubModel_ImEx.html

+[Default:]
+
+none

-[Default:] none.
--- a/doc/forceSubModel_ImEx.txt
+++ b/doc/forceSubModel_ImEx.txt
@ -35,7 +35,7 @@ treatExplicit true;  // optional for some force models. :pre

 [Restrictions:]

-none.
+none

 [Related commands:]

--- a/doc/forceSubModel_ImExCorr.txt
+++ b/doc/forceSubModel_ImExCorr.txt
@ -35,7 +35,7 @@ treatExplicit true;  // optional for some force models. :pre

 [Restrictions:]

-none.
+none

 [Related commands:]

--- a/doc/liggghtsCommandModel.txt
+++ b/doc/liggghtsCommandModel.txt
@ -35,8 +35,11 @@ NOTE: This examples list might not be complete - please look for other models

 The liggghtsCommandModel is the base class to execute DEM commands within a CFD run.

-[Restrictions:] 
+[Restrictions:]

 Works only with MPI coupling.

-[Default:] none.
+[Default:]
+
+none
+
--- a/doc/liggghtsCommandModel_execute.txt
+++ b/doc/liggghtsCommandModel_execute.txt
@ -82,7 +82,9 @@ The execute liggghtsCommand Model can be used to execute a LIGGGHTS command duri
 NOTE: These rather complex execute commands can be replaced by the
 {runLiggghts} and {writeLiggghts} commands!

-[Restrictions:] None.
+[Restrictions:]
+
+none

 [Related commands:]

--- a/doc/liggghtsCommandModel_writeLiggghts.txt
+++ b/doc/liggghtsCommandModel_writeLiggghts.txt
@ -43,7 +43,9 @@ liggghtsCommandModels

 The liggghtsCommand models can be used to execute a LIGGGHTS command during a CFD write. The "writeLiggghts" command executes the command "write_restart $name", where $name is the name of the restart file, every write step.

-[Restrictions:] None.
+[Restrictions:]
+
+none

 [Related commands:]

--- a/doc/locateModel.txt
+++ b/doc/locateModel.txt
@ -27,6 +27,11 @@ NOTE: This examples list might not be complete - please look for other models

 The locateModel is the base class for models which search for the CFD cell and cellID corresponding to a position. In general it is used to find the cell a particle is located in.

-[Restrictions:] none.
+[Restrictions:]
+
+none
+
+[Default:]
+
+none

-[Default:] none.
--- a/doc/locateModel_engineSearch.txt
+++ b/doc/locateModel_engineSearch.txt
@ -38,7 +38,9 @@ treeSearch false;     will execute some geometric (linear) search using the last
 treeSearch true;      will use a recursive tree structure to find the cell (recommended). :l
 :ule

-[Restrictions:] none.
+[Restrictions:]
+
+none

 [Related commands:]

--- a/doc/locateModel_standardSearch.txt
+++ b/doc/locateModel_standardSearch.txt
@ -23,7 +23,9 @@ locateModel standard; :pre
 The locateModel "standard" locates the CFD cell and cellID corresponding to a given position. A very straight-forward (robust!) locate algorithm is used.


-[Restrictions:] none.
+[Restrictions:]
+
+none

 [Related commands:]

--- a/doc/locateModel_turboEngineSearch.txt
+++ b/doc/locateModel_turboEngineSearch.txt
@ -39,7 +39,9 @@ faceDecomp false; treeSearch false;     will execute some geometric (linear) sea
 faceDecomp false; treeSearch true;      will use a recursive tree structure to find the cell. (recommended):l
 :ule

-[Restrictions:] none.
+[Restrictions:]
+
+none

 [Related commands:]

--- a/doc/meshMotionModel.txt
+++ b/doc/meshMotionModel.txt
@ -27,6 +27,11 @@ NOTE: This examples list might not be complete - please look for other models

 The meshMotionModel is the base class for models which manipulate the CFD mesh according to the DEM mesh motion.

-[Restrictions:] none.
+[Restrictions:]
+
+none
+
+[Default:]
+
+none

-[Default:] none.
--- a/doc/meshMotionModel_noMeshMotion.txt
+++ b/doc/meshMotionModel_noMeshMotion.txt
@ -22,7 +22,9 @@ meshMotionModel noMeshMotion; :pre

 The noMeshMotion-model is a dummy meshMotion model.

-[Restrictions:] None.
+[Restrictions:]
+
+none

 [Related commands:]

--- a/doc/momCoupleModel.txt
+++ b/doc/momCoupleModel.txt
@ -38,6 +38,11 @@ Note that the switch "treatVoidCellsAsExplicitForce true;" can be set in the cou

 The momCoupleModel is the base class for momentum exchange between DEM and CFD simulation.

-[Restrictions:] none.
+[Restrictions:]
+
+none
+
+[Default:]
+
+none

-[Default:] none.
--- a/doc/probeModel.txt
+++ b/doc/probeModel.txt
@ -32,11 +32,14 @@ The probeModel feature allows to implement various probing features in CFDEM. Cu

 [Restrictions:]

-None.
+none

 [Related commands:]

 "probeModel off"_probeModel_noProbe.html,
 "probeModel particleProbe"_probeModel_particleProbe.html

-[Default:] none.
+[Default:]
+
+none
+
--- a/doc/probeModel_noProbe.txt
+++ b/doc/probeModel_noProbe.txt
@ -27,10 +27,13 @@ Does not perform any probing.

 [Restrictions:]

-None.
+none

-[Related commands which are currently enabled for particle probing:]
+[Related commands:]

 "particleProbe"_probeModel_particleProbe.html

-[Default:] none.
+[Default:]
+
+none
+
--- a/doc/regionModel.txt
+++ b/doc/regionModel.txt
@ -29,6 +29,11 @@ NOTE: This examples list might not be complete - please look for other models

 The regionModel is the base class for region models to select a certain region for coupled simulation.

-[Restrictions:] none.
+[Restrictions:]
+
+none
+
+[Default:]
+
+none

-[Default:] none.
--- a/doc/regionModel_allRegion.txt
+++ b/doc/regionModel_allRegion.txt
@ -24,7 +24,9 @@ regionModel allRegion; :pre

 The allRegion-model is a region model including the whole CFD region for the coupling.

-[Restrictions:] None.
+[Restrictions:]
+
+none

 [Related commands:]

--- a/doc/smoothingModel.txt
+++ b/doc/smoothingModel.txt
@ -34,6 +34,11 @@ an error.

 The smoothingModel is the base class for models that smoothen the exchange fields (i.e., voidfraction and the Ksl field in case of implicit force coupling). This is relevant in case one uses a small grid resolution compared to the local particle diameter (or parcel diameter in case one uses a parcel approach).

-[Restrictions:] These models are in beta testing.
+[Restrictions:]
+
+These models are in beta testing.
+
+[Default:]
+
+none

-[Default:] none.
--- a/doc/smoothingModel_noSmoothing.txt
+++ b/doc/smoothingModel_noSmoothing.txt
@ -22,7 +22,9 @@ smoothingModel off; :pre

 The {off} model is a dummy smoothingModel model which performs no smoothing.

-[Restrictions:] none.
+[Restrictions:]
+
+none

 [Related commands:]

--- a/doc/voidFractionModel.txt
+++ b/doc/voidFractionModel.txt
@ -27,6 +27,11 @@ NOTE: This examples list might not be complete - please look for other models

 The voidfractionModel is the base class for models to represent the DEM particle's volume in the CFD domain via a voidfraction field.

-[Restrictions:] none.
+[Restrictions:]
+
+none
+
+[Default:]
+
+none

-[Default:] none.
--- a/doc/voidFractionModel_GaussVoidFraction.txt
+++ b/doc/voidFractionModel_GaussVoidFraction.txt
@ -46,7 +46,9 @@ The region of influence of a particle can be increased artificially by "porosity

 The particle volume occupied in the CFD domain can be adjusted by the parameter "weight", using Vparticle=dsphere^3*pi/6*weight.

-[Restrictions:] none.
+[Restrictions:]
+
+none

 [Related commands:]

--- a/doc/voidFractionModel_IBVoidFraction.txt
+++ b/doc/voidFractionModel_IBVoidFraction.txt
@ -43,7 +43,9 @@ The region of influence of a particle can be increased artificially by "scaleUpV

 Code of this sub-model contributed by Alice Hager, JKU.

-[Restrictions:] none.
+[Restrictions:]
+
+none

 [Related commands:]

--- a/doc/voidFractionModel_bigParticleVoidFraction.txt
+++ b/doc/voidFractionModel_bigParticleVoidFraction.txt
@ -48,7 +48,9 @@ The particle volume occupied in the CFD domain can be adjusted by the parameter

 Parts of this sub-model contributed by Alice Hager, JKU.

-[Restrictions:] none.
+[Restrictions:]
+
+none

 [Related commands:]

--- a/doc/voidFractionModel_centreVoidFraction.txt
+++ b/doc/voidFractionModel_centreVoidFraction.txt
@ -38,7 +38,9 @@ The centre voidFraction model calculates the voidfraction in a CFD cell accounti

 The particle volume occupied in the CFD domain can be adjusted by the parameter "weight", using Vparticle=dsphere^3*pi/6*weight.

-[Restrictions:] none.
+[Restrictions:]
+
+none

 [Related commands:]

--- a/doc/voidFractionModel_dividedVoidFraction.txt
+++ b/doc/voidFractionModel_dividedVoidFraction.txt
@ -46,7 +46,9 @@ The particle volume occupied in the CFD domain can be adjusted by the parameter
 In the basic implementation of solvers, the void fraction is calculated based on all particles. Depending on the solver used, the void fraction calculation is also performed for a certain type of particles.
 The void fraction calculation is based on a three-step approach (reset, set and interpolate), i.e., the void fraction is time interpolated from a previous and a next void fraction field. Appropriate names for these fields have to be specified in the sub-dictionaries voidFracFieldNamesPrev and voidFracFieldNamesNext in the couplingProperties dictionary.

-[Restrictions:] none.
+[Restrictions:]
+
+none

 [Related commands:]