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

@ -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)

View File

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

View File

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

View File

@ -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.

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@ -24,6 +24,9 @@ License
Application
tetgenToFoam
Group
grpMeshConversionUtilities
Description
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
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.

View File

@ -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.