mirror of
https://develop.openfoam.com/Development/openfoam.git
synced 2025-11-28 03:28:01 +00:00
Modified more Description entries in utilities for documenting purposes
This commit is contained in:
Chris Greenshields
@ -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/
|
||||
|
||||
|
||||
@ -23,7 +23,8 @@ License
|
||||
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
|
||||
|
||||
Description
|
||||
Reader module for Fieldview9 to read Foam mesh&data.
|
||||
Reader module for Fieldview9 to read OpenFOAM mesh and data.
|
||||
|
||||
Creates new 'fvbin' type executable which needs to be installed in place
|
||||
of bin/fvbin.
|
||||
|
||||
|
||||
@ -23,6 +23,7 @@ License
|
||||
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
|
||||
|
||||
Description
|
||||
Generates an .obj file to plot a probability distribution function
|
||||
|
||||
\*---------------------------------------------------------------------------*/
|
||||
|
||||
@ -48,7 +49,7 @@ int main(int argc, char *argv[])
|
||||
(
|
||||
pdf::New(pdfDictionary, rndGen)
|
||||
);
|
||||
|
||||
|
||||
scalar xMin = p->minValue();
|
||||
|
||||
scalar xMax = p->maxValue();
|
||||
|
||||
@ -26,7 +26,8 @@ Application
|
||||
CreateTurbulenceFields
|
||||
|
||||
Description
|
||||
Creates a full setturbulence fields.
|
||||
Creates a full set of turbulence fields.
|
||||
|
||||
- Currently does not output nut and nuTilda
|
||||
|
||||
Source files:
|
||||
|
||||
@ -28,6 +28,7 @@ Application
|
||||
Description
|
||||
Calculates and writes the Co number as a surfaceScalarField obtained
|
||||
from field phi.
|
||||
|
||||
The -noWrite option just outputs the max values without writing the
|
||||
field.
|
||||
|
||||
|
||||
@ -29,6 +29,7 @@ Description
|
||||
Calculates and writes the second largest eigenvalue of the sum of the
|
||||
square of the symmetrical and anti-symmetrical parts of the velocity
|
||||
gradient tensor.
|
||||
|
||||
The -noWrite option has no meaning.
|
||||
|
||||
\*---------------------------------------------------------------------------*/
|
||||
|
||||
@ -27,8 +27,9 @@ Application
|
||||
|
||||
Description
|
||||
Calculates and optionally writes the local Mach number from the velocity
|
||||
field U at each time. The -nowrite option just outputs the max value
|
||||
without writing the field.
|
||||
field U at each time.
|
||||
|
||||
The -nowrite option just outputs the max value without writing the field.
|
||||
|
||||
\*---------------------------------------------------------------------------*/
|
||||
|
||||
|
||||
@ -28,6 +28,7 @@ Application
|
||||
Description
|
||||
Calculates and writes the Pe number as a surfaceScalarField obtained from
|
||||
field phi.
|
||||
|
||||
The -noWrite option just outputs the max/min values without writing
|
||||
the field.
|
||||
|
||||
|
||||
@ -27,6 +27,7 @@ Application
|
||||
|
||||
Description
|
||||
Calculates and writes the second invariant of the velocity gradient tensor.
|
||||
|
||||
The -noWrite option just outputs the max/min values without writing
|
||||
the field.
|
||||
|
||||
|
||||
@ -27,6 +27,7 @@ Application
|
||||
|
||||
Description
|
||||
Calculates and writes the enstrophy of the velocity field U.
|
||||
|
||||
The -noWrite option just outputs the max/min values without writing the
|
||||
field.
|
||||
|
||||
|
||||
@ -27,6 +27,7 @@ Application
|
||||
|
||||
Description
|
||||
Calculates and writes the flowType of velocity field U.
|
||||
|
||||
The -noWrite option has no meaning.
|
||||
|
||||
The flow type parameter is obtained according to the following equation:
|
||||
|
||||
@ -27,6 +27,7 @@ Application
|
||||
|
||||
Description
|
||||
Calculates and writes the scalar field of uprime (sqrt(2/3 k)).
|
||||
|
||||
The -noWrite option just outputs the max/min values without writing
|
||||
the field.
|
||||
|
||||
|
||||
@ -27,6 +27,7 @@ Application
|
||||
|
||||
Description
|
||||
Calculates and writes the vorticity of velocity field U.
|
||||
|
||||
The -noWrite option just outputs the max/min values without writing
|
||||
the field.
|
||||
|
||||
|
||||
@ -22,6 +22,9 @@ License
|
||||
along with OpenFOAM; if not, write to the Free Software Foundation,
|
||||
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
|
||||
|
||||
Description
|
||||
Initialises fields for a molecular dynamics (MD) simulation
|
||||
|
||||
\*---------------------------------------------------------------------------*/
|
||||
|
||||
#include "md.H"
|
||||
|
||||
Reference in New Issue
Block a user