minor documentation cleanups

2025-11-28 03:28:01 +00:00 · 2008-06-10 15:00:47 +02:00
parent 9c35ea85bb
commit 0e00a43eec
10 changed files with 42 additions and 35 deletions
--- a/src/OpenFOAM/meshes/polyMesh/zones/ZoneID/ZoneID.H
+++ b/src/OpenFOAM/meshes/polyMesh/zones/ZoneID/ZoneID.H
@ -26,7 +26,7 @@ Class
    Foam::ZoneID

 Description
-    A class holds the data needed to identify a zone in a dynamic mesh.
+    A class that holds the data needed to identify a zone in a dynamic mesh.

    The zone is identified by name.
    Its index in the zoneMesh is updated if the mesh has changed.
--- a/src/decompositionAgglomeration/decompositionMethods/geomDecomp/geomDecomp.H
+++ b/src/decompositionAgglomeration/decompositionMethods/geomDecomp/geomDecomp.H
@ -26,6 +26,7 @@ Class
    Foam::geomDecomp

 Description
+    Geometrical domain decomposition

 SourceFiles
    geomDecomp.C
--- a/src/decompositionAgglomeration/decompositionMethods/metisDecomp/metisDecomp.H
+++ b/src/decompositionAgglomeration/decompositionMethods/metisDecomp/metisDecomp.H
@ -26,6 +26,7 @@ Class
    Foam::metisDecomp

 Description
+    Metis domain decomposition

 SourceFiles
    metisDecomp.C
--- a/src/decompositionAgglomeration/decompositionMethods/simpleGeomDecomp/simpleGeomDecomp.C
+++ b/src/decompositionAgglomeration/decompositionMethods/simpleGeomDecomp/simpleGeomDecomp.C
@ -55,7 +55,7 @@ namespace Foam

 // assignToProcessorGroup : given nCells cells and nProcGroup processor
 // groups to share them, how do we share them out? Answer : each group
-// gets nCells/nProocGroup cells, and the first few get one
+// gets nCells/nProcGroup cells, and the first few get one
 // extra to make up the numbers. This should produce almost
 // perfect load balancing

--- a/src/dynamicFvMesh/dynamicInkJetFvMesh/dynamicInkJetFvMesh.H
+++ b/src/dynamicFvMesh/dynamicInkJetFvMesh/dynamicInkJetFvMesh.H
@ -29,7 +29,7 @@ Description
    Mesh motion specifically for the "pumping" system of an ink-jet
    injector.

-    The set of points in the "pumping" region are compressed and expended
+    The set of points in the "pumping" region are compressed and expanded
    sinusoidally to impose a sinusoidal variation of the flow at the
    nozzle exit.

--- a/src/finiteVolume/fields/fvPatchFields/derived/turbulentMixingLengthFrequencyInlet/turbulentMixingLengthFrequencyInletFvPatchScalarField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/turbulentMixingLengthFrequencyInlet/turbulentMixingLengthFrequencyInletFvPatchScalarField.H
@ -23,7 +23,7 @@ License
    Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA

 Class
-    Foam::turbulentMixingLengthDissipationRateInletFvPatchScalarField
+    Foam::turbulentMixingLengthFrequencyInletFvPatchScalarField

 Description
    Calculate omega via the mixing length
--- a/src/finiteVolume/fvMesh/wallDist/wallPointYPlus/wallPointYPlus.H
+++ b/src/finiteVolume/fvMesh/wallDist/wallPointYPlus/wallPointYPlus.H
@ -27,10 +27,11 @@ Class

 Description
    Holds information (coordinate and yStar) regarding nearest wall point.
+
    Used in VanDriest wall damping where the interest is in y+ but only
    needs to be calculated up to e.g. y+ < 200. In all other cells/faces
-    (since y gets initialized to GREAT and yStar to 1) the damping function
-    becomes 1
+    the damping function becomes 1, since y gets initialized to GREAT and
+    yStar to 1.

 SourceFiles
    wallPointYPlusI.H
--- a/src/fvMotionSolver/fvMotionSolvers/displacement/interpolation/displacementInterpolationFvMotionSolver.H
+++ b/src/fvMotionSolver/fvMotionSolvers/displacement/interpolation/displacementInterpolationFvMotionSolver.H
@ -26,17 +26,19 @@ Class
    Foam::displacementInterpolationFvMotionSolver

 Description
-    Mesh motion solver for an fvMesh. Scales inbetween motion prescribed on
-    faceZones. Works out per point the distance between the bounding
-    face zones (in all three directions) at the start and then every time
-    step
+    Mesh motion solver for an fvMesh.
+
+    Scales inbetween motion prescribed on faceZones. Works out per point
+    the distance between the bounding face zones (in all three directions)
+    at the start and then every time step
    - moves the faceZones based on tables
    - interpolates the displacement of all points based on the
      faceZone motion.

-    Tables are in the constant/tables directory.
+    Tables are in the <verbatim>constant/tables</verbatim> directory.

-    Note: could be a motionSolver - does not use any fvMesh structure.
+Note
+    could be a motionSolver - does not use any fvMesh structure.

 SourceFiles
    displacementInterpolationFvMotionSolver.C
--- a/src/meshTools/octree/treeBoundBox.H
+++ b/src/meshTools/octree/treeBoundBox.H
@ -32,6 +32,7 @@ Description

    On the back plane (z=0):

+    @verbatim
        Y
        ^
        |
@ -42,6 +43,7 @@ Description
        |        |
        |0      1|
        +--------+->X
+    @endverbatim

    For the front plane add 4 to the point labels.

--- a/src/sampling/sampledSet/writers/writer/writer.H
+++ b/src/sampling/sampledSet/writers/writer/writer.H
@ -26,15 +26,15 @@ Class
    Foam::writer

 Description
-    base class for graphics format writing. Entry points are
-    - write(..). Write to an Ostream a table of points with corresponding
-    values.
-
-    - write(scalar/vector/tensor). Write single scalar/vector/tensor.
+    Base class for graphics format writing. Entry points are
+    - write(..). \n
+      Write to an Ostream a table of points with corresponding values.
+    - write(scalar/vector/tensor). \n
+      Write single scalar/vector/tensor.
      Default is to write space separated components.

    Example:
-
+    @verbatim
        // Construct writer of xmgr type
        autoPtr<writer<scalar> > scalarFormatter(writer<scalar>::New("xmgr"));

@ -51,7 +51,7 @@ Description
            "U.component(0)",   // name of values
            vals                // values
        );
-
+    @endverbatim

 SourceFiles
    writer.C