Skip to content
GitLab
Menu
Projects
Groups
Snippets
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Menu
Open sidebar
Development
openfoam
Commits
efb39a87
Commit
efb39a87
authored
Jun 27, 2016
by
Andrew Heather
Browse files
ENH: (further) Doxygen documentation updates for module support
parent
4a0c74d2
Changes
257
Hide whitespace changes
Inline
Side-by-side
applications/utilities/doc/utilities.dox
0 → 100644
View file @
efb39a87
/*---------------------------------------------------------------------------*\
========= |
\\ / 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
\*---------------------------------------------------------------------------*/
applications/utilities/doc/utilitiesDoc.H
0 → 100644
View file @
efb39a87
/*---------------------------------------------------------------------------*\
========= |
\\ / 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
@}
\*---------------------------------------------------------------------------*/
applications/utilities/mesh/advanced/PDRMesh/PDRMesh.C
View file @
efb39a87
...
...
@@ -24,6 +24,9 @@ License
Application
PDRMesh
Group
grpMeshAdvancedUtilities
Description
Mesh and field preparation utility for PDR type simulations.
...
...
applications/utilities/mesh/advanced/collapseEdges/collapseEdges.C
View file @
efb39a87
...
...
@@ -24,6 +24,9 @@ License
Application
collapseEdges
Group
grpMeshAdvancedUtilities
Description
Collapses short edges and combines edges that are in line.
...
...
applications/utilities/mesh/advanced/combinePatchFaces/combinePatchFaces.C
View file @
efb39a87
...
...
@@ -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
...
...
applications/utilities/mesh/advanced/modifyMesh/modifyMesh.C
View file @
efb39a87
...
...
@@ -24,6 +24,9 @@ License
Application
modifyMesh
Group
grpMeshAdvancedUtilities
Description
Manipulates mesh elements.
...
...
applications/utilities/mesh/advanced/refineHexMesh/refineHexMesh.C
View file @
efb39a87
...
...
@@ -24,6 +24,9 @@ License
Application
refineHexMesh
Group
grpMeshAdvancedUtilities
Description
Refines a hex mesh by 2x2x2 cell splitting.
...
...
applications/utilities/mesh/advanced/refineWallLayer/refineWallLayer.C
View file @
efb39a87
...
...
@@ -24,6 +24,9 @@ License
Application
refineWallLayer
Group
grpMeshAdvancedUtilities
Description
Utility to refine cells next to patches.
...
...
applications/utilities/mesh/advanced/refinementLevel/refinementLevel.C
View file @
efb39a87
...
...
@@ -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.
...
...
applications/utilities/mesh/advanced/removeFaces/removeFaces.C
View file @
efb39a87
...
...
@@ -24,6 +24,9 @@ License
Application
removeFaces
Group
grpMeshAdvancedUtilities
Description
Utility to remove faces (combines cells on both sides).
...
...
applications/utilities/mesh/advanced/selectCells/selectCells.C
View file @
efb39a87
...
...
@@ -24,6 +24,9 @@ License
Application
selectCells
Group
grpMeshAdvancedUtilities
Description
Select cells in relation to surface.
...
...
applications/utilities/mesh/advanced/snappyRefineMesh/snappyRefineMesh.C
View file @
efb39a87
...
...
@@ -24,6 +24,9 @@ License
Application
snappyRefineMesh
Group
grpMeshAdvancedUtilities
Description
Utility to refine cells near to a surface.
...
...
applications/utilities/mesh/advanced/splitCells/splitCells.C
View file @
efb39a87
...
...
@@ -24,6 +24,9 @@ License
Application
splitCells
Group
grpMeshAdvancedUtilities
Description
Utility to split cells with flat faces.
...
...
applications/utilities/mesh/conversion/Optional/ccm26ToFoam/ccm26ToFoam.C
View file @
efb39a87
...
...
@@ -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)
...
...
applications/utilities/mesh/conversion/ansysToFoam/ansysToFoam.L
View file @
efb39a87
...
...
@@ -24,6 +24,9 @@ License
Application
ansysToFoam
Group
grpMeshConversionUtilities
Description
Converts an ANSYS input mesh file, exported from I-DEAS,
to OpenFOAM format.
...
...
applications/utilities/mesh/conversion/cfx4ToFoam/cfx4ToFoam.C
View file @
efb39a87
...
...
@@ -24,6 +24,9 @@ License
Application
cfx4ToFoam
Group
grpMeshConversionUtilities
Description
Converts a CFX 4 mesh to OpenFOAM format.
...
...
applications/utilities/mesh/conversion/datToFoam/datToFoam.C
View file @
efb39a87
...
...
@@ -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.
...
...
applications/utilities/mesh/conversion/fluent3DMeshToFoam/fluent3DMeshToFoam.L
View file @
efb39a87
...
...
@@ -24,6 +24,9 @@ License
Application
fluent3DMeshToFoam
Group
grpMeshConversionUtilities
Description
Converts a Fluent mesh to OpenFOAM format.
...
...
applications/utilities/mesh/conversion/fluentMeshToFoam/fluentMeshToFoam.L
View file @
efb39a87
...
...
@@ -24,6 +24,9 @@ License
Application
fluentMeshToFoam
Group
grpMeshConversionUtilities
Description
Converts a Fluent mesh to OpenFOAM format
including multiple region and region boundary handling.
...
...
applications/utilities/mesh/conversion/foamMeshToFluent/foamMeshToFluent.C
View file @
efb39a87
...
...
@@ -24,6 +24,9 @@ License
Application
foamMeshToFluent
Group
grpMeshConversionUtilities
Description
Writes out the OpenFOAM mesh in Fluent mesh format.
...
...
Prev
1
2
3
4
5
…
13
Next
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment