ENH: (further) Doxygen documentation updates for module support

This commit is contained in:
Andrew Heather
2016-06-27 20:34:19 +01:00
parent 4a0c74d292
commit efb39a8790
257 changed files with 1122 additions and 18 deletions

View File

@ -0,0 +1,37 @@
/*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2016 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
This file is part of OpenFOAM.
OpenFOAM is free software: you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free
Software Foundation, either version 3 of the License, or (at your option)
any later version.
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
details.
You should have received a copy of the GNU General Public License along with
OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
\page pageUtilities Utilities
\section secUtilities Overview
The available utilities are grouped into the following categories:
- \ref grpMeshUtilities
- \ref grpMiscUtilities
- \ref grpPreProcessingUtilities
- \ref grpPostProcessingUtilities
- \ref grpThermoUtilities
- \ref grpSurfaceUtilities
\*---------------------------------------------------------------------------*/

View File

@ -0,0 +1,73 @@
/*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2016 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
This file is part of OpenFOAM.
OpenFOAM is free software: you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free
Software Foundation, either version 3 of the License, or (at your option)
any later version.
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
details.
You should have received a copy of the GNU General Public License along with
OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
\defgroup grpUtilities Utilities
@{
This group contains utilities
@}
\defgroup grpMeshUtilities Mesh
@{
\ingroup grpUtilities
This group contains meshing utilities
@}
\defgroup grpPreProcessingUtilities Pre-processing
@{
\ingroup grpUtilities
This group contains pre-processing utilities
@}
\defgroup grpPostProcessingUtilities Post-processing
@{
\ingroup grpUtilities
This group contains post-processing utilities
@}
\defgroup grpParallelUtilities Parallel
@{
\ingroup grpUtilities
This group contains parallel utilities
@}
\defgroup grpSurfaceUtilities Surface
@{
\ingroup grpUtilities
This group contains surface utilities
@}
\defgroup grpThermophysicalUtilities Thermophysical
@{
\ingroup grpUtilities
This group contains thermophysical utilities
@}
\defgroup grpMiscUtilities Miscellaneous
@{
\ingroup grpUtilities
This group contains miscellaneous utilities
@}
\*---------------------------------------------------------------------------*/

View File

@ -24,6 +24,9 @@ License
Application Application
PDRMesh PDRMesh
Group
grpMeshAdvancedUtilities
Description Description
Mesh and field preparation utility for PDR type simulations. Mesh and field preparation utility for PDR type simulations.

View File

@ -24,6 +24,9 @@ License
Application Application
collapseEdges collapseEdges
Group
grpMeshAdvancedUtilities
Description Description
Collapses short edges and combines edges that are in line. Collapses short edges and combines edges that are in line.

View File

@ -24,6 +24,9 @@ License
Application Application
combinePatchFaces combinePatchFaces
Group
grpMeshAdvancedUtilities
Description Description
Checks for multiple patch faces on same cell and combines them. Checks for multiple patch faces on same cell and combines them.
Multiple patch faces can result from e.g. removal of refined Multiple patch faces can result from e.g. removal of refined

View File

@ -24,6 +24,9 @@ License
Application Application
modifyMesh modifyMesh
Group
grpMeshAdvancedUtilities
Description Description
Manipulates mesh elements. Manipulates mesh elements.

View File

@ -24,6 +24,9 @@ License
Application Application
refineHexMesh refineHexMesh
Group
grpMeshAdvancedUtilities
Description Description
Refines a hex mesh by 2x2x2 cell splitting. Refines a hex mesh by 2x2x2 cell splitting.

View File

@ -24,6 +24,9 @@ License
Application Application
refineWallLayer refineWallLayer
Group
grpMeshAdvancedUtilities
Description Description
Utility to refine cells next to patches. Utility to refine cells next to patches.

View File

@ -24,6 +24,9 @@ License
Application Application
refinementLevel refinementLevel
Group
grpMeshAdvancedUtilities
Description Description
Tries to figure out what the refinement level is on refined cartesian Tries to figure out what the refinement level is on refined cartesian
meshes. Run BEFORE snapping. meshes. Run BEFORE snapping.

View File

@ -24,6 +24,9 @@ License
Application Application
removeFaces removeFaces
Group
grpMeshAdvancedUtilities
Description Description
Utility to remove faces (combines cells on both sides). Utility to remove faces (combines cells on both sides).

View File

@ -24,6 +24,9 @@ License
Application Application
selectCells selectCells
Group
grpMeshAdvancedUtilities
Description Description
Select cells in relation to surface. Select cells in relation to surface.

View File

@ -24,6 +24,9 @@ License
Application Application
snappyRefineMesh snappyRefineMesh
Group
grpMeshAdvancedUtilities
Description Description
Utility to refine cells near to a surface. Utility to refine cells near to a surface.

View File

@ -24,6 +24,9 @@ License
Application Application
splitCells splitCells
Group
grpMeshAdvancedUtilities
Description Description
Utility to split cells with flat faces. Utility to split cells with flat faces.

View File

@ -21,6 +21,12 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Application
ccm26ToFoam
Group
grpMeshConversionUtilities
Description Description
Reads CCM files as written by Prostar/ccm using ccm 2.6 (not 2.4) Reads CCM files as written by Prostar/ccm using ccm 2.6 (not 2.4)

View File

@ -24,6 +24,9 @@ License
Application Application
ansysToFoam ansysToFoam
Group
grpMeshConversionUtilities
Description Description
Converts an ANSYS input mesh file, exported from I-DEAS, Converts an ANSYS input mesh file, exported from I-DEAS,
to OpenFOAM format. to OpenFOAM format.

View File

@ -24,6 +24,9 @@ License
Application Application
cfx4ToFoam cfx4ToFoam
Group
grpMeshConversionUtilities
Description Description
Converts a CFX 4 mesh to OpenFOAM format. Converts a CFX 4 mesh to OpenFOAM format.

View File

@ -24,6 +24,9 @@ License
Application Application
datToFoam datToFoam
Group
grpMeshConversionUtilities
Description Description
Reads in a datToFoam mesh file and outputs a points file. Used in Reads in a datToFoam mesh file and outputs a points file. Used in
conjunction with blockMesh. conjunction with blockMesh.

View File

@ -24,6 +24,9 @@ License
Application Application
fluent3DMeshToFoam fluent3DMeshToFoam
Group
grpMeshConversionUtilities
Description Description
Converts a Fluent mesh to OpenFOAM format. Converts a Fluent mesh to OpenFOAM format.

View File

@ -24,6 +24,9 @@ License
Application Application
fluentMeshToFoam fluentMeshToFoam
Group
grpMeshConversionUtilities
Description Description
Converts a Fluent mesh to OpenFOAM format Converts a Fluent mesh to OpenFOAM format
including multiple region and region boundary handling. including multiple region and region boundary handling.

View File

@ -24,6 +24,9 @@ License
Application Application
foamMeshToFluent foamMeshToFluent
Group
grpMeshConversionUtilities
Description Description
Writes out the OpenFOAM mesh in Fluent mesh format. Writes out the OpenFOAM mesh in Fluent mesh format.

View File

@ -24,6 +24,9 @@ License
Application Application
foamToStarMesh foamToStarMesh
Group
grpMeshConversionUtilities
Description Description
Reads an OpenFOAM mesh and writes a pro-STAR (v4) bnd/cel/vrt format. Reads an OpenFOAM mesh and writes a pro-STAR (v4) bnd/cel/vrt format.

View File

@ -24,6 +24,9 @@ License
Application Application
foamToSurface foamToSurface
Group
grpMeshConversionUtilities
Description Description
Reads an OpenFOAM mesh and writes the boundaries in a surface format. Reads an OpenFOAM mesh and writes the boundaries in a surface format.

View File

@ -24,6 +24,9 @@ License
Application Application
gambitToFoam gambitToFoam
Group
grpMeshConversionUtilities
Description Description
Converts a GAMBIT mesh to OpenFOAM format. Converts a GAMBIT mesh to OpenFOAM format.

View File

@ -24,6 +24,9 @@ License
Application Application
gmshToFoam gmshToFoam
group
grpMeshConversionUtilities
Description Description
Reads .msh file as written by Gmsh. Reads .msh file as written by Gmsh.

View File

@ -24,6 +24,9 @@ License
Application Application
ideasUnvToFoam ideasUnvToFoam
Group
grpMeshConversionUtilities
Description Description
I-Deas unv format mesh conversion. I-Deas unv format mesh conversion.

View File

@ -24,6 +24,9 @@ License
Application Application
kivaToFoam kivaToFoam
Group
grpMeshConversionUtilities
Description Description
Converts a KIVA3v grid to OpenFOAM format. Converts a KIVA3v grid to OpenFOAM format.

