From 23d7ea2113cf542016877d40e60983bab4644813 Mon Sep 17 00:00:00 2001 From: Michael Wild Date: Fri, 24 Jun 2011 14:26:43 +0200 Subject: [PATCH] DOC: List helper scripts in freefoam.1.in.txt Signed-off-by: Michael Wild --- doc/man/manSource/freefoam.1.in.txt | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) diff --git a/doc/man/manSource/freefoam.1.in.txt b/doc/man/manSource/freefoam.1.in.txt index 51ef3257b..1837081e8 100644 --- a/doc/man/manSource/freefoam.1.in.txt +++ b/doc/man/manSource/freefoam.1.in.txt @@ -71,6 +71,38 @@ pages. include::brief_app_doc.txt[] +FreeFOAM Helper Scripts +~~~~~~~~~~~~~~~~~~~~~~~ +Below you find an overview of the small helper scripts provided by FreeFOAM. + +*linkff:freefoam-clearPolyMesh[1]*:: + Remove the contents of the constant/polyMesh directory. + +*linkff:freefoam-copySettings[1]*:: + Copy settings from one case directory to another, without copying the mesh or + results. + +*linkff:freefoam-graphExecTime[1]*:: + Computes the time used per iteration. + +*linkff:freefoam-graphResKE[1]*:: + Extract the residuals of k and epsilon at each time step. + +*linkff:freefoam-graphResUVWP[1]*:: + Extract the residuals of 'U', 'V', 'W' and 'p' at each time step. + +*linkff:freefoam-job[1]*:: + Runs a @PROJECT_NAME@ job in the background. + +*linkff:freefoam-log[1]*:: + Extracts xy files from Foam logs. + +*linkff:freefoam-para[1]*:: + Start ParaView3 to visualize a case. + +*linkff:freefoam-solverSweeps[1]*:: + Extract solver statistics from a log file. + CONFIGURATION MECHANISM ----------------------- FreeFOAM offers a number of global configuration options. These include -- 2.11.4.GIT