Commit 8342cdc6 authored by Henry Weller's avatar Henry Weller
Browse files

Documentation: Use '-' rather than '+' for lists for Doxygen

parent 450e4428
......@@ -30,16 +30,16 @@ Description
The requirements are:
+ To have a decomposition of space which can quickly interrogate an
- To have a decomposition of space which can quickly interrogate an
arbitrary location from any processor to reliably and unambiguously
determine which processor owns the space that the point is in, i.e. as
the vertices move, or need inserted as part of the surface conformation,
send them to the correct proc.
+ To be able to be dynamically built, refined and redistributed to other
- To be able to be dynamically built, refined and redistributed to other
procs the partitioning as the meshing progresses to balance the load.
+ To be able to query whether a sphere (the circumsphere of a Delaunay tet)
- To be able to query whether a sphere (the circumsphere of a Delaunay tet)
overlaps any part of the space defined by the structure, and whether a
ray (Voronoi edge) penetrates any part of the space defined by the
structure, this is what determines if points get referred to a processor.
......
......@@ -28,9 +28,9 @@ Description
Utility to refine cells in multiple directions.
Command-line option handling:
+ If -all specified or no refineMeshDict exists or, refine all cells
+ If -dict <file> specified refine according to <file>
+ If refineMeshDict exists refine according to refineMeshDict
- If -all specified or no refineMeshDict exists or, refine all cells
- If -dict {file} specified refine according to {file}
- If refineMeshDict exists refine according to refineMeshDict
When the refinement or all cells is selected apply 3D refinement for 3D
cases and 2D refinement for 2D cases.
......
......@@ -30,7 +30,7 @@ Description
operation on two surfaces. Assumes that the orientation of the surfaces is
correct:
+ if the operation is union or intersection, that both surface's normals
- if the operation is union or intersection, that both surface's normals
(n) have the same orientation with respect to a point, i.e. surfaces and b
are orientated the same with respect to point x:
......@@ -45,7 +45,7 @@ Description
@endverbatim
+ if the operation is a subtraction, the surfaces should be oppositely
- if the operation is a subtraction, the surfaces should be oppositely
oriented with respect to a point, i.e. for (a - b), then b's orientation
should be such that x is "inside", and a's orientation such that x is
"outside"
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment