zhyang-dev/CFDEMcoupling-PFM
1
0
Fork 0
mirror of https://github.com/ParticulateFlow/CFDEMcoupling-PFM.git synced 2025-12-08 06:37:44 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

[DOC]fix up formatting for (IMPORTANT) NOTEs

Browse Source
This commit is contained in:
danielque
2018-07-18 14:25:12 +02:00
parent b56390e3de
commit 61d7a88793
20 changed files with 51 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
doc/IOModel.txt
View File

@ -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:]

4
doc/averagingModel.txt
View File

@ -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:]

3
doc/clockModel.txt
View File

@ -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:]

3
doc/dataExchangeModel.txt
View File

@ -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:]

2
doc/forceModel.txt
View File

@ -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:]

4
doc/forceModel_virtualMassForce.txt
View File

@ -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:]

4
doc/forceSubModel.txt
View File

@ -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.

3
doc/liggghtsCommandModel.txt
View File

@ -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:]

3
doc/liggghtsCommandModel_execute.txt
View File

@ -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.

5
doc/liggghtsCommandModel_readLiggghtsData.txt
View File

@ -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:]

5
doc/liggghtsCommandModel_runLiggghts.txt
View File

@ -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:]

3
doc/locateModel.txt
View File

@ -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:]

3
doc/meshMotionModel.txt
View File

@ -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:]

3
doc/momCoupleModel.txt
View File

@ -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.

3
doc/probeModel.txt
View File

@ -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:]

3
doc/probeModel_noProbe.txt
View File

@ -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:]

3
doc/regionModel.txt
View File

@ -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:]

9
doc/smoothingModel.txt
View File

@ -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:]

9
doc/smoothingModel_constDiffSmoothing.txt
View File

@ -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:]

3
doc/voidFractionModel.txt
View File

@ -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:]