diff --git a/src/OpenFOAM/meshes/polyMesh/zones/ZoneID/ZoneID.H b/src/OpenFOAM/meshes/polyMesh/zones/ZoneID/ZoneID.H index 3c9f0fd653..b7de5d5941 100644 --- 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. diff --git a/src/decompositionAgglomeration/decompositionMethods/geomDecomp/geomDecomp.H b/src/decompositionAgglomeration/decompositionMethods/geomDecomp/geomDecomp.H index 5973683aeb..df5d580707 100644 --- 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 diff --git a/src/decompositionAgglomeration/decompositionMethods/metisDecomp/metisDecomp.H b/src/decompositionAgglomeration/decompositionMethods/metisDecomp/metisDecomp.H index 0dea688dc1..95fc1daa65 100644 --- 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 diff --git a/src/decompositionAgglomeration/decompositionMethods/simpleGeomDecomp/simpleGeomDecomp.C b/src/decompositionAgglomeration/decompositionMethods/simpleGeomDecomp/simpleGeomDecomp.C index a0df1f132f..a630fa6b65 100644 --- 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 diff --git a/src/dynamicFvMesh/dynamicInkJetFvMesh/dynamicInkJetFvMesh.H b/src/dynamicFvMesh/dynamicInkJetFvMesh/dynamicInkJetFvMesh.H index f72091fa3f..a00e09efce 100644 --- 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. diff --git a/src/finiteVolume/fields/fvPatchFields/derived/turbulentMixingLengthFrequencyInlet/turbulentMixingLengthFrequencyInletFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/turbulentMixingLengthFrequencyInlet/turbulentMixingLengthFrequencyInletFvPatchScalarField.H index 621741e05e..b562709968 100644 --- 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 diff --git a/src/finiteVolume/fvMesh/wallDist/wallPointYPlus/wallPointYPlus.H b/src/finiteVolume/fvMesh/wallDist/wallPointYPlus/wallPointYPlus.H index 9936ed56f3..32535f833c 100644 --- 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 upto e.g. y+ < 200. In all other cells/faces - (since y gets initialized to GREAT and yStar to 1) the damping function - becomes 1 + needs to be calculated up to e.g. y+ < 200. In all other cells/faces + the damping function becomes 1, since y gets initialized to GREAT and + yStar to 1. SourceFiles wallPointYPlusI.H diff --git a/src/fvMotionSolver/fvMotionSolvers/displacement/interpolation/displacementInterpolationFvMotionSolver.H b/src/fvMotionSolver/fvMotionSolvers/displacement/interpolation/displacementInterpolationFvMotionSolver.H index c3ad1b6d0e..dca12e68e8 100644 --- 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. + faceZone motion. - Tables are in the constant/tables directory. + Tables are in the constant/tables 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 diff --git a/src/meshTools/octree/treeBoundBox.H b/src/meshTools/octree/treeBoundBox.H index fe70d09baa..a946869ec6 100644 --- a/src/meshTools/octree/treeBoundBox.H +++ b/src/meshTools/octree/treeBoundBox.H @@ -32,16 +32,18 @@ Description On the back plane (z=0): - Y - ^ - | - +--------+ - |2 3| - | | - | | - | | - |0 1| - +--------+->X + @verbatim + Y + ^ + | + +--------+ + |2 3| + | | + | | + | | + |0 1| + +--------+->X + @endverbatim For the front plane add 4 to the point labels. @@ -234,7 +236,7 @@ public: //- Returns octant number given intersection. Midpoint provided. // onEdge set if sample on edge of subOctant. If onEdge // the direction vector determines which octant to use - // (acc. to which octant the sample would be if it were moved + // (acc. to which octant the sample would be if it were moved // along dir) static inline direction subOctant ( @@ -250,7 +252,7 @@ public: inline void searchOrder ( const point& sample, - FixedList& octantOrder + FixedList& octantOrder ) const; //- Intersects other boundingbox? diff --git a/src/sampling/sampledSet/writers/writer/writer.H b/src/sampling/sampledSet/writers/writer/writer.H index 47d2d1f9c2..92110ab4f1 100644 --- 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. - Default is to write space separated components. + 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 > scalarFormatter(writer::New("xmgr")); @@ -51,8 +51,8 @@ Description "U.component(0)", // name of values vals // values ); + @endverbatim - SourceFiles writer.C @@ -90,7 +90,7 @@ protected: //- Generates filename from coordSet and sampled fields fileName getBaseName(const coordSet&, const wordList&) const; - + void writeCoord ( const coordSet& samples,