Rationalized Doxygen documentation of command-line options

This commit is contained in:
Henry Weller
2016-06-17 09:11:58 +01:00
parent 0b333a4249
commit 7b75d81269
28 changed files with 389 additions and 360 deletions

View File

@ -29,31 +29,32 @@ Description
edges.
Usage
- polyDualMesh featureAngle
\b polyDualMesh featureAngle
Detects any boundary edge > angle and creates multiple boundary faces
for it. Normal behaviour is to have each point become a cell
(1.5 behaviour)
\param -concaveMultiCells
Creates multiple cells for each point on a concave edge. Might limit
the amount of distortion on some meshes.
Options:
- \par -concaveMultiCells
Creates multiple cells for each point on a concave edge. Might limit
the amount of distortion on some meshes.
\param -splitAllFaces
Normally only constructs a single face between two cells. This single face
might be too distorted. splitAllFaces will create a single face for every
original cell the face passes through. The mesh will thus have
multiple faces inbetween two cells! (so is not strictly upper-triangular
anymore - checkMesh will complain)
- \par -splitAllFaces
Normally only constructs a single face between two cells. This single
face might be too distorted. splitAllFaces will create a single face for
every original cell the face passes through. The mesh will thus have
multiple faces inbetween two cells! (so is not strictly upper-triangular
anymore - checkMesh will complain)
\param -doNotPreserveFaceZones:
By default all faceZones are preserved by marking all faces, edges and
points on them as features. The -doNotPreserveFaceZones disables this
behaviour.
- \par -doNotPreserveFaceZones:
By default all faceZones are preserved by marking all faces, edges and
points on them as features. The -doNotPreserveFaceZones disables this
behaviour.
Note: is just a driver for meshDualiser. Substitute your own
simpleMarkFeatures to have different behaviour.
Note
It is just a driver for meshDualiser. Substitute your own simpleMarkFeatures
to have different behaviour.
\*---------------------------------------------------------------------------*/