Nabla Logo user
  Advanced Search
  
  Send us a comment/query
 
  Back to main web site
 
  OpenFOAM guides
  - User guide
  - Programmer’s guide
 
  Index
 
  Changes from OpenFOAM 2.2 to 2.3
 
  Trademarks in the guides
  ©2000-2007 Nabla Ltd.

3.6 Standard utilities

The utilities with the OpenFOAM distribution are in the $OpenFOAM_APP/utilities directory, reached quickly by typing util at the command line. Again the names are reasonably descriptive, e.g. magU calculates the magnitude of velocity from velocity field data, ideasToFoam converts mesh data from the format written by I-DEAS to the OpenFOAM format. The current list of utilities distributed with OpenFOAM is given in Table 3.6.

Pre-processing -- see chapter 5


boxTurb

Makes a box of turbulence which conforms to a given energy spectrum and is divergence free

engineSwirl

Generates a swirling flow for engine calulations

FoamX

Case management tool

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

Mesh generation -- see section 6.3


blockMesh

Mesh generator

makePolyMesh

Constructs a polyMesh from a shapeMesh

Mesh conversion -- see section 6.4


cfxToFoam

Converts a CFX mesh to OpenFOAM format

fluentMeshToFoam

Converts a Fluent mesh to OpenFOAM format.

foamMeshToFluent

Writes out the OpenFOAM mesh in Fluent mesh format

gambitToFoam

Converts a GAMBIT mesh to OpenFOAM format

gmshToFoam

Reads .msh file as written by Gmsh. Does not use physical type of mesh quantities yet

ideasToFoam

Converts an ANSYS input mesh file, exported from I-DEAS, to OpenFOAM format

kivaToFoam

Converts a KIVA3v grid to OpenFOAM format

mshToFoam

Reads .msh format generated by the Adventure system

sammToFoam

Converts a STAR-CD SAMM mesh to OpenFOAM format

starToFoam

Converts a STAR-CD PROSTAR mesh into OpenFOAM format

tetgenToFoam

Reads .ele and .node and .face files as written by tetgen

writeMeshObj

For mesh debugging: writes mesh as three separate OBJ files which can be viewed with e.g. javaview

Mesh manipulation


attachMesh

Attach topologically detached mesh using prescribed mesh modifiers

autoPatch

Divides external faces into patches based on (user supplied) feature angle

cellSet

Selects a cell set through a dictionary

checkMesh

Checks validity of a mesh

couplePatches

Utility to reorder cyclic and processor patches. Is now all built-in into morphing so reuse that code

createPatch

Utility to create patches out of selected boundary faces. Faces come either from existing patches or from a faceSet

deformedGeom

Deforms a polyMesh using a displacement field U and a scaling factor supplied as an argument

faceSet

Selects a face set through a dictionary

fieldToCellSet

Select cells based on field. Give min and max to select

flattenMesh

Flatten the front and back planes of a 2D cartesian mesh

insideCells

Pick up cells with cell centre ’inside’ of surface. Requires surface to be closed and singly connected

mergeMeshes

Merge two meshes

mirrorMesh

Mirrors a mesh around a given plane

moveEngineMesh

Solver for moving meshes for engine calculations.

moveMesh

Solver for moving meshes

objToVTK

Read obj line (not surface!) file and convert into vtk

pointSet

Selects a point set through a dictionary

refineMesh

Utility to refine cells in multiple directions. Either supply -all option to refine all cells (3D refinement for 3D cases; 2D for 2D cases) or reads a refineMeshDict with - cellSet to refine - directions to refine

refineShapeMesh

Refines a region of a shapeMesh according to parameters specified in a refineShapeMeshDict dictionary

renumberMesh

Renumbers the cell list in order to reduce the bandwidth, reading and renumbering all fields from all the time directories

scalePoints

Scales the mesh points in the polyMesh directory by a factor supplied as an argument

splitMesh

Splits mesh by making internal faces external. Uses attachDetach

splitMeshRegions

Splits mesh into multiple regions and writes them to consecutive time directories. Each region is defined as a domain whose cells can all be reached by cell-face-cell walking. Uses meshWave

stitchMesh

’Stitches’ a mesh

subsetMesh

Selects a section of mesh based on a cellSet

tetDecomposition

Takes a mesh and decomposes it into tetrahedra using a face-cell centre decomposition

zipUpMesh

Reads in a mesh with hanging vertices and zips up the cells to guarantee that all polyhedral cells of valid shape are closed

Post-processing graphics -- see chapter 7


dxFoamExec

Post-processing graphics using openDX

ensight74FoamExec

Module for EnSight 7.6 to read OpenFOAM data directly without translation

ensight76FoamExec

Module for EnSight 7.6 to read OpenFOAM data directly without translation

Post-processing data converters -- see chapter 7



foamDataToFluent

Translates OpenFOAM data to Fluent format

foamToDX

