mirror of
https://develop.openfoam.com/Development/openfoam.git
synced 2025-11-28 03:28:01 +00:00
Simplify and correct Doxygen lists using '-' rather than '\li \c'
This commit is contained in:
@ -37,11 +37,10 @@ Description
|
||||
\endverbatim
|
||||
|
||||
Types of coordinateRotation:
|
||||
|
||||
\li 1. axesRotation
|
||||
\li 2. STARCDRotation
|
||||
\li 3. cylindrical
|
||||
\li 4. EulerCoordinateRotation
|
||||
-# axesRotation
|
||||
-# STARCDRotation
|
||||
-# cylindrical
|
||||
-# EulerCoordinateRotation
|
||||
|
||||
SourceFiles
|
||||
coordinateRotation.C
|
||||
|
||||
@ -26,21 +26,21 @@ Class
|
||||
|
||||
Description
|
||||
A local coordinate rotation.
|
||||
|
||||
The cell based rotational field can be created in two ways:
|
||||
-# Each rotational tensor is defined with two vectors (\c dir and \c e3)
|
||||
where <tt>dir = cellC - origin</tt> and \c e3 is the rotation axis.
|
||||
Per each cell an axesRotation type of rotation is created
|
||||
(cylindrical coordinates). For example:
|
||||
\verbatim
|
||||
cylindrical
|
||||
{
|
||||
type localAxes;
|
||||
e3 (0 0 1);
|
||||
}
|
||||
\endverbatim
|
||||
|
||||
\li 1. Each rotational tensor is defined with two vectors (\c dir and \c e3)
|
||||
where <tt>dir = cellC - origin</tt> and \c e3 is the rotation axis.
|
||||
Per each cell an axesRotation type of rotation is created
|
||||
(cylindrical coordinates). For example:
|
||||
\verbatim
|
||||
cylindrical
|
||||
{
|
||||
type localAxes;
|
||||
e3 (0 0 1);
|
||||
}
|
||||
\endverbatim
|
||||
|
||||
\li 2. The rotational tensor field is provided at construction.
|
||||
-# The rotational tensor field is provided at construction.
|
||||
|
||||
SourceFiles
|
||||
cylindrical.C
|
||||
|
||||
@ -43,15 +43,13 @@ Description
|
||||
\endverbatim
|
||||
|
||||
Types of coordinateRotation:
|
||||
|
||||
\li 1. axesRotation
|
||||
\li 2. STARCDRotation
|
||||
\li 3. cylindrical
|
||||
\li 4. EulerCoordinateRotation
|
||||
-# axesRotation
|
||||
-# \link STARCDCoordinateRotation STARCDRotation \endlink
|
||||
-# cylindricalCS cylindrical
|
||||
-# EulerCoordinateRotation
|
||||
|
||||
Type of co-ordinates:
|
||||
|
||||
\li 1. cartesian
|
||||
-# \link cartesianCS cartesian \endlink
|
||||
|
||||
|
||||
SourceFiles
|
||||
|
||||
@ -25,20 +25,18 @@ Class
|
||||
Foam::surfaceLocation
|
||||
|
||||
Description
|
||||
Contains information about location on a triSurface:
|
||||
Contains information about location on a triSurface
|
||||
|
||||
\li pointIndexHit:
|
||||
Access to data:
|
||||
- pointIndexHit provides
|
||||
- location
|
||||
- bool: hit/miss
|
||||
- index (of triangle/point/edge)
|
||||
|
||||
\li elementType():
|
||||
- elementType() provides
|
||||
- what index above relates to. In triangle::proxType
|
||||
|
||||
\li triangle():
|
||||
- triangle() provides
|
||||
- last known triangle
|
||||
|
||||
|
||||
SourceFiles
|
||||
surfaceLocation.C
|
||||
|
||||
|
||||
Reference in New Issue
Block a user