ENH: (further) Doxygen documentation updates for module support
This commit is contained in:
Andrew Heather
parent
4a0c74d292
commit
efb39a8790
37
applications/utilities/doc/utilities.dox
Normal file
37
applications/utilities/doc/utilities.dox
Normal 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
|
||||
|
||||
\*---------------------------------------------------------------------------*/
|
||||
73
applications/utilities/doc/utilitiesDoc.H
Normal file
73
applications/utilities/doc/utilitiesDoc.H
Normal 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
|
||||
@}
|
||||
|
||||
\*---------------------------------------------------------------------------*/
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
PDRMesh
|
||||
|
||||
Group
|
||||
grpMeshAdvancedUtilities
|
||||
|
||||
Description
|
||||
Mesh and field preparation utility for PDR type simulations.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
collapseEdges
|
||||
|
||||
Group
|
||||
grpMeshAdvancedUtilities
|
||||
|
||||
Description
|
||||
Collapses short edges and combines edges that are in line.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
combinePatchFaces
|
||||
|
||||
Group
|
||||
grpMeshAdvancedUtilities
|
||||
|
||||
Description
|
||||
Checks for multiple patch faces on same cell and combines them.
|
||||
Multiple patch faces can result from e.g. removal of refined
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
modifyMesh
|
||||
|
||||
Group
|
||||
grpMeshAdvancedUtilities
|
||||
|
||||
Description
|
||||
Manipulates mesh elements.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
refineHexMesh
|
||||
|
||||
Group
|
||||
grpMeshAdvancedUtilities
|
||||
|
||||
Description
|
||||
Refines a hex mesh by 2x2x2 cell splitting.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
refineWallLayer
|
||||
|
||||
Group
|
||||
grpMeshAdvancedUtilities
|
||||
|
||||
Description
|
||||
Utility to refine cells next to patches.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
refinementLevel
|
||||
|
||||
Group
|
||||
grpMeshAdvancedUtilities
|
||||
|
||||
Description
|
||||
Tries to figure out what the refinement level is on refined cartesian
|
||||
meshes. Run BEFORE snapping.
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
removeFaces
|
||||
|
||||
Group
|
||||
grpMeshAdvancedUtilities
|
||||
|
||||
Description
|
||||
Utility to remove faces (combines cells on both sides).
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
selectCells
|
||||
|
||||
Group
|
||||
grpMeshAdvancedUtilities
|
||||
|
||||
Description
|
||||
Select cells in relation to surface.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
snappyRefineMesh
|
||||
|
||||
Group
|
||||
grpMeshAdvancedUtilities
|
||||
|
||||
Description
|
||||
Utility to refine cells near to a surface.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
splitCells
|
||||
|
||||
Group
|
||||
grpMeshAdvancedUtilities
|
||||
|
||||
Description
|
||||
Utility to split cells with flat faces.
|
||||
|
||||
|
||||
@ -21,6 +21,12 @@ License
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
Application
|
||||
ccm26ToFoam
|
||||
|
||||
Group
|
||||
grpMeshConversionUtilities
|
||||
|
||||
Description
|
||||
Reads CCM files as written by Prostar/ccm using ccm 2.6 (not 2.4)
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
ansysToFoam
|
||||
|
||||
Group
|
||||
grpMeshConversionUtilities
|
||||
|
||||
Description
|
||||
Converts an ANSYS input mesh file, exported from I-DEAS,
|
||||
to OpenFOAM format.
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
cfx4ToFoam
|
||||
|
||||
Group
|
||||
grpMeshConversionUtilities
|
||||
|
||||
Description
|
||||
Converts a CFX 4 mesh to OpenFOAM format.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
datToFoam
|
||||
|
||||
Group
|
||||
grpMeshConversionUtilities
|
||||
|
||||
Description
|
||||
Reads in a datToFoam mesh file and outputs a points file. Used in
|
||||
conjunction with blockMesh.
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
fluent3DMeshToFoam
|
||||
|
||||
Group
|
||||
grpMeshConversionUtilities
|
||||
|
||||
Description
|
||||
Converts a Fluent mesh to OpenFOAM format.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
fluentMeshToFoam
|
||||
|
||||
Group
|
||||
grpMeshConversionUtilities
|
||||
|
||||
Description
|
||||
Converts a Fluent mesh to OpenFOAM format
|
||||
including multiple region and region boundary handling.
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
foamMeshToFluent
|
||||
|
||||
Group
|
||||
grpMeshConversionUtilities
|
||||
|
||||
Description
|
||||
Writes out the OpenFOAM mesh in Fluent mesh format.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
foamToStarMesh
|
||||
|
||||
Group
|
||||
grpMeshConversionUtilities
|
||||
|
||||
Description
|
||||
Reads an OpenFOAM mesh and writes a pro-STAR (v4) bnd/cel/vrt format.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
foamToSurface
|
||||
|
||||
Group
|
||||
grpMeshConversionUtilities
|
||||
|
||||
Description
|
||||
Reads an OpenFOAM mesh and writes the boundaries in a surface format.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
gambitToFoam
|
||||
|
||||
Group
|
||||
grpMeshConversionUtilities
|
||||
|
||||
Description
|
||||
Converts a GAMBIT mesh to OpenFOAM format.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
gmshToFoam
|
||||
|
||||
group
|
||||
grpMeshConversionUtilities
|
||||
|
||||
Description
|
||||
Reads .msh file as written by Gmsh.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
ideasUnvToFoam
|
||||
|
||||
Group
|
||||
grpMeshConversionUtilities
|
||||
|
||||
Description
|
||||
I-Deas unv format mesh conversion.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
kivaToFoam
|
||||
|
||||
Group
|
||||
grpMeshConversionUtilities
|
||||
|
||||
Description
|
||||
Converts a KIVA3v grid to OpenFOAM format.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
mshToFoam
|
||||
|
||||
Group
|
||||
grpMeshConversionUtilities
|
||||
|
||||
Description
|
||||
Converts .msh file generated by the Adventure system.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
netgenNeutralToFoam
|
||||
|
||||
Group
|
||||
grpMeshConversionUtilities
|
||||
|
||||
Description
|
||||
Converts neutral file format as written by Netgen v4.4.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
plot3dToFoam
|
||||
|
||||
Group
|
||||
grpMeshConversionUtilities
|
||||
|
||||
Description
|
||||
Plot3d mesh (ascii/formatted format) converter.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
sammToFoam
|
||||
|
||||
Group
|
||||
grpMeshConversionUtilities
|
||||
|
||||
Description
|
||||
Converts a Star-CD (v3) SAMM mesh to OpenFOAM format.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
star3ToFoam
|
||||
|
||||
Group
|
||||
grpMeshConversionUtilities
|
||||
|
||||
Description
|
||||
Converts a Star-CD (v3) pro-STAR mesh into OpenFOAM format.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
star4ToFoam
|
||||
|
||||
Group
|
||||
grpMeshConversionUtilities
|
||||
|
||||
Description
|
||||
Converts a Star-CD (v4) pro-STAR mesh into OpenFOAM format.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
tetgenToFoam
|
||||
|
||||
Group
|
||||
grpMeshConversionUtilities
|
||||
|
||||
Description
|
||||
Converts .ele and .node and .face files, written by tetgen.
|
||||
|
||||
|
||||
@ -21,6 +21,12 @@ License
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
Application
|
||||
vtkUnstructuredToFoam
|
||||
|
||||
Group
|
||||
grpMeshConversionUtilities
|
||||
|
||||
Description
|
||||
Converts ascii .vtk (legacy format) file generated by vtk/paraview.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
writeMeshObj
|
||||
|
||||
Group
|
||||
grpMeshConversionUtilities
|
||||
|
||||
Description
|
||||
For mesh debugging: writes mesh as three separate OBJ files which can
|
||||
be viewed with e.g. javaview.
|
||||
|
||||
51
applications/utilities/mesh/doc/meshUtilitiesDoc.H
Normal file
51
applications/utilities/mesh/doc/meshUtilitiesDoc.H
Normal 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
|
||||
@}
|
||||
|
||||
\*---------------------------------------------------------------------------*/
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
blockMesh
|
||||
|
||||
Group
|
||||
grpMeshGenerationUtilities
|
||||
|
||||
Description
|
||||
A multi-block mesh generator.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
extrudeMesh
|
||||
|
||||
Group
|
||||
grpMeshGenerationUtilities
|
||||
|
||||
Description
|
||||
Extrude mesh from existing patch (by default outwards facing normals;
|
||||
optional flips faces) or from patch read from file.
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
extrudeToRegionMesh
|
||||
|
||||
Group
|
||||
grpMeshGenerationUtilities
|
||||
|
||||
Description
|
||||
Extrude faceZones (internal or boundary faces) or faceSets (boundary faces
|
||||
only) into a separate mesh (as a different region).
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
extrude2DMesh
|
||||
|
||||
Group
|
||||
grpMeshGenerationUtilities
|
||||
|
||||
Description
|
||||
Takes 2D mesh (all faces 2 points only, no front and back faces) and
|
||||
creates a 3D mesh by extruding with specified thickness.
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
foamyHexMesh
|
||||
|
||||
Group
|
||||
grpMeshGenerationUtilities
|
||||
|
||||
Description
|
||||
Conformal Voronoi automatic mesh generator
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
foamyQuadMesh
|
||||
|
||||
Group
|
||||
grpMeshGenerationUtilities
|
||||
|
||||
Description
|
||||
Conformal-Voronoi 2D extruding automatic mesher with grid or read
|
||||
initial points and point position relaxation with optional
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
snappyHexMesh
|
||||
|
||||
Group
|
||||
grpMeshGenerationUtilities
|
||||
|
||||
Description
|
||||
Automatic split hex mesher. Refines and snaps to surface.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
attachMesh
|
||||
|
||||
Group
|
||||
grpMeshManipulationUtilities
|
||||
|
||||
Description
|
||||
Attach topologically detached mesh using prescribed mesh modifiers.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
autoPatch
|
||||
|
||||
Group
|
||||
grpMeshManipulationUtilities
|
||||
|
||||
Description
|
||||
Divides external faces into patches based on (user supplied) feature
|
||||
angle.
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
checkMesh
|
||||
|
||||
Group
|
||||
grpMeshManipulationUtilities
|
||||
|
||||
Description
|
||||
Checks validity of a mesh.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
createBaffles
|
||||
|
||||
Group
|
||||
grpMeshManipulationUtilities
|
||||
|
||||
Description
|
||||
Makes internal faces into boundary faces. Does not duplicate points, unlike
|
||||
mergeOrSplitBaffles.
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
createPatch
|
||||
|
||||
Group
|
||||
grpMeshManipulationUtilities
|
||||
|
||||
Description
|
||||
Utility to create patches out of selected boundary faces. Faces come either
|
||||
from existing patches or from a faceSet.
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
deformedGeom
|
||||
|
||||
Group
|
||||
grpMeshManipulationUtilities
|
||||
|
||||
Description
|
||||
Deforms a polyMesh using a displacement field U and a scaling factor
|
||||
supplied as an argument.
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
flattenMesh
|
||||
|
||||
Group
|
||||
grpMeshManipulationUtilities
|
||||
|
||||
Description
|
||||
Flattens the front and back planes of a 2D cartesian mesh.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
insideCells
|
||||
|
||||
Group
|
||||
grpMeshManipulationUtilities
|
||||
|
||||
Description
|
||||
Picks up cells with cell centre 'inside' of surface.
|
||||
Requires surface to be closed and singly connected.
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
mergeMeshes
|
||||
|
||||
Group
|
||||
grpMeshManipulationUtilities
|
||||
|
||||
Description
|
||||
Merges two meshes.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
mergeOrSplitBaffles
|
||||
|
||||
Group
|
||||
grpMeshManipulationUtilities
|
||||
|
||||
Description
|
||||
Detects faces that share points (baffles). Either merge them or
|
||||
duplicate the points.
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
mirrorMesh
|
||||
|
||||
Group
|
||||
grpMeshManipulationUtilities
|
||||
|
||||
Description
|
||||
Mirrors a mesh around a given plane.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
moveDynamicMesh
|
||||
|
||||
Group
|
||||
grpMeshManipulationUtilities
|
||||
|
||||
Description
|
||||
Mesh motion and topological mesh changes utility.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
moveEngineMesh
|
||||
|
||||
Group
|
||||
grpMeshManipulationUtilities
|
||||
|
||||
Description
|
||||
Solver for moving meshes for engine calculations.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
moveMesh
|
||||
|
||||
Group
|
||||
grpMeshManipulationUtilities
|
||||
|
||||
Description
|
||||
Solver for moving meshes.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
objToVTK
|
||||
|
||||
Group
|
||||
grpMeshManipulationUtilities
|
||||
|
||||
Description
|
||||
Read obj line (not surface!) file and convert into vtk.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
orientFaceZone
|
||||
|
||||
Group
|
||||
grpMeshManipulationUtilities
|
||||
|
||||
Description
|
||||
Corrects orientation of faceZone.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
polyDualMesh
|
||||
|
||||
Group
|
||||
grpMeshManipulationUtilities
|
||||
|
||||
Description
|
||||
Calculates the dual of a polyMesh. Adheres to all the feature and patch
|
||||
edges.
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
refineMesh
|
||||
|
||||
Group
|
||||
grpMeshManipulationUtilities
|
||||
|
||||
Description
|
||||
Utility to refine cells in multiple directions.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
renumberMesh
|
||||
|
||||
Group
|
||||
grpMeshManipulationUtilities
|
||||
|
||||
Description
|
||||
Renumbers the cell list in order to reduce the bandwidth, reading and
|
||||
renumbering all fields from all the time directories.
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
rotateMesh
|
||||
|
||||
Group
|
||||
grpMeshManipulationUtilities
|
||||
|
||||
Description
|
||||
Rotates the mesh and fields from the direction n1 to direction n2.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
setSet
|
||||
|
||||
Group
|
||||
grpMeshManipulationUtilities
|
||||
|
||||
Description
|
||||
Manipulate a cell/face/point/ set or zone interactively.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
setsToZones
|
||||
|
||||
Group
|
||||
grpMeshManipulationUtilities
|
||||
|
||||
Description
|
||||
Add pointZones/faceZones/cellZones to the mesh from similar named
|
||||
pointSets/faceSets/cellSets.
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
singleCellMesh
|
||||
|
||||
Group
|
||||
grpMeshManipulationUtilities
|
||||
|
||||
Description
|
||||
Reads all fields and maps them to a mesh with all internal faces removed
|
||||
(singleCellFvMesh) which gets written to region "singleCell".
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
splitMesh
|
||||
|
||||
Group
|
||||
grpMeshManipulationUtilities
|
||||
|
||||
Description
|
||||
Splits mesh by making internal faces external. Uses attachDetach.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
splitMeshRegions
|
||||
|
||||
Group
|
||||
grpMeshManipulationUtilities
|
||||
|
||||
Description
|
||||
Splits mesh into multiple regions.
|
||||
|
||||
|
||||
@ -24,6 +24,10 @@ License
|
||||
Application
|
||||
stitchMesh
|
||||
|
||||
Group
|
||||
grpMeshManipulationUtilities
|
||||
|
||||
|
||||
Description
|
||||
'Stitches' a mesh.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
subsetMesh
|
||||
|
||||
Group
|
||||
grpMeshManipulationUtilities
|
||||
|
||||
Description
|
||||
Selects a section of mesh based on a cellSet.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
topoSet
|
||||
|
||||
Group
|
||||
grpMeshManipulationUtilities
|
||||
|
||||
Description
|
||||
Operates on cellSets/faceSets/pointSets through a dictionary.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
transformPoints
|
||||
|
||||
Group
|
||||
grpMeshManipulationUtilities
|
||||
|
||||
Description
|
||||
Transforms the mesh points in the polyMesh directory according to the
|
||||
translate, rotate and scale options.
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
zipUpMesh
|
||||
|
||||
Group
|
||||
grpMeshManipulationUtilities
|
||||
|
||||
Description
|
||||
Reads in a mesh with hanging vertices and zips up the cells to guarantee
|
||||
that all polyhedral cells of valid shape are closed.
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
expandDictionary
|
||||
|
||||
Group
|
||||
grpMiscUtilities
|
||||
|
||||
Description
|
||||
Read the dictionary provided as an argument, expand the macros etc. and
|
||||
write the resulting dictionary to standard output.
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
foamDebugSwitches
|
||||
|
||||
Group
|
||||
grpMiscUtilities
|
||||
|
||||
Description
|
||||
Write out all library debug switches.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
foamFormatConvert
|
||||
|
||||
Group
|
||||
grpMiscUtilities
|
||||
|
||||
Description
|
||||
Converts all IOobjects associated with a case into the format specified
|
||||
in the controlDict.
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
foamHelp
|
||||
|
||||
Group
|
||||
grpMiscUtilities
|
||||
|
||||
Description
|
||||
Top level wrapper utility around foam help utilities
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
foamInfoExec
|
||||
|
||||
Group
|
||||
grpMiscUtilities
|
||||
|
||||
Description
|
||||
Interrogates a case and prints information to stdout.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
patchSummary
|
||||
|
||||
Group
|
||||
grpMiscUtilities
|
||||
|
||||
Description
|
||||
Writes fields and boundary condition info for each patch at each requested
|
||||
time instance.
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
decomposePar
|
||||
|
||||
Group
|
||||
grpParallelUtilities
|
||||
|
||||
Description
|
||||
Automatically decomposes a mesh and fields of a case for parallel
|
||||
execution of OpenFOAM.
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
reconstructPar
|
||||
|
||||
Group
|
||||
grpParallelUtilities
|
||||
|
||||
Description
|
||||
Reconstructs fields of a case that is decomposed for parallel
|
||||
execution of OpenFOAM.
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
reconstructParMesh
|
||||
|
||||
Group
|
||||
grpParallelUtilities
|
||||
|
||||
Description
|
||||
Reconstructs a mesh using geometric information only.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
redistributePar
|
||||
|
||||
Group
|
||||
grpParallelUtilities
|
||||
|
||||
Description
|
||||
Redistributes existing decomposed mesh and fields according to the current
|
||||
settings in the decomposeParDict file.
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
foamDataToFluent
|
||||
|
||||
Group
|
||||
grpPostProcessingUtilities
|
||||
|
||||
Description
|
||||
Translates OpenFOAM data to Fluent format.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
foamToEnsight
|
||||
|
||||
Group
|
||||
grpPostProcessingUtilitie
|
||||
|
||||
Description
|
||||
Translates OpenFOAM data to EnSight format.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
foamToEnsightParts
|
||||
|
||||
Group
|
||||
grpPostProcessingUtilities
|
||||
|
||||
Description
|
||||
Translates OpenFOAM data to Ensight format.
|
||||
An Ensight part is created for each cellZone and patch.
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
foamToGMV
|
||||
|
||||
Group
|
||||
grpPostProcessingUtilities
|
||||
|
||||
Description
|
||||
Translates foam output to GMV readable files.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
foamToTecplot360
|
||||
|
||||
Group
|
||||
grpPostProcessingUtilities
|
||||
|
||||
Description
|
||||
Tecplot binary file format writer.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
foamToTetDualMesh
|
||||
|
||||
Group
|
||||
grpPostProcessingUtilities
|
||||
|
||||
Description
|
||||
Converts polyMesh results to tetDualMesh.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
foamToVTK
|
||||
|
||||
Group
|
||||
grpPostProcessingUtilities
|
||||
|
||||
Description
|
||||
Legacy VTK file format writer.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
smapToFoam
|
||||
|
||||
Group
|
||||
grpPostProcessingUtilities
|
||||
|
||||
Description
|
||||
Translates a STAR-CD SMAP data file into OpenFOAM field format.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
foamCalc
|
||||
|
||||
Group
|
||||
grpPostProcessingUtilities
|
||||
|
||||
Description
|
||||
Generic wrapper for calculating a quantity at each time.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
particleTracks
|
||||
|
||||
Group
|
||||
grpPostProcessingUtilities
|
||||
|
||||
Description
|
||||
Generates a VTK file of particle tracks for cases that were computed using
|
||||
a tracked-parcel-type cloud.
|
||||
|
||||
@ -24,6 +24,10 @@ License
|
||||
Application
|
||||
steadyParticleTracks
|
||||
|
||||
Group
|
||||
grpPostProcessingUtilitie
|
||||
|
||||
|
||||
Description
|
||||
Generates a VTK file of particle tracks for cases that were computed using
|
||||
a steady-state cloud
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
dsmcFieldsCalc
|
||||
|
||||
Group
|
||||
grpPostProcessingUtilities
|
||||
|
||||
Description
|
||||
Calculate intensive fields (U and T) from averaged extensive fields from a
|
||||
DSMC calculation.
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
engineCompRatio
|
||||
|
||||
Group
|
||||
grpPostProcessingUtilities
|
||||
|
||||
Description
|
||||
Calculate the geometric compression ratio.
|
||||
|
||||
@ -83,7 +86,7 @@ int main(int argc, char *argv[])
|
||||
Info<< "\nVmax = " << Vmax
|
||||
<< ", Vmin = " << Vmin << nl
|
||||
<< "Vmax/Vmin = " << Vmax/Vmin << endl;
|
||||
|
||||
|
||||
Info<< "\nEnd\n" << endl;
|
||||
|
||||
return 0;
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
execFlowFunctionObjects
|
||||
|
||||
Group
|
||||
grpPostProcessingUtilities
|
||||
|
||||
Description
|
||||
Execute the set of functionObjects specified in the selected dictionary
|
||||
(which defaults to system/controlDict) for the selected set of times.
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
foamListTimes
|
||||
|
||||
Group
|
||||
grpPostProcessingUtilities
|
||||
|
||||
Description
|
||||
List times using timeSelector.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
pdfPlot
|
||||
|
||||
Group
|
||||
grpPostProcessingUtilitie
|
||||
|
||||
Description
|
||||
Generates a graph of a probability distribution function.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Application
|
||||
postChannel
|
||||
|
||||
Group
|
||||
grpPostProcessingUtilities
|
||||
|
||||
Description
|
||||
Post-processes data from channel flow calculations.
|
||||
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue
Block a user