Translates OpenFOAM data to OpenDX format

foamToEnsight

Translates OpenFOAM data to EnSight format

foamToFieldview

Write out the OpenFOAM mesh in Fieldview-UNS format (binary). See Fieldview Release 8 Reference Manual - Appendix D (Unstructured Data Format) Borrows various from uns/write_binary_uns.c from FieldView dist

foamToFieldview9

Write out the OpenFOAM mesh in Version 3.0 Fieldview-UNS format (binary). See Fieldview Release 9 Reference Manual - Appendix D (Unstructured Data Format) Borrows various from uns/write_binary_uns.c from FieldView dist

foamToVTK

legacy VTK file format writer. - handles volScalar, volVector, pointScalar, pointVector fields. - mesh topo changes. - both ascii and binary. - single time step writing. - write subset only. - automatic decomposition of cells; polygons on boundary undecomposed since handled by vtk

smapToFoam

Translates a STAR-CD SMAP data file into OpenFOAM field format.

Post-processing velocity fields


Co

Configurable graph drawing program

divU

Calculates and writes the divergence of velocity field U at each time in a database

enstrophy

Calculates and writes the enstrophy of velocity field U at each time in a database

Lambda2

Calculates and writes the second largest eigenvalue of the sum of the square of the symmetrical and anti-symmetrical parts of the velocity gradient tensor, at each time in a database

Mach

Calculates and writes the local Mach number from the velocity field U at each time in a database

magGradU

Calculates and writes the scalar magnitude of velocity field U at each time in a database

magU

Calculates and writes the scalar magnitude of the gradient of the velocity field U at each time in a database

Pe

Calculates and writes the Pe number as a surfaceScalarField obtained from field phi at each time in a database

Q

Calculates and writes the second invariant of the velocity gradient tensor for each time in a database

streamFunction

Calculates and writes the stream function of velocity field U at each time in a database

Ucomponents

Writes the three scalar fields, Ux, Uy and Uz, for each component of the velocity field U at each time in a database

uprime

Calculates and writes the scalar field of uprime ( V~  ---
   2k
   3  \special {t4ht=) at each time in a database

vorticity

Calculates and writes the vorticity of velocity field U at each time in a database

Post-processing stress fields


R

Calculates and writes the Reynolds stress R for the current time step

Rcomponents

Calculates and writes the scalar fields of the six components of the Reynolds stress R for each time in a database

stressComponents

Calculates and writes the scalar fields of the six components of the stress tensor sigma for each time in a database

Post-processing at walls


checkYPlus

Calculates and reports yPlus for all wall patches, for each time in a database

wallGradU

Calculates and writes the gradient of U at the wall, wallGradU, for the current time step

wallShearStress

Calculates and writes the wall shear stress for the current time step

yPlusLES

Calculates the yPlus of the near-wall cells for an LES

Miscellaneous post-processing


engineCompRatio

Calculate the geometric compression ratio. Note that if you have valves and/or extra volumes it will not work, since it calculates the volume at BDC and TCD

liftDrag

Calculates the lift and drag for each time in a database.

postChannel

Post-processes data from channel flow calculations

ptot

For each time in a database: calculate the total pressure

sample

Sample field data with a choice of interpolation schemes, sampling options and write formats

sampleSurface

Surface sampling. Runs in parallel (but does not merge points)

wdot

Calculates and writes wdot for each time in a database

Parallel processing -- see section 3.4


decomposePar

Automatically decomposes a mesh and fields of a case for parallel execution of OpenFOAM

reconstructPar

Reconstructs a mesh and fields of a case that is decomposed for parallel execution of OpenFOAM

Thermophysical-related utilities


adiabaticFlameT

Calculates the adiabatic flame temperature for a given fuel over a range of unburnt temperatures and equivalence ratios

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 O
  2   \special {t4ht=, H O
 2  \special {t4ht= and CO2   \special {t4ht= are included

mixtureAdiabaticFlameT

Calculates the adiabatic flame temperature for a given mixture at a given temperature

Sl

Calculates and prints the laminar flame speed of a given fuel at a given pressure (bar  \special {t4ht=), temperature (K  \special {t4ht=) and equivalence ratio

Error estimation


estimateScalarError

Estimates the error in the solution for a scalar transport equation in the standard form

icoErrorEstimate

Estimates error for the incompressible laminar CFD application icoFoam

icoMomentError

Estimates error for the incompressible laminar CFD application icoFoam

momentScalarError

Estimates the error in the solution for a scalar transport equation in the standard form

Miscellaneous utilities


foamConvert21To22

Converts the following case dictionaries from 2.1 to 2.2 syntax: - fvSchemes - fvSolution (created from fvTolerances) - (controlDict) - for parallel processed cases, processor numbering updated from 1,2,... to 0,1,

foamDebugSwitches

Write out all library debug switches

foamInfoExec

Interrogates a case and prints information to screen

Table 3.6: Standard library utilities.