[openfoam] 01/01: Add template for manpages.

Tue Sep 20 20:44:42 UTC 2016

This is an automated email from the git hooks/post-receive script.

gladk pushed a commit to branch master
in repository openfoam.

commit ad5306df3f8a0e89342061ef56d235aeb3382370
Author: Anton Gladky <gladk at debian.org>
Date:   Tue Sep 20 22:44:16 2016 +0200

    Add template for manpages.
---
 debian/manpage/listBinFiles | 225 ++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 225 insertions(+)

diff --git a/debian/manpage/listBinFiles b/debian/manpage/listBinFiles
new file mode 100644
index 0000000..2bc4751
--- /dev/null
+++ b/debian/manpage/listBinFiles
@@ -0,0 +1,225 @@
+adiabaticFlameT Calculates the adiabatic flame temperature for a given fuel over a range of unburnt temperatures and equivalence ratios.
+adjointShapeOptimizationFoam Steady-state solver for incompressible, turbulent flow of non-Newtonian fluids with optimisation of duct shape by applying "blockage" in regions causing pressure loss as estimated using an adjoint formulation.
+ansysToFoam Converts an ANSYS input mesh file, exported from I-DEAS, to foam format
+applyBoundaryLayer Apply a simplified boundary-layer model to the velocity and turbulence fields based on the 1/7th power-law. The uniform boundary-layer thickness is either provided via the -ybl option or calculated as the average of the distance to the wall scaled with the thickness coefficient supplied via the option -Cbl.  If both options are provided -ybl is used. 
+attachMesh Attach topologically detached mesh using prescribed mesh modifiers 
+autoPatch Divides external faces into patches based on (user supplied) feature angle 
+autoRefineMesh Utility to refine cells near to a surface. 
+blockMesh blockMesh is one of the most basic mesh generators in OpenFOAM. It relies on a single dictionary file blockMeshDict, usually placed inside the folder constant/polyMesh. 
+boundaryFoam Steady-state solver for 1D turbulent flow, typically to generate boundary layer conditions at an inlet, for use in a simulation.
+boxTurb Makes a box of turbulence which conforms to a given energy spectrum and is divergence free. 
+buoyantBoussinesqPimpleFoam
+buoyantBoussinesqSimpleFoam Steady-state solver for buoyant, turbulent flow of incompressible fluids
+buoyantPimpleFoam This solver is a steady-state solver for buoyant, turbulent flow
+buoyantSimpleFoam Steady-state solver for buoyant, turbulent flow of compressible fluids, including radiation, for ventilation and heat-transfer. 
+cavitatingDyMFoam Transient cavitation code based on the homogeneous equilibrium model from which the compressibility of the liquid/vapour "mixture" is obtained. Original source file cavitatingDyMFoam.C Turbulence modelling is generic, i.e. laminar, RAS or LES may be selected. Definition in file cavitatingDyMFoam.C.
+cavitatingFoam n order to model and simulate the cavitation phenomena using the OpenFOAM, there are some available solvers
+cfx4ToFoam Converts a CFX 4 mesh to foam format 
+changeDictionary Utility to change dictionary entries, e.g. can be used to change the patch type in the field and polyMesh/boundary files. 
+checkMesh Checks validity of a mesh. 
+chemFoam Solver for chemistry problems.
+chemkinToFoam Converts CHEMKINIII thermodynamics and reaction data files into OpenFOAM format. 
+chtMultiRegionFoam Combination of heatConductionFoam and buoyantFoam for conjugate heat transfer between solid regions and fluid regions. Both regions include the fvOptions framework. 
+chtMultiRegionSimpleFoam Steady-state version of chtMultiRegionFoam. 
+coalChemistryFoam Transient solver for compressible, turbulent flow, with coal and limestone parcel injections, energy source, and combustion.
+coldEngineFoam Solver for cold-flow in internal combustion engines. 
+collapseEdges Collapse short edges and combines edges that are in line. 
+combinePatchFaces Checks for multiple patch faces on same cell and combines them. These result from e.g. refined neighbouring cells getting removed, leaving 4 exposed faces with same owner. Rules for merging: only boundary faces (since multiple internal faces between two cells not allowed anyway) faces have to have same owner faces have to be connected via edge which are not features (so angle between them < FEATURE_ANGLE given in degrees [0-180])outside of faces has to be single loop ou [...]
+compressibleInterDyMFoam Solver for 2 compressible, non-isothermal immiscible fluids using a VOF (volume of fluid) phase-fraction based interface capturing approach, with optional mesh motion and mesh topology changes including adaptive re-meshing. 
+compressibleInterFoam Solver for 2 compressible, non-isothermal immiscible fluids using a VOF (volume of fluid) phase-fraction based interface capturing approach.
+compressibleMultiphaseInterFoam Solver for n compressible, non-isothermal immiscible fluids using a VOF (volume of fluid) phase-fraction based interface capturing approach. 
+createBaffles Makes internal faces into boundary faces. Does not duplicate points, unlike mergeOrSplitBaffles. 
+createExternalCoupledPatchGeometry Application to generate the patch geometry (points and faces) for use with the externalCoupled boundary condition. 
+createPatch Utility to create patches out of selected boundary faces. Faces come either from existing patches or from a faceSet. 
+datToFoam Reads in a datToFoam mesh file and outputs a points file.  Used in conjunction with blockMesh.
+decomposePar
+deformedGeom Deforms a polyMesh using a displacement field U and a scaling factor supplied as an argument.
+dnsFoam
+DPMFoam
+driftFluxFoam
+dsmcFoam Initialise a case for dsmcFoam by reading the initialisation dictionary system/dsmcInitialise
+dsmcInitialise
+electrostaticFoam solver for electrostatics.
+engineCompRatio Calculate the geometric compression ratio.
+engineFoam Solver for internal combustion engines. 
+engineSwirl Generates a swirling flow for engine calulations.
+equilibriumCO Calculates the equilibrium level of carbon monoxide. 
+equilibriumFlameT Calculates the equilibrium flame temperature for a given fuel and pressure for a range of unburnt gas temperatures and equivalence ratios; the effects of dissociation on O2, H2O and CO2 are included.
+extrude2DMesh Given a 2D mesh insert all the topology changes to extrude. Does not work in parallel.
+extrudeMesh Extrude mesh from existing patch (by default outwards facing normals; optional flips faces) or from patch read from file. 
+extrudeToRegionMesh Extrude faceZones (internal or boundary faces) or faceSets (boundary faces only) into a separate mesh (as a different region).
+faceAgglomerate Agglomerate boundary faces using the pairPatchAgglomeration algorithm. 
+financialFoam Solves the Black-Scholes equation to price commodities.
+fireFoam Transient PIMPLE solver for Fires and turbulent diffusion flames with reacting Lagrangian parcels, surface film and pyrolysis modelling.
+flattenMesh Flattens the front and back planes of a 2D cartesian mesh.
+fluent3DMeshToFoam Converts a Fluent mesh to OpenFOAM format.
+fluentMeshToFoam Converts a Fluent mesh to OpenFOAM format including multiple region and region boundary handling.
+foamDataToFluent Translates OpenFOAM data to Fluent format.
+foamDictionary
+foamFormatConvert Converts all IOobjects associated with a case into the format specified in the controlDict.
+foamHelp Top level wrapper utility around foam help utilities
+foamList
+foamListTimes List times using timeSelector.
+foamMeshToFluent Writes out the OpenFOAM mesh in Fluent mesh format.
+foamToEnsight Translates OpenFOAM data to EnSight format. 
+foamToEnsightParts Translates OpenFOAM data to Ensight format. An Ensight part is created for each cellZone and patch.
+foamToGMV Translates OpenFOAM data to GMV readable files. 
+foamToStarMesh Converts mesh in foam format to STAR-CD (v4) PROSTAR format
+foamToSurface Write the boundaries of a foam mesh in surface format. 
+foamToTetDualMesh Converts polyMesh results to tetDualMesh. 
+foamToVTK Legacy VTK file format writer.
+foamUpgradeCyclics Tool to upgrade mesh and fields for split cyclics.
+gambitToFoam Converts a GAMBIT mesh to OpenFOAM format 
+icoFoam Transient solver for incompressible, laminar flow of Newtonian fluids. 
+icoUncoupledKinematicParcelDyMFoam Transient solver for the passive transport of a single kinematic particle cloud. 
+icoUncoupledKinematicParcelFoam Transient solver for the passive transport of a single kinematic particle cloud.
+ideasUnvToFoam I-Deas unv format mesh conversion. 
+insideCells Picks up cells with cell centre 'inside' of surface. Requires surface to be closed and singly connected. 
+interDyMFoam Solver for 2 incompressible, isothermal immiscible fluids using a VOF (volume of fluid) phase-fraction based interface capturing approach, with optional mesh motion and mesh topology changes including adaptive re-meshing. 
+interFoam Solver for 2 incompressible, isothermal immiscible fluids using a VOF (volume of fluid) phase-fraction based interface capturing approach. 
+interMixingFoam Solver for 3 incompressible fluids, two of which are miscible, using a VOF method to capture the interface. 
+interPhaseChangeDyMFoam Solver for 2 incompressible, isothermal immiscible fluids with phase-change (e.g. cavitation). Uses a VOF (volume of fluid) phase-fraction based interface capturing approach, with optional mesh motion and mesh topology changes including adaptive re-meshing. 
+interPhaseChangeFoam Solver for 2 incompressible, isothermal immiscible fluids with phase-change (e.g. cavitation). Uses a VOF (volume of fluid) phase-fraction based interface capturing approach. 
+kivaToFoam Converts a KIVA3v grid to OpenFOAM format. 
+laplacianFoam Solves a simple Laplace equation, e.g. for thermal diffusion in a solid. 
+magneticFoam Solver for the magnetic field generated by permanent magnets. 
+mapFields Maps volume fields from one mesh to another, reading and interpolating all fields present in the time directory of both cases. Parallel and non-parallel cases are handled without the need to reconstruct them first. 
+mapFieldsPar Maps volume fields from one mesh to another, reading and interpolating all fields present in the time directory of both cases. 
+mdEquilibrationFoam Equilibrates and/or preconditions molecular dynamics systems. 
+mdFoam Molecular dynamics solver for fluid dynamics. 
+mdInitialise Initialises fields for a molecular dynamics (MD) simulation. 
+mergeMeshes Merges two meshes. 
+mergeOrSplitBaffles Detects faces that share points (baffles). Either merge them or duplicate the points. 
+mhdFoam Solver for magnetohydrodynamics (MHD): incompressible, laminar flow of a conducting fluid under the influence of a magnetic field. 
+mirrorMesh Mirrors a mesh around a given plane. 
+mixtureAdiabaticFlameT Calculates the adiabatic flame temperature for a given mixture at a given temperature. 
+modifyMesh Manipulates mesh elements. 
+moveDynamicMesh Mesh motion and topological mesh changes utility. 
+moveEngineMesh Solver for moving meshes for engine calculations. 
+moveMesh Solver for moving meshes. 
+MPPICFoam Transient solver for the coupled transport of a single kinematic particle cloud including the effect of the volume fraction of particles on the continuous phase. Multi-Phase Particle In Cell (MPPIC) modeling is used to represent collisions without resolving particle-particle interactions. 
+mshToFoam Converts .msh file generated by the Adventure system. 
+multiphaseEulerFoam Solver for a system of many compressible fluid phases including heat-transfer. 
+multiphaseInterDyMFoam Solver for n incompressible fluids which captures the interfaces and includes surface-tension and contact-angle effects for each phase. 
+multiphaseInterFoam Solver for n incompressible fluids which captures the interfaces and includes surface-tension and contact-angle effects for each phase. 
+netgenNeutralToFoam Converts neutral file format as written by Netgen v4.4. 
+noise Utility to perform noise analysis of pressure data using the noiseFFT library. 
+nonNewtonianIcoFoam Transient solver for incompressible, laminar flow of non-Newtonian fluids. 
+objToVTK Read obj line (not surface!) file and convert into vtk.
+orientFaceZone Corrects orientation of faceZone. 
+particleTracks Generates a VTK file of particle tracks for cases that were computed using a tracked-parcel-type cloud. 
+patchSummary Writes fields and boundary condition info for each patch at each requested time instance. 
+pdfPlot Generates a graph of a probability distribution function. 
+PDRFoam Solver for compressible premixed/partially-premixed combustion with turbulence modelling. 
+PDRMesh Mesh and field preparation utility for PDR type simulations. 
+pimpleDyMFoam Transient solver for incompressible, flow of Newtonian fluids on a moving mesh using the PIMPLE (merged PISO-SIMPLE) algorithm. 
+pimpleFoam Large time-step transient solver for incompressible, flow using the PIMPLE (merged PISO-SIMPLE) algorithm. 
+pisoFoam Transient solver for incompressible flow. 
+plot3dToFoam Plot3d mesh (ascii/formatted format) converter. 
+polyDualMesh
+porousSimpleFoam Steady-state solver for incompressible, turbulent flow with implicit or explicit porosity treatment and support for multiple reference frames (MRF) 
+postChannel Post-processes data from channel flow calculations. 
+postProcess
+potentialFoam Potential flow solver which solves for the velocity potential from which the flux-field is obtained and velocity field by reconstructing the flux. 
+potentialFreeSurfaceDyMFoam Incompressible Navier-Stokes solver with inclusion of a wave height field to enable single-phase free-surface approximations. 
+potentialFreeSurfaceFoam Incompressible Navier-Stokes solver with inclusion of a wave height field to enable single-phase free-surface approximations. 
+reactingFoam Solver for combustion with chemical reactions. 
+reactingMultiphaseEulerFoam Solver for a system of any number of compressible fluid phases with a common pressure, but otherwise separate properties. The type of phase model is run time selectable and can optionally represent multiple species and in-phase reactions. The phase system is also run time selectable and can optionally represent different types of momentun, heat and mass transfer. 
+reactingParcelFilmFoam Transient PIMPLE solver for compressible, laminar or turbulent flow with reacting Lagrangian parcels, and surface film modelling. 
+reactingParcelFoam Transient PIMPLE solver for compressible, laminar or turbulent flow with reacting multiphase Lagrangian parcels, including run-time selectable finite volume options, e.g. sources, constraints. 
+reactingTwoPhaseEulerFoam Solver for a system of 2 compressible fluid phases with a common pressure, but otherwise separate properties. The type of phase model is run time selectable and can optionally represent multiple species and in-phase reactions. The phase system is also run time selectable and can optionally represent different types of momentun, heat and mass transfer. 
+reconstructPar Reconstructs fields of a case that is decomposed for parallel execution of OpenFOAM. 
+reconstructParMesh Reconstructs a mesh using geometric information only. 
+redistributePar Redistributes existing decomposed mesh and fields according to the current settings in the decomposeParDict file. 
+refineHexMesh Refines a hex mesh by 2x2x2 cell splitting. 
+refinementLevel Tries to figure out what the refinement level is on refined cartesian meshes. Run BEFORE snapping. 
+refineMesh Utility to refine cells in multiple directions. 
+refineWallLayer Utility to refine cells next to patches. 
+removeFaces Utility to remove faces (combines cells on both sides). 
+renumberMesh Renumbers the cell list in order to reduce the bandwidth, reading and renumbering all fields from all the time directories. 
+rhoCentralDyMFoam Density-based compressible flow solver based on central-upwind schemes of Kurganov and Tadmor with support for mesh-motion and topology changes. 
+rhoCentralFoam Density-based compressible flow solver based on central-upwind schemes of Kurganov and Tadmor. 
+rhoPimpleDyMFoam Transient solver for laminar or turbulent flow of compressible fluids for HVAC and similar applications. 
+rhoPimpleFoam Transient solver for laminar or turbulent flow of compressible fluids for HVAC and similar applications. 
+rhoPorousSimpleFoam Steady-state solver for turbulent flow of compressible fluids with RANS turbulence modelling, implicit or explicit porosity treatment and run-time selectable finite volume sources. 
+rhoReactingBuoyantFoam Solver for combustion with chemical reactions using density based thermodynamics package, using enahanced buoyancy treatment. 
+rhoReactingFoam rhoReactingFoam
+rhoSimpleFoam Steady-state SIMPLE solver for laminar or turbulent RANS flow of compressible fluids. 
+rotateMesh Rotates the mesh and fields from the direction n1 to direction n2. 
+sammToFoam Converts a Star-CD (v3) SAMM mesh to OpenFOAM format. 
+scalarTransportFoam Solves a transport equation for a passive scalar. 
+selectCells Select cells in relation to surface. 
+setFields Set values on a selected set of cells/patchfaces through a dictionary. 
+setSet Manipulate a cell/face/point/ set or zone interactively. 
+setsToZones Add pointZones/faceZones/cellZones to the mesh from similar named pointSets/faceSets/cellSets. 
+shallowWaterFoam Transient solver for inviscid shallow-water equations with rotation. 
+simpleFoam Steady-state solver for incompressible, turbulent flow. 
+simpleReactingParcelFoam Steady state SIMPLE solver for compressible, laminar or turbulent flow with reacting multiphase Lagrangian parcels, including run-time selectable finite volume options, e.g. sources, constraints. 
+singleCellMesh Reads all fields and maps them to a mesh with all internal faces removed (singleCellFvMesh) which gets written to region "singleCell". 
+smapToFoam Translates a STAR-CD SMAP data file into OpenFOAM field format. 
+snappyHexMesh Automatic split hex mesher. Refines and snaps to surface. 
+solidDisplacementFoam Transient segregated finite-volume solver of linear-elastic, small-strain deformation of a solid body, with optional thermal diffusion and thermal stresses. 
+solidEquilibriumDisplacementFoam Steady-state segregated finite-volume solver of linear-elastic, small-strain deformation of a solid body, with optional thermal diffusion and thermal stresses. 
+sonicDyMFoam Transient solver for trans-sonic/supersonic, laminar or turbulent flow of a compressible gas with mesh motion.. 
+sonicFoam Transient solver for trans-sonic/supersonic, laminar or turbulent flow of a compressible gas. 
+sonicLiquidFoam Transient solver for trans-sonic/supersonic, laminar flow of a compressible liquid. 
+splitCells Utility to split cells with flat faces. 
+splitMesh Splits mesh by making internal faces external. Uses attachDetach. 
+splitMeshRegions Splits mesh into multiple regions. 
+sprayDyMFoam Transient PIMPLE solver for compressible, laminar or turbulent flow with spray parcels and support for moving meshes. 
+sprayEngineFoam Transient PIMPLE solver for compressible, laminar or turbulent engine flow swith spray parcels. 
+sprayFoam Transient PIMPLE solver for compressible, laminar or turbulent flow with spray parcels. 
+SRFPimpleFoam Large time-step transient solver for incompressible, flow in a single rotating frame using the PIMPLE (merged PISO-SIMPLE) algorithm. 
+SRFSimpleFoam Steady-state solver for incompressible, turbulent flow of non-Newtonian fluids in a single rotating frame. 
+star3ToFoam Converts a Star-CD (v3) pro-STAR mesh into OpenFOAM format. 
+star4ToFoam Converts a Star-CD (v4) pro-STAR mesh into OpenFOAM format. 
+steadyParticleTracks Generates a VTK file of particle tracks for cases that were computed using a steady-state cloud NOTE: case must be re-constructed (if running in parallel) before use. 
+stitchMesh 'Stitches' a mesh. 
+streamFunction Calculates and writes the stream function of velocity field U at each time. 
+subsetMesh Selects a section of mesh based on a cellSet. 
+surfaceAdd Add two surfaces. Does geometric merge on points. Does not check for overlapping/intersecting triangles. 
+surfaceAutoPatch Patches surface according to feature angle. Like autoPatch. 
+surfaceBooleanFeatures Generates the extendedFeatureEdgeMesh for the interface between a boolean operation on two surfaces. Assumes that the orientation of the surfaces is correct: 
+surfaceCheck Checks geometric and topological quality of a surface. 
+surfaceClean - removes baffles
+surfaceCoarsen Surface coarsening using 'bunnylod': 
+surfaceConvert Converts from one surface mesh format to another. 
+surfaceFeatureConvert Convert between edgeMesh formats. 
+surfaceFeatureExtract Extracts and writes surface features to file. All but the basic feature extraction is WIP. 
+surfaceFind Finds nearest face and vertex. 
+surfaceHookUp Find close open edges and stitches the surface along them. 
+surfaceInertia Calculates the inertia tensor, principal axes and moments of a command line specified triSurface. Inertia can either be of the solid body or of a thin shell. 
+surfaceLambdaMuSmooth Smooths a surface using lambda/mu smoothing. 
+surfaceMeshConvert Converts between surface formats with optional scaling or transformations (rotate/translate) on a coordinateSystem. 
+surfaceMeshConvertTesting Converts from one surface mesh format to another, but primarily used for testing functionality. 
+surfaceMeshExport Export from surfMesh to various third-party surface formats with optional scaling or transformations (rotate/translate) on a coordinateSystem. 
+surfaceMeshImport Import from various third-party surface formats into surfMesh with optional scaling or transformations (rotate/translate) on a coordinateSystem. 
+surfaceMeshInfo Miscellaneous information about surface meshes. 
+surfaceMeshTriangulate Extracts surface from a polyMesh. Depending on output surface format triangulates faces. 
+surfaceOrient Set normal consistent with respect to a user provided 'outside' point. If the -inside option is used the point is considered inside. 
+surfacePointMerge Merges points on surface if they are within absolute distance. Since absolute distance use with care! 
+surfaceRedistributePar (Re)distribution of triSurface. Either takes an undecomposed surface or an already decomposed surface and redistributes it so that each processor has all triangles that overlap its mesh. 
+surfaceRefineRedGreen Refine by splitting all three edges of triangle ('red' refinement). Neighbouring triangles (which are not marked for refinement get split in half ('green' refinement). (R. Verfuerth, "A review of a posteriori error estimation and adaptive mesh refinement techniques", Wiley-Teubner, 1996) 
+surfaceSplitByPatch Writes regions of triSurface to separate files. 
+surfaceSplitByTopology Strips any baffle parts of a surface. A baffle region is one which is reached by walking from an open edge, and stopping when a multiply connected edge is reached. 
+surfaceSplitNonManifolds Takes multiply connected surface and tries to split surface at multiply connected edges by duplicating points. Introduces concept of. 
+surfaceSubset A surface analysis tool which sub-sets the triSurface to choose only a part of interest. Based on subsetMesh. 
+surfaceToPatch Reads surface and applies surface regioning to a mesh. Uses boundaryMesh to do the hard work. 
+surfaceTransformPoints Transform (scale/rotate) a surface. Like transformPoints but for surfaces. 
+temporalInterpolate Interpolate fields between time-steps e.g. for animation. 
+tetgenToFoam Converts .ele and .node and .face files, written by tetgen. 
+thermoFoam Evolves the thermodynamics on a frozen flow field. 
+topoSet Operates on cellSets/faceSets/pointSets through a dictionary. 
+transformPoints Transforms the mesh points in the polyMesh directory according to the translate, rotate and scale options.
+twoLiquidMixingFoam Solver for mixing 2 incompressible fluids. 
+twoPhaseEulerFoam Solver for a system of 2 compressible fluid phases with one phase dispersed, e.g. gas bubbles in a liquid including heat-transfer. 
+uncoupledKinematicParcelFoam Transient solver for the passive transport of a single kinematic particle cloud. 
+viewFactorsGen View factors are calculated based on a face agglomeration array (finalAgglom generated by faceAgglomerate utility). 
+vtkUnstructuredToFoam Converts ascii .vtk (legacy format) file generated by vtk/paraview. 
+wallFunctionTable Generates a table suitable for use by tabulated wall functions. 
+wallHeatFlux Calculates and writes the heat flux for all patches as the boundary field of a volScalarField and also prints the integrated flux for all wall patches. 
+wdot Calculates and writes wdot for each time. 
+writeCellCentres Write the three components of the cell centres as volScalarFields so they can be used in postprocessing in thresholding.
+writeMeshObj For mesh debugging: writes mesh as three separate OBJ files which can be viewed with e.g. javaview. 
+XiFoam Solver for compressible premixed/partially-premixed combustion with turbulence modelling. 
+zipUpMesh Reads in a mesh with hanging vertices and zips up the cells to guarantee that all polyhedral cells of valid shape are closed.

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-science/packages/openfoam.git

