Commit 1bfa9127 authored by Chris Greenshields's avatar Chris Greenshields
Browse files

Modified more Description entries in utilities for documenting purposes

parent 2f301617
......@@ -23,7 +23,7 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Description
Hex 2x2x2 refiner
Refines a hex mesh by 2x2x2 cell splitting.
\*---------------------------------------------------------------------------*/
......
......@@ -23,9 +23,10 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Description
Utility to refine cells next to patches. Takes a patchName
and number of layers to refine. Works out cells within these layers
and refines those in the wall-normal direction.
Utility to refine cells next to patches.
Takes a patchName and number of layers to refine. Works out cells within
these layers and refines those in the wall-normal direction.
\*---------------------------------------------------------------------------*/
......
......@@ -23,10 +23,11 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Description
Utility to split cells with flat faces. Uses a geometric cut with a plane
dividing the edge angle into two so might produce funny cells. For hexes
it will use by default a cut from edge onto opposite edge (i.e. purely
topological).
Utility to split cells with flat faces.
Uses a geometric cut with a plane dividing the edge angle into two so
might produce funny cells. For hexes it will use by default a cut from
edge onto opposite edge (i.e. purely topological).
Options:
- split cells from cellSet only
......
......@@ -23,7 +23,7 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Description
Reads .msh format generated by the Adventure system.
Converts .msh file generated by the Adventure system.
Note: the .msh format does not contain any boundary information. It is
purely a description of the internal mesh.
......
......@@ -23,7 +23,7 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Description
read Neutral file format as written by Netgen4.4.
Converts neutral file format as written by Netgen v4.4.
Example:
......
......@@ -23,8 +23,8 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Description
Calculate the dual of a polyMesh. Adheres to all the feature&patch edges.
Calculate the dual of a polyMesh. Adheres to all the feature and patch
edges.
Usage
......
......@@ -79,7 +79,7 @@ int main(int argc, char *argv[])
scaleFactor = 1;
}
}
if (args.optionFound("solids"))
{
meshReaders::STARCD::keepSolids = true;
......
......@@ -23,7 +23,7 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Description
Reads .ele and .node and .face files as written by tetgen.
Converts .ele and .node and .face files, written by tetgen.
Make sure to use add boundary attributes to the smesh file
(5 fifth column in the element section)
......
......@@ -24,8 +24,8 @@ License
Description
Extrude mesh from existing patch (by default outwards facing normals;
optional flips faces)
or from patch read from file.
optional flips faces) or from patch read from file.
Note: Merges close points so be careful.
Type of extrusion prescribed by run-time selectable model.
......
......@@ -23,8 +23,8 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Description
Makes internal faces into boundary faces. Does not duplicate points. Use
mergeOrSplitBaffles if you want this.
Makes internal faces into boundary faces. Does not duplicate points, unlike
mergeOrSplitBaffles.
Note: if any coupled patch face is selected for baffling automatically
the opposite member is selected for baffling as well. Note that this
......
......@@ -26,7 +26,7 @@ Application
flattenMesh
Description
Flatten the front and back planes of a 2D cartesian mesh.
Flattens the front and back planes of a 2D cartesian mesh.
\*---------------------------------------------------------------------------*/
......@@ -90,7 +90,7 @@ int main(int argc, char *argv[])
}
}
twoDCorr.correctPoints(points);
twoDCorr.correctPoints(points);
// Set the precision of the points data to 10
IOstream::defaultPrecision(10);
......
......@@ -23,7 +23,7 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Description
Pick up cells with cell centre 'inside' of surface. Requires surface
Picks up cells with cell centre 'inside' of surface. Requires surface
to be closed and singly connected.
\*---------------------------------------------------------------------------*/
......
......@@ -26,7 +26,7 @@ Application
mergeOrSplitBaffles
Description
Detect faces that share points (baffles). Either merge them or
Detects faces that share points (baffles). Either merge them or
duplicate the points.
Notes:
......
......@@ -23,7 +23,6 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Description
Mirrors a mesh around a given plane.
\*---------------------------------------------------------------------------*/
......
......@@ -23,9 +23,10 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Description
Utility to refine cells in multiple directions. Either supply -all
option to refine all cells (3D refinement for 3D cases; 2D for 2D cases)
or reads a refineMeshDict with
Utility to refine cells in multiple directions.
Either supply -all option to refine all cells (3D refinement for 3D
cases; 2D for 2D cases) or reads a refineMeshDict with
- cellSet to refine
- directions to refine
......
......@@ -23,8 +23,10 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Description
Splits mesh into multiple regions. Each region is defined as a domain
whose cells can all be reached by cell-face-cell walking without crossing
Splits mesh into multiple regions.
Each region is defined as a domain whose cells can all be reached by
cell-face-cell walking without crossing
- boundary faces
- additional faces from faceset (-blockedFaces faceSet).
- any face inbetween differing cellZones (-cellZones)
......
......@@ -27,7 +27,10 @@ Application
Description
Transforms the mesh points in the polyMesh directory according to the
options:
translate, rotate and scale options.
Usage
Options are:
-translate vector
Translates the points by the given vector,
......
......@@ -26,9 +26,10 @@ Application
reconstructParMesh
Description
Reconstructs a mesh using geometric information only. Writes
point/face/cell procAddressing so afterwards reconstructPar can be used to
reconstruct fields.
Reconstructs a mesh using geometric information only.
Writes point/face/cell procAddressing so afterwards reconstructPar can be
used to reconstruct fields.
Note:
- uses geometric matching tolerance (set with -mergeTol option)
......
......@@ -26,8 +26,11 @@ Application
redistributeMeshPar
Description
Parallel redecomposition of mesh. Start with maximum number of processors.
Balances mesh and writes new mesh to new timedirectory.
Redistributes existing decomposed mesh and fields according to the current
settings in the decomposeParDict file.
Must be run on maximum number of source and destination processors.
Balances mesh and writes new mesh to new time directory.
Can also work like decomposePar:
......
......@@ -24,6 +24,7 @@ License
Description
Translates foam output to GMV readable files.
A free post-processor with available binaries from
http://www-xdiv.lanl.gov/XCM/gmv/
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment