From 8342cdc6eecfae1e58d6c55e49006b553a379995 Mon Sep 17 00:00:00 2001 From: Henry Weller <http://cfd.direct> Date: Thu, 29 Oct 2015 22:41:34 +0000 Subject: [PATCH] Documentation: Use '-' rather than '+' for lists for Doxygen --- .../backgroundMeshDecomposition.H | 6 +++--- .../utilities/mesh/manipulation/refineMesh/refineMesh.C | 6 +++--- .../surface/surfaceBooleanFeatures/surfaceBooleanFeatures.C | 4 ++-- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/backgroundMeshDecomposition/backgroundMeshDecomposition.H b/applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/backgroundMeshDecomposition/backgroundMeshDecomposition.H index 90dde14aa4a..63bb4fba0e0 100644 --- a/applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/backgroundMeshDecomposition/backgroundMeshDecomposition.H +++ b/applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/backgroundMeshDecomposition/backgroundMeshDecomposition.H @@ -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. diff --git a/applications/utilities/mesh/manipulation/refineMesh/refineMesh.C b/applications/utilities/mesh/manipulation/refineMesh/refineMesh.C index 3714b3a7125..02888c6d6bf 100644 --- a/applications/utilities/mesh/manipulation/refineMesh/refineMesh.C +++ b/applications/utilities/mesh/manipulation/refineMesh/refineMesh.C @@ -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. diff --git a/applications/utilities/surface/surfaceBooleanFeatures/surfaceBooleanFeatures.C b/applications/utilities/surface/surfaceBooleanFeatures/surfaceBooleanFeatures.C index 6c4e67dd7d1..97a7fb4730e 100644 --- a/applications/utilities/surface/surfaceBooleanFeatures/surfaceBooleanFeatures.C +++ b/applications/utilities/surface/surfaceBooleanFeatures/surfaceBooleanFeatures.C @@ -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" -- GitLab