View File

@ -24,6 +24,9 @@ License
Application Application
mshToFoam mshToFoam
Group
grpMeshConversionUtilities
Description Description
Converts .msh file generated by the Adventure system. Converts .msh file generated by the Adventure system.

View File

@ -24,6 +24,9 @@ License
Application Application
netgenNeutralToFoam netgenNeutralToFoam
Group
grpMeshConversionUtilities
Description Description
Converts neutral file format as written by Netgen v4.4. Converts neutral file format as written by Netgen v4.4.

View File

@ -24,6 +24,9 @@ License
Application Application
plot3dToFoam plot3dToFoam
Group
grpMeshConversionUtilities
Description Description
Plot3d mesh (ascii/formatted format) converter. Plot3d mesh (ascii/formatted format) converter.

View File

@ -24,6 +24,9 @@ License
Application Application
sammToFoam sammToFoam
Group
grpMeshConversionUtilities
Description Description
Converts a Star-CD (v3) SAMM mesh to OpenFOAM format. Converts a Star-CD (v3) SAMM mesh to OpenFOAM format.

View File

@ -24,6 +24,9 @@ License
Application Application
star3ToFoam star3ToFoam
Group
grpMeshConversionUtilities
Description Description
Converts a Star-CD (v3) pro-STAR mesh into OpenFOAM format. Converts a Star-CD (v3) pro-STAR mesh into OpenFOAM format.

View File

@ -24,6 +24,9 @@ License
Application Application
star4ToFoam star4ToFoam
Group
grpMeshConversionUtilities
Description Description
Converts a Star-CD (v4) pro-STAR mesh into OpenFOAM format. Converts a Star-CD (v4) pro-STAR mesh into OpenFOAM format.

View File

@ -24,6 +24,9 @@ License
Application Application
tetgenToFoam tetgenToFoam
Group
grpMeshConversionUtilities
Description Description
Converts .ele and .node and .face files, written by tetgen. Converts .ele and .node and .face files, written by tetgen.

View File

@ -21,6 +21,12 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Application
vtkUnstructuredToFoam
Group
grpMeshConversionUtilities
Description Description
Converts ascii .vtk (legacy format) file generated by vtk/paraview. Converts ascii .vtk (legacy format) file generated by vtk/paraview.

View File

@ -24,6 +24,9 @@ License
Application Application
writeMeshObj writeMeshObj
Group
grpMeshConversionUtilities
Description Description
For mesh debugging: writes mesh as three separate OBJ files which can For mesh debugging: writes mesh as three separate OBJ files which can
be viewed with e.g. javaview. be viewed with e.g. javaview.

View File

@ -0,0 +1,51 @@
/*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2016 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
This file is part of OpenFOAM.
OpenFOAM is free software: you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free
Software Foundation, either version 3 of the License, or (at your option)
any later version.
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
details.
You should have received a copy of the GNU General Public License along with
OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
\defgroup grpMeshGenerationUtilities Generation
@{
\ingroup grpMeshUtilities
This group contains mesh generation utilities
@}
\defgroup grpMeshConversionUtilities Conversion
@{
\ingroup grpMeshUtilities
This group contains mesh conversion utilities
@}
\defgroup grpMeshManipulationUtilities Manipulation
@{
\ingroup grpMeshUtilities
This group contains mesh generation utilities
@}
\defgroup grpMeshAdvancedUtilities Advanced
@{
\ingroup grpMeshUtilities
This group contains advanced mesh utilities
@}
\*---------------------------------------------------------------------------*/

View File

@ -24,6 +24,9 @@ License
Application Application
blockMesh blockMesh
Group
grpMeshGenerationUtilities
Description Description
A multi-block mesh generator. A multi-block mesh generator.

View File

@ -24,6 +24,9 @@ License
Application Application
extrudeMesh extrudeMesh
Group
grpMeshGenerationUtilities
Description Description
Extrude mesh from existing patch (by default outwards facing normals; 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.

View File

@ -24,6 +24,9 @@ License
Application Application
extrudeToRegionMesh extrudeToRegionMesh
Group
grpMeshGenerationUtilities
Description Description
Extrude faceZones (internal or boundary faces) or faceSets (boundary faces Extrude faceZones (internal or boundary faces) or faceSets (boundary faces
only) into a separate mesh (as a different region). only) into a separate mesh (as a different region).

View File

@ -24,6 +24,9 @@ License
Application Application
extrude2DMesh extrude2DMesh
Group
grpMeshGenerationUtilities
Description Description
Takes 2D mesh (all faces 2 points only, no front and back faces) and Takes 2D mesh (all faces 2 points only, no front and back faces) and
creates a 3D mesh by extruding with specified thickness. creates a 3D mesh by extruding with specified thickness.

View File

@ -24,6 +24,9 @@ License
Application Application
foamyHexMesh foamyHexMesh
Group
grpMeshGenerationUtilities
Description Description
Conformal Voronoi automatic mesh generator Conformal Voronoi automatic mesh generator

View File

@ -24,6 +24,9 @@ License
Application Application
foamyQuadMesh foamyQuadMesh
Group
grpMeshGenerationUtilities
Description Description
Conformal-Voronoi 2D extruding automatic mesher with grid or read Conformal-Voronoi 2D extruding automatic mesher with grid or read
initial points and point position relaxation with optional initial points and point position relaxation with optional

View File

@ -24,6 +24,9 @@ License
Application Application
snappyHexMesh snappyHexMesh
Group
grpMeshGenerationUtilities
Description Description
Automatic split hex mesher. Refines and snaps to surface. Automatic split hex mesher. Refines and snaps to surface.

View File

@ -24,6 +24,9 @@ License
Application Application
attachMesh attachMesh
Group
grpMeshManipulationUtilities
Description Description
Attach topologically detached mesh using prescribed mesh modifiers. Attach topologically detached mesh using prescribed mesh modifiers.

View File

@ -24,6 +24,9 @@ License
Application Application
autoPatch autoPatch
Group
grpMeshManipulationUtilities
Description Description
Divides external faces into patches based on (user supplied) feature Divides external faces into patches based on (user supplied) feature
angle. angle.

View File

@ -24,6 +24,9 @@ License
Application Application
checkMesh checkMesh
Group
grpMeshManipulationUtilities
Description Description
Checks validity of a mesh. Checks validity of a mesh.

View File

@ -24,6 +24,9 @@ License
Application Application
createBaffles createBaffles
Group
grpMeshManipulationUtilities
Description Description
Makes internal faces into boundary faces. Does not duplicate points, unlike Makes internal faces into boundary faces. Does not duplicate points, unlike
mergeOrSplitBaffles. mergeOrSplitBaffles.

View File

@ -24,6 +24,9 @@ License
Application Application
createPatch createPatch
Group
grpMeshManipulationUtilities
Description Description
Utility to create patches out of selected boundary faces. Faces come either Utility to create patches out of selected boundary faces. Faces come either
from existing patches or from a faceSet. from existing patches or from a faceSet.

View File

@ -24,6 +24,9 @@ License
Application Application
deformedGeom deformedGeom
Group
grpMeshManipulationUtilities
Description Description
Deforms a polyMesh using a displacement field U and a scaling factor Deforms a polyMesh using a displacement field U and a scaling factor
supplied as an argument. supplied as an argument.

View File

@ -24,6 +24,9 @@ License
Application Application
flattenMesh flattenMesh
Group
grpMeshManipulationUtilities
Description Description
Flattens the front and back planes of a 2D cartesian mesh. Flattens the front and back planes of a 2D cartesian mesh.

View File

@ -24,6 +24,9 @@ License
Application Application
insideCells insideCells
Group
grpMeshManipulationUtilities
Description Description
Picks up cells with cell centre 'inside' of surface. Picks up cells with cell centre 'inside' of surface.
Requires surface to be closed and singly connected. Requires surface to be closed and singly connected.

View File

@ -24,6 +24,9 @@ License
Application Application
mergeMeshes mergeMeshes
Group
grpMeshManipulationUtilities
Description Description
Merges two meshes. Merges two meshes.

View File

@ -24,6 +24,9 @@ License
Application Application
mergeOrSplitBaffles mergeOrSplitBaffles
Group
grpMeshManipulationUtilities
Description Description
Detects faces that share points (baffles). Either merge them or Detects faces that share points (baffles). Either merge them or
duplicate the points. duplicate the points.

View File

@ -24,6 +24,9 @@ License
Application Application
mirrorMesh mirrorMesh
Group
grpMeshManipulationUtilities
Description Description
Mirrors a mesh around a given plane. Mirrors a mesh around a given plane.

View File

@ -24,6 +24,9 @@ License
Application Application
moveDynamicMesh moveDynamicMesh
Group
grpMeshManipulationUtilities
Description Description
Mesh motion and topological mesh changes utility. Mesh motion and topological mesh changes utility.

View File

@ -24,6 +24,9 @@ License
Application Application
moveEngineMesh moveEngineMesh
Group
grpMeshManipulationUtilities
Description Description
Solver for moving meshes for engine calculations. Solver for moving meshes for engine calculations.

View File

@ -24,6 +24,9 @@ License
Application Application
moveMesh moveMesh
Group
grpMeshManipulationUtilities
Description Description
Solver for moving meshes. Solver for moving meshes.

View File

@ -24,6 +24,9 @@ License
Application Application
objToVTK objToVTK
Group
grpMeshManipulationUtilities
Description Description
Read obj line (not surface!) file and convert into vtk. Read obj line (not surface!) file and convert into vtk.

View File

@ -24,6 +24,9 @@ License
Application Application
orientFaceZone orientFaceZone
Group
grpMeshManipulationUtilities
Description Description
Corrects orientation of faceZone. Corrects orientation of faceZone.

View File

@ -24,6 +24,9 @@ License
Application Application
polyDualMesh polyDualMesh
Group
grpMeshManipulationUtilities
Description Description
Calculates the dual of a polyMesh. Adheres to all the feature and patch Calculates the dual of a polyMesh. Adheres to all the feature and patch
edges. edges.

View File

@ -24,6 +24,9 @@ License
Application Application
refineMesh refineMesh
Group
grpMeshManipulationUtilities
Description Description
Utility to refine cells in multiple directions. Utility to refine cells in multiple directions.

View File

@ -24,6 +24,9 @@ License
Application Application
renumberMesh renumberMesh
Group
grpMeshManipulationUtilities
Description Description
Renumbers the cell list in order to reduce the bandwidth, reading and Renumbers the cell list in order to reduce the bandwidth, reading and
renumbering all fields from all the time directories. renumbering all fields from all the time directories.

View File

@ -24,6 +24,9 @@ License
Application Application
rotateMesh rotateMesh
Group
grpMeshManipulationUtilities
Description Description
Rotates the mesh and fields from the direction n1 to direction n2. Rotates the mesh and fields from the direction n1 to direction n2.

View File

@ -24,6 +24,9 @@ License
Application Application
setSet setSet
Group
grpMeshManipulationUtilities
Description Description
Manipulate a cell/face/point/ set or zone interactively. Manipulate a cell/face/point/ set or zone interactively.

View File

@ -24,6 +24,9 @@ License
Application Application
setsToZones setsToZones
Group
grpMeshManipulationUtilities
Description Description
Add pointZones/faceZones/cellZones to the mesh from similar named Add pointZones/faceZones/cellZones to the mesh from similar named
pointSets/faceSets/cellSets. pointSets/faceSets/cellSets.

View File

@ -24,6 +24,9 @@ License
Application Application
singleCellMesh singleCellMesh
Group
grpMeshManipulationUtilities
Description Description
Reads all fields and maps them to a mesh with all internal faces removed Reads all fields and maps them to a mesh with all internal faces removed
(singleCellFvMesh) which gets written to region "singleCell". (singleCellFvMesh) which gets written to region "singleCell".

View File

@ -24,6 +24,9 @@ License
Application Application
splitMesh splitMesh
Group
grpMeshManipulationUtilities
Description Description
Splits mesh by making internal faces external. Uses attachDetach. Splits mesh by making internal faces external. Uses attachDetach.

View File

@ -24,6 +24,9 @@ License
Application Application
splitMeshRegions splitMeshRegions
Group
grpMeshManipulationUtilities
Description Description
Splits mesh into multiple regions. Splits mesh into multiple regions.

View File

@ -24,6 +24,10 @@ License
Application Application
stitchMesh stitchMesh
Group
grpMeshManipulationUtilities
Description Description
'Stitches' a mesh. 'Stitches' a mesh.

View File

@ -24,6 +24,9 @@ License
Application Application
subsetMesh subsetMesh
Group
grpMeshManipulationUtilities
Description Description
Selects a section of mesh based on a cellSet. Selects a section of mesh based on a cellSet.

View File

@ -24,6 +24,9 @@ License
Application Application
topoSet topoSet
Group
grpMeshManipulationUtilities
Description Description
Operates on cellSets/faceSets/pointSets through a dictionary. Operates on cellSets/faceSets/pointSets through a dictionary.

View File

@ -24,6 +24,9 @@ License
Application Application
transformPoints transformPoints
Group
grpMeshManipulationUtilities
Description Description
Transforms the mesh points in the polyMesh directory according to the Transforms the mesh points in the polyMesh directory according to the
translate, rotate and scale options. translate, rotate and scale options.

View File

@ -24,6 +24,9 @@ License
Application Application
zipUpMesh zipUpMesh
Group
grpMeshManipulationUtilities
Description Description
Reads in a mesh with hanging vertices and zips up the cells to guarantee Reads in a mesh with hanging vertices and zips up the cells to guarantee
that all polyhedral cells of valid shape are closed. that all polyhedral cells of valid shape are closed.

View File

@ -24,6 +24,9 @@ License
Application Application
expandDictionary expandDictionary
Group
grpMiscUtilities
Description Description
Read the dictionary provided as an argument, expand the macros etc. and Read the dictionary provided as an argument, expand the macros etc. and
write the resulting dictionary to standard output. write the resulting dictionary to standard output.

View File

@ -24,6 +24,9 @@ License
Application Application
foamDebugSwitches foamDebugSwitches
Group
grpMiscUtilities
Description Description
Write out all library debug switches. Write out all library debug switches.

View File

@ -24,6 +24,9 @@ License
Application Application
foamFormatConvert foamFormatConvert
Group
grpMiscUtilities
Description Description
Converts all IOobjects associated with a case into the format specified Converts all IOobjects associated with a case into the format specified
in the controlDict. in the controlDict.

View File

@ -24,6 +24,9 @@ License
Application Application
foamHelp foamHelp
Group
grpMiscUtilities
Description Description
Top level wrapper utility around foam help utilities Top level wrapper utility around foam help utilities

View File

@ -24,6 +24,9 @@ License
Application Application
foamInfoExec foamInfoExec
Group
grpMiscUtilities
Description Description
Interrogates a case and prints information to stdout. Interrogates a case and prints information to stdout.

View File

@ -24,6 +24,9 @@ License
Application Application
patchSummary patchSummary
Group
grpMiscUtilities
Description Description
Writes fields and boundary condition info for each patch at each requested Writes fields and boundary condition info for each patch at each requested
time instance. time instance.

View File

@ -24,6 +24,9 @@ License
Application Application
decomposePar decomposePar
Group
grpParallelUtilities
Description Description
Automatically decomposes a mesh and fields of a case for parallel Automatically decomposes a mesh and fields of a case for parallel
execution of OpenFOAM. execution of OpenFOAM.

View File

@ -24,6 +24,9 @@ License
Application Application
reconstructPar reconstructPar
Group
grpParallelUtilities
Description Description
Reconstructs fields of a case that is decomposed for parallel Reconstructs fields of a case that is decomposed for parallel
execution of OpenFOAM. execution of OpenFOAM.

View File

@ -24,6 +24,9 @@ License
Application Application
reconstructParMesh reconstructParMesh
Group
grpParallelUtilities
Description Description
Reconstructs a mesh using geometric information only. Reconstructs a mesh using geometric information only.

View File

@ -24,6 +24,9 @@ License
Application Application
redistributePar redistributePar
Group
grpParallelUtilities
Description Description
Redistributes existing decomposed mesh and fields according to the current Redistributes existing decomposed mesh and fields according to the current
settings in the decomposeParDict file. settings in the decomposeParDict file.

View File

@ -24,6 +24,9 @@ License
Application Application
foamDataToFluent foamDataToFluent
Group
grpPostProcessingUtilities
Description Description
Translates OpenFOAM data to Fluent format. Translates OpenFOAM data to Fluent format.

View File

@ -24,6 +24,9 @@ License
Application Application
foamToEnsight foamToEnsight
Group
grpPostProcessingUtilitie
Description Description
Translates OpenFOAM data to EnSight format. Translates OpenFOAM data to EnSight format.

View File

@ -24,6 +24,9 @@ License
Application Application
foamToEnsightParts foamToEnsightParts
Group
grpPostProcessingUtilities
Description Description
Translates OpenFOAM data to Ensight format. Translates OpenFOAM data to Ensight format.
An Ensight part is created for each cellZone and patch. An Ensight part is created for each cellZone and patch.

View File

@ -24,6 +24,9 @@ License
Application Application
foamToGMV foamToGMV
Group
grpPostProcessingUtilities
Description Description
Translates foam output to GMV readable files. Translates foam output to GMV readable files.

View File

@ -24,6 +24,9 @@ License
Application Application
foamToTecplot360 foamToTecplot360
Group
grpPostProcessingUtilities
Description Description
Tecplot binary file format writer. Tecplot binary file format writer.

View File

@ -24,6 +24,9 @@ License
Application Application
foamToTetDualMesh foamToTetDualMesh
Group
grpPostProcessingUtilities
Description Description
Converts polyMesh results to tetDualMesh. Converts polyMesh results to tetDualMesh.

View File

@ -24,6 +24,9 @@ License
Application Application
foamToVTK foamToVTK
Group
grpPostProcessingUtilities
Description Description
Legacy VTK file format writer. Legacy VTK file format writer.

View File

@ -24,6 +24,9 @@ License
Application Application
smapToFoam smapToFoam
Group
grpPostProcessingUtilities
Description Description
Translates a STAR-CD SMAP data file into OpenFOAM field format. Translates a STAR-CD SMAP data file into OpenFOAM field format.

View File

@ -24,6 +24,9 @@ License
Application Application
foamCalc foamCalc
Group
grpPostProcessingUtilities
Description Description
Generic wrapper for calculating a quantity at each time. Generic wrapper for calculating a quantity at each time.

View File

@ -24,6 +24,9 @@ License
Application Application
particleTracks particleTracks
Group
grpPostProcessingUtilities
Description Description
Generates a VTK file of particle tracks for cases that were computed using Generates a VTK file of particle tracks for cases that were computed using
a tracked-parcel-type cloud. a tracked-parcel-type cloud.

View File

@ -24,6 +24,10 @@ License
Application Application
steadyParticleTracks steadyParticleTracks
Group
grpPostProcessingUtilitie
Description Description
Generates a VTK file of particle tracks for cases that were computed using Generates a VTK file of particle tracks for cases that were computed using
a steady-state cloud a steady-state cloud

View File

@ -24,6 +24,9 @@ License
Application Application
dsmcFieldsCalc dsmcFieldsCalc
Group
grpPostProcessingUtilities
Description Description
Calculate intensive fields (U and T) from averaged extensive fields from a Calculate intensive fields (U and T) from averaged extensive fields from a
DSMC calculation. DSMC calculation.

View File

@ -24,6 +24,9 @@ License
Application Application
engineCompRatio engineCompRatio
Group
grpPostProcessingUtilities
Description Description
Calculate the geometric compression ratio. Calculate the geometric compression ratio.
@ -83,7 +86,7 @@ int main(int argc, char *argv[])
Info<< "\nVmax = " << Vmax Info<< "\nVmax = " << Vmax
<< ", Vmin = " << Vmin << nl << ", Vmin = " << Vmin << nl
<< "Vmax/Vmin = " << Vmax/Vmin << endl; << "Vmax/Vmin = " << Vmax/Vmin << endl;
Info<< "\nEnd\n" << endl; Info<< "\nEnd\n" << endl;
return 0; return 0;

View File

@ -24,6 +24,9 @@ License
Application Application
execFlowFunctionObjects execFlowFunctionObjects
Group
grpPostProcessingUtilities
Description Description
Execute the set of functionObjects specified in the selected dictionary Execute the set of functionObjects specified in the selected dictionary
(which defaults to system/controlDict) for the selected set of times. (which defaults to system/controlDict) for the selected set of times.

View File

@ -24,6 +24,9 @@ License
Application Application
foamListTimes foamListTimes
Group
grpPostProcessingUtilities
Description Description
List times using timeSelector. List times using timeSelector.

View File

@ -24,6 +24,9 @@ License
Application Application
pdfPlot pdfPlot
Group
grpPostProcessingUtilitie
Description Description
Generates a graph of a probability distribution function. Generates a graph of a probability distribution function.

View File

@ -24,6 +24,9 @@ License
Application Application
postChannel postChannel
Group
grpPostProcessingUtilities
Description Description
Post-processes data from channel flow calculations. Post-processes data from channel flow calculations.

Some files were not shown because too many files have changed in this diff Show More