STYLE: Updated header file documentation

This commit is contained in:
Andrew Heather
2015-12-09 16:10:35 +00:00
parent 8837a89237
commit abeef3313d
14 changed files with 53 additions and 35 deletions

View File

@ -25,16 +25,15 @@ Application
surfaceBooleanFeatures
Description
Generates the extendedFeatureEdgeMesh for the interface between a boolean
operation on two surfaces. Assumes that the orientation of the surfaces is
correct:
operation on two surfaces.
+ if the operation is union or intersection, that both surface's normals
Assumes that the orientation of the surfaces iscorrect:
- 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:
@verbatim
\verbatim
_______
| |--> n
| ___|___ x
@ -43,14 +42,14 @@ Description
| |
|_______|
@endverbatim
\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"
@verbatim
\verbatim
_______
| |--> n
| ___|___ x
@ -59,7 +58,7 @@ Description
| n <--|
|_______|
@endverbatim
\endverbatim
When the operation is peformed - for union, all of the edges generates where
one surfaces cuts another are all "internal" for union, and "external" for

View File

@ -25,6 +25,9 @@ Application
surfaceClean
Description
Utility to clean surfaces.
Current functionality
- removes baffles
- collapses small edges, removing triangles.
- converts sliver triangles into split edges by projecting point onto

View File

@ -25,12 +25,15 @@ Application
surfaceCoarsen
Description
Surface coarsening using 'bunnylod':
Surface coarsening using `bunnylod'
Reference:
\verbatim
Polygon Reduction Demo
By Stan Melax (c) 1998
mailto:melax@cs.ualberta.ca
http://www.cs.ualberta.ca/~melax
\endverbatim
\*---------------------------------------------------------------------------*/

View File

@ -26,8 +26,9 @@ Application
Description
Calculates the inertia tensor, principal axes and moments of a
command line specified triSurface. Inertia can either be of the
solid body or of a thin shell.
command line specified triSurface.
Inertia can either be of the solid body or of a thin shell.
\*---------------------------------------------------------------------------*/

View File

@ -26,10 +26,16 @@ Application
Description
Refine by splitting all three edges of triangle ('red' refinement).
Neighbouring triangles (which are not marked for refinement get split
in half ('green' refinement). (R. Verfuerth, "A review of a posteriori
in half ('green' refinement).
Reference:
\verbatim
R. Verfuerth, "A review of a posteriori
error estimation and adaptive mesh refinement techniques",
Wiley-Teubner, 1996)
\endverbatim
\*---------------------------------------------------------------------------*/

View File

@ -22,10 +22,10 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Description
Strips any baffle parts of a surface.
Strips any baffle parts of a surface. A baffle region is one which is
reached by walking from an open edge, and stopping when a multiply connected
edge is reached.
A baffle region is one which is reached by walking from an open edge, and
stopping when a multiply connected edge is reached.
\*---------------------------------------------------------------------------*/