Man Pages in freefoam

  1. Carta.tech
  2. Packages
  3. freefoam
  • 233

    Section 1: Executable programs or shell commands

    freefoam.1
    The cross-platform cfd toolkit
    freefoam-Co.1
    Calculates and writes the co number as a surfacescalarfield obtained from field phi.
    freefoam-IFCLookUpTableGen.1
    Calculate the the infinitely-fast chemistry relationships in function of ft. for a given fuel.
    freefoam-Lambda2.1
    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.
    freefoam-MRFInter.1
    Solver for 2 incompressible, isothermal immiscible fluids.
    freefoam-MRFMultiphaseInter.1
    Solver for n incompressible fluids which captures the interfaces and includes surface-tension and contact-angle effects for each phase.
    freefoam-Mach.1
    Calculates and optionally writes the local mach number from the velocity field u at each time.
    freefoam-PDR.1
    Solver for compressible premixed/partially-premixed combustion with turbulence modelling.
    freefoam-PDRAutoRefine.1
    Solver for compressible premixed/partially-premixed combustion with turbulence modelling.
    freefoam-Pe.1
    Calculates and writes the pe number as a surfacescalarfield obtained from field phi.
    freefoam-Q.1
    Calculates and writes the second invariant of the velocity gradient tensor.
    freefoam-R.1
    Calculates and writes the reynolds stress r for the current time step.
    freefoam-Xi.1
    Solver for compressible premixed/partially-premixed combustion with turbulence modelling.
    freefoam-adiabaticFlameT.1
    Calculates the adiabatic flame temperature for a given fuel over a range of unburnt temperatures and equivalence ratios.
    freefoam-ansysToFoam.1
    Converts an ansys input mesh file, exported from i-deas, to foam format.
    freefoam-applyBoundaryLayer.1
    Apply a simplified boundary-layer model to the velocity and turbulence fields based on the 1/7th power-law.
    freefoam-applyWallFunctionBoundaryConditions.1
    Updates openfoam ras cases to use the new (v1.6) wall function framework
    freefoam-attachMesh.1
    Attach topologically detached mesh using prescribed mesh modifiers.
    freefoam-autoPatch.1
    Divides external faces into patches based on (user supplied) feature angle.
    freefoam-autoRefineMesh.1
    Utility to refine cells near to a surface.
    freefoam-blockMesh.1
    A multi-block mesh generator.
    freefoam-boundary.1
    Steady-state solver for 1d turbulent flow, typically to generate boundary layer conditions at an inlet, for use in a simulation.
    freefoam-boxTurb.1
    Makes a box of turbulence which conforms to a given energy spectrum and is divergence free.
    freefoam-bubble.1
    Solver for a system of 2 incompressible fluid phases with one phase dispersed, e.g. gas bubbles in a liquid.
    freefoam-buoyantBoussinesqPimple.1
    Transient solver for buoyant, turbulent flow of incompressible fluids
    freefoam-buoyantBoussinesqSimple.1
    Steady-state solver for buoyant, turbulent flow of incompressible fluids
    freefoam-buoyantPimple.1
    Transient solver for buoyant, turbulent flow of compressible fluids for ventilation and heat-transfer.
    freefoam-buoyantSimple.1
    Steady-state solver for buoyant, turbulent flow of compressible fluids
    freefoam-buoyantSimpleRadiation.1
    Steady-state solver for buoyant, turbulent flow of compressible fluids, including radiation, for ventilation and heat-transfer.
    freefoam-calc.1
    Generic wrapper for calculating a quantity at each time.
    freefoam-cavitating.1
    Transient cavitation code based on the homogeneous equilibrium model from which the compressibility of the liquid/vapour "mixture" is obtained.
    freefoam-cellSet.1
    Selects a cell set through a dictionary.
    freefoam-cfx4ToFoam.1
    Converts a cfx 4 mesh to foam format
    freefoam-changeDictionary.1
    Utility to change dictionary entries.
    freefoam-channel.1
    Incompressible les solver for flow in a channel.
    freefoam-checkMesh.1
    Checks validity of a mesh
    freefoam-chemkinToFoam.1
    Converts chemkiniii thermodynamics and reaction data files into foam format
    freefoam-chtMultiRegion.1
    Combination of heatconductionfoam and buoyantfoam for conjugate heat transfer between a solid region and fluid region
    freefoam-chtMultiRegionSimple.1
    Steady-state version of chtmultiregionfoam
    freefoam-clearPolyMesh.1
    Remove the contents of the constant/polymesh directory as per the +foam::polymesh::removefiles()+ method.
    freefoam-coalChemistry.1
    Transient solver for compressible, turbulent flow with coal and limestone parcel injections, and combustion.
    freefoam-coldEngine.1
    Solver for cold-flow in internal combustion engines.
    freefoam-collapseEdges.1
    Collapse short edges and combines edges that are in line.
    freefoam-combinePatchFaces.1
    Checks for multiple patch faces on same cell and combines them.
    freefoam-compressibleInter.1
    Solver for 2 compressible, isothermal immiscible fluids using a vof (volume of fluid) phase-fraction based interface capturing approach.
    freefoam-compressibleInterDyM.1
    Solver for 2 compressible, 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.
    freefoam-copySettings.1
    Copy settings from one case directory to another, without copying the mesh or results.
    freefoam-createBaffles.1
    Makes internal faces into boundary faces.
    freefoam-createPatch.1
    Utility to create patches out of selected boundary faces.
    freefoam-createTurbulenceFields.1
    Creates a full set of turbulence fields.
    freefoam-debugSwitches.1
    Write out all library debug switches
    freefoam-decomposePar.1
    Automatically decomposes a mesh and fields of a case for parallel execution of openfoam.
    freefoam-deformedGeom.1
    Deforms a polymesh using a displacement field u and a scaling factor supplied as an argument.
    freefoam-diesel.1
    Solver for diesel spray and combustion.
    freefoam-dieselEngine.1
    Solver for diesel engine spray and combustion.
    freefoam-dns.1
    Direct numerical simulation solver for boxes of isotropic turbulence
    freefoam-dsmc.1
    Direct simulation monte carlo (dsmc) solver for 3d, transient, multi- species flows
    freefoam-dsmcFieldsCalc.1
    Calculate intensive fields (u and t) from averaged extensive fields from a dsmc calculation.
    freefoam-dsmcInitialise.1
    Initialise a case for dsmcfoam by reading the initialisation dictionary system/dsmcinitialise
    freefoam-electrostatic.1
    Solver for electrostatics.
    freefoam-engine.1
    Solver for internal combustion engines.
    freefoam-engineCompRatio.1
    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.
    freefoam-engineSwirl.1
    Generates a swirling flow for engine calulations
    freefoam-enstrophy.1
    Calculates and writes the enstrophy of the velocity field u.
    freefoam-equilibriumCO.1
    Calculates the equilibrium level of carbon monoxide
    freefoam-equilibriumFlameT.1
    Calculates the equilibrium flame temperature.
    freefoam-estimateScalarError.1
    Estimates the error in the solution for a scalar transport equation in the standard form
    freefoam-execFlowFunctionObjects.1
    Execute the set of functionobjects specified in the selected dictionary (which defaults to system/controldict) for the selected set of times.
    freefoam-expandDictionary.1
    Read the dictionary provided as an argument, expand the macros etc. and write the resulting dictionary to standard output.
    freefoam-extrude2DMesh.1
    Takes 2d mesh (all faces 2 points only, no front and back faces) and creates a 3d mesh by extruding with specified thickness.
    freefoam-extrudeMesh.1
    Extrude mesh from existing patch or from patch read from file.
    freefoam-faceSet.1
    Selects a face set through a dictionary.
    freefoam-financial.1
    Solves the black-scholes equation to price commodities.
    freefoam-fire.1
    Transient solver for fires and turbulent diffusion flames
    freefoam-flattenMesh.1
    Flattens the front and back planes of a 2d cartesian mesh.
    freefoam-flowType.1
    Calculates and writes the flowtype of velocity field u.
    freefoam-fluent3DMeshToFoam.1
    Converts a fluent mesh to openfoam format.
    freefoam-fluentMeshToFoam.1
    Converts a fluent mesh to foam format including multiple region and region boundary handling.
    freefoam-foamDataToFluent.1
    Translates foam data to fluent format.
    freefoam-foamMeshToFluent.1
    Writes out the foam mesh in fluent mesh format.
    freefoam-foamToEnsight.1
    Translates foam data to ensight format.
    freefoam-foamToEnsightParts.1
    Translates openfoam data to ensight format. an ensight part is created for each cellzone and patch.
    freefoam-foamToFieldview9.1
    Write out the openfoam mesh in version 3.0 fieldview-uns format (binary).
    freefoam-foamToGMV.1
    Translates foam output to gmv readable files.
    freefoam-foamToStarMesh.1
    Reads an openfoam mesh and writes a pro-star (v4) bnd/cel/vrt format.
    freefoam-foamToVTK.1
    Legacy vtk file format writer.
    freefoam-formatConvert.1
    Converts all ioobjects associated with a case into the format specified in the controldict.
    freefoam-gambitToFoam.1
    Converts a gambit mesh to foam format.
    freefoam-gmshToFoam.1
    Reads .msh file as written by gmsh.
    freefoam-graphExecTime.1
    Computes the time used per iteration
    freefoam-graphResKE.1
    Extract the residuals of k and epsilon at each time step
    freefoam-graphResUVWP.1
    Extract the residuals of u, v, w and p at each time step
    freefoam-ico.1
    Transient solver for incompressible, laminar flow of newtonian fluids.
    freefoam-icoErrorEstimate.1
    Estimates error for the incompressible laminar cfd application icofoam.
    freefoam-icoMomentError.1
    Estimates error for the incompressible laminar cfd application icofoam.
    freefoam-ideasUnvToFoam.1
    I-deas unv format mesh conversion.
    freefoam-infoExec.1
    Interrogates a case and prints information to screen
    freefoam-insideCells.1
    Picks up cells with cell centre inside of surface.
    freefoam-inter.1
    Solver for 2 incompressible, isothermal immiscible fluids using a vof (volume of fluid) phase-fraction based interface capturing approach.
    freefoam-interDyM.1
    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.
    freefoam-interMixing.1
    Solver for 3 incompressible fluids, two of which are miscible, using a vof method to capture the interface.
    freefoam-interPhaseChange.1
    Solver for 2 incompressible, isothermal immiscible fluids with phase-change (e.g. cavitation).
    freefoam-job.1
    Runs a freefoam job in the background
    freefoam-kivaToFoam.1
    Converts a kiva3v grid to foam format
    freefoam-laplacian.1
    Solves a simple laplace equation, e.g. for thermal diffusion in a solid.
    freefoam-log.1
    Extracts xy files from foam logs
    freefoam-mapFields.1
    Maps volume fields from one mesh to another.
    freefoam-md.1
    Molecular dynamics solver for fluid dynamics
    freefoam-mdEquilibration.1
    Equilibrates and/or preconditions molecular dynamics systems
    freefoam-mdInitialise.1
    Initialises fields for a molecular dynamics (md) simulation.
    freefoam-mergeMeshes.1
    Merge two meshes.
    freefoam-mergeOrSplitBaffles.1
    Detects faces that share points (baffles). either merge them or duplicate the points.
    freefoam-mhd.1
    Solver for magnetohydrodynamics (mhd): incompressible, laminar flow of a conducting fluid under the influence of a magnetic field.
    freefoam-mirrorMesh.1
    Mirrors a mesh around a given plane.
    freefoam-mixtureAdiabaticFlameT.1
    Calculates the adiabatic flame temperature for a given mixture at a given temperature.
    freefoam-modifyMesh.1
    Manipulates mesh elements.
    freefoam-momentScalarError.1
    Estimates the error in the solution for a scalar transport equation in the standard form
    freefoam-moveDynamicMesh.1
    Mesh motion and topological mesh changes utility.
    freefoam-moveEngineMesh.1
    Solver for moving meshes for engine calculations.
    freefoam-moveMesh.1
    Solver for moving meshes
    freefoam-mshToFoam.1
    Converts .msh file generated by the adventure system.
    freefoam-multiphaseInter.1
    Solver for n incompressible fluids which captures the interfaces and includes surface-tension and contact-angle effects for each phase.
    freefoam-netgenNeutralToFoam.1
    Converts neutral file format as written by netgen v4.4.
    freefoam-nonNewtonianIco.1
    Transient solver for incompressible, laminar flow of non-newtonian fluids.
    freefoam-objToVTK.1
    Read obj line (not surface!) file and convert into vtk.
    freefoam-pPrime2.1
    Calculates and writes the scalar field of pprime2 (sqr(p - pmean)) at each time
    freefoam-para.1
    Start paraview3 to visualize a case
    freefoam-particleTracks.1
    Generates a vtk file of particle tracks for cases that were computed using a tracked-parcel-type cloud.
    freefoam-patchAverage.1
    Calculates the average of the specified field over the specified patch.
    freefoam-patchIntegrate.1
    Calculates the integral of the specified field over the specified patch.
    freefoam-patchSummary.1
    Writes fields and boundary condition info for each patch at each requested time instance.
    freefoam-pdfPlot.1
    Generates an .obj file to plot a probability distribution function
    freefoam-pimple.1
    Large time-step transient solver for incompressible, flow using the pimple (merged piso-simple) algorithm.
    freefoam-pimpleDyM.1
    Transient solver for incompressible, flow of newtonian fluids on a moving mesh using the pimple (merged piso-simple) algorithm.
    freefoam-piso.1
    Transient solver for incompressible flow.
    freefoam-plot3dToFoam.1
    Plot3d mesh (ascii/formatted format) converter.
    freefoam-pointSet.1
    Selects a point set through a dictionary.
    freefoam-polyDualMesh.1
    Calculate the dual of a polymesh. adheres to all the feature and patch edges.
    freefoam-porousExplicitSourceReactingParcel.1
    Transient piso solver for compressible, laminar or turbulent flow with reacting multiphase lagrangian parcels for porous media, including explicit sources for mass, momentum and energy
    freefoam-porousInter.1
    Solver for 2 incompressible, isothermal immiscible fluids.
    freefoam-porousSimple.1
    Steady-state solver for incompressible, turbulent flow with implicit or explicit porosity treatment
    freefoam-postChannel.1
    Post-processes data from channel flow calculations
    freefoam-potential.1
    Simple potential flow solver which can be used to generate starting fields for full navier-stokes codes.
    freefoam-probeLocations.1
    Probe locations.
    freefoam-ptot.1
    For each time: calculate the total pressure.
    freefoam-reacting.1
    Solver for combustion with chemical reactions.
    freefoam-reactingParcel.1
    Transient piso solver for compressible, laminar or turbulent flow with reacting lagrangian parcels.
    freefoam-reconstructPar.1
    Reconstructs a mesh and fields of a case that is decomposed for parallel execution of openfoam.
    freefoam-reconstructParMesh.1
    Reconstructs a mesh using geometric information only.
    freefoam-redistributeMeshPar.1
    Redistributes existing decomposed mesh and fields according to the current settings in the decomposepardict file.
    freefoam-refineHexMesh.1
    Refines a hex mesh by 2x2x2 cell splitting.
    freefoam-refineMesh.1
    Utility to refine cells in multiple directions.
    freefoam-refineWallLayer.1
    Utility to refine cells next to patches.
    freefoam-refinementLevel.1
    Tries to figure out what the refinement level is on refined cartesian meshes. run before snapping.
    freefoam-removeFaces.1
    Utility to remove faces (combines cells on both sides).
    freefoam-renumberMesh.1
    Renumbers the cell list in order to reduce the bandwidth, reading and renumbering all fields from all the time directories.
    freefoam-rhoCentral.1
    Density-based compressible flow solver based on central-upwind schemes of kurganov and tadmor
    freefoam-rhoCentralDyM.1
    Density-based compressible flow solver based on central-upwind schemes of kurganov and tadmor
    freefoam-rhoPimple.1
    Transient solver for laminar or turbulent flow of compressible fluids for hvac and similar applications.
    freefoam-rhoPiso.1
    Transient piso solver for compressible, laminar or turbulent flow.
    freefoam-rhoPorousMRFPimple.1
    Transient solver for laminar or turbulent flow of compressible fluids with support for porous media and mrf for hvac and similar applications.
    freefoam-rhoPorousSimple.1
    Steady-state solver for turbulent flow of compressible fluids with rans turbulence modelling, and implicit or explicit porosity treatment
    freefoam-rhoReacting.1
    Solver for combustion with chemical reactions using density based thermodynamics package.
    freefoam-rhoSimple.1
    Steady-state simple solver for laminar or turbulent rans flow of compressible fluids.
    freefoam-rotateMesh.1
    Rotates the mesh and fields from the direcion n1 to the direction n2.
    freefoam-sammToFoam.1
    Converts a star-cd samm mesh to foam format
    freefoam-sample.1
    Sample field data with a choice of interpolation schemes, sampling options and write formats.
    freefoam-scalarTransport.1
    Solves a transport equation for a passive scalar
    freefoam-selectCells.1
    Select cells in relation to surface.
    freefoam-setFields.1
    Selects a cell set through a dictionary.
    freefoam-setSet.1
    Manipulate a cell/face/point/ set or zone interactively.
    freefoam-setsToZones.1
    Add pointzones/facezones/cellzones to the mesh from similar named pointsets/facesets/cellsets.
    freefoam-settling.1
    Solver for 2 incompressible fluids for simulating the settling of the dispersed phase.
    freefoam-shallowWater.1
    Transient solver for inviscid shallow-water equations with rotation.
    freefoam-simple.1
    Steady-state solver for incompressible, turbulent flow
    freefoam-smapToFoam.1
    Translates a star-cd smap data file into foam field format.
    freefoam-snappyHexMesh.1
    Automatic split hex mesher. refines and snaps to surface.
    freefoam-solidDisplacement.1
    Transient segregated finite-volume solver of linear-elastic, small-strain deformation of a solid body, with optional thermal diffusion and thermal stresses.
    freefoam-solidEquilibriumDisplacement.1
    Steady-state segregated finite-volume solver of linear-elastic, small-strain deformation of a solid body, with optional thermal diffusion and thermal stresses.
    freefoam-solverSweeps.1
    Extract solver statistics from a log file
    freefoam-sonic.1
    Transient solver for trans-sonic/supersonic, laminar or turbulent flow of a compressible gas.
    freefoam-sonicDyM.1
    Transient solver for trans-sonic/supersonic, laminar or turbulent flow of a compressible gas with mesh motion.
    freefoam-sonicLiquid.1
    Transient solver for trans-sonic/supersonic, laminar flow of a compressible liquid.
    freefoam-splitCells.1
    Utility to split cells with flat faces.
    freefoam-splitMesh.1
    Splits mesh by making internal faces external.
    freefoam-splitMeshRegions.1
    Splits mesh into multiple regions.
    freefoam-star4ToFoam.1
    Converts a star-cd (v4) pro-star mesh into openfoam format.
    freefoam-starToFoam.1
    Converts a star-cd prostar mesh into foam format.
    freefoam-stitchMesh.1
    Stitches a mesh.
    freefoam-streamFunction.1
    Calculates and writes the stream function of velocity field u at each time
    freefoam-stressComponents.1
    Calculates and writes the scalar fields of the six components of the stress tensor sigma for each time.
    freefoam-subsetMesh.1
    Selects a section of mesh based on a cellset.
    freefoam-surfaceAdd.1
    Add two surfaces. does geometric merge on points. does not check for overlapping/intersecting triangles.
    freefoam-surfaceAutoPatch.1
    Patches surface according to feature angle. like autopatch.
    freefoam-surfaceCheck.1
    Performs various checks on surface.
    freefoam-surfaceClean.1
    Collapses small edges, removing triangles and converts sliver triangles into split edges by projecting point onto base of triangle.
    freefoam-surfaceCoarsen.1
    Surface coarsening using bunnylod.
    freefoam-surfaceConvert.1
    Converts from one surface mesh format to another
    freefoam-surfaceFeatureConvert.1
    Extracts and writes surface features to file
    freefoam-surfaceFeatureExtract.1
    Extracts and writes surface features to file
    freefoam-surfaceFind.1
    Finds nearest triangle and vertex.
    freefoam-surfaceMeshConvert.1
    Convert between surface formats with optional scaling or transformations (rotate/translate) on a coordinatesystem.
    freefoam-surfaceMeshConvertTesting.1
    Converts from one surface mesh format to another, but primarily used for testing functionality.
    freefoam-surfaceMeshExport.1
    Export from surfmesh to various third-party surface formats with optional scaling or transformations (rotate/translate) on a coordinatesystem.
    freefoam-surfaceMeshImport.1
    Import from various third-party surface formats into surfmesh with optional scaling or transformations (rotate/translate) on a coordinatesystem.
    freefoam-surfaceMeshTriangulate.1
    Extracts trisurface from a polymesh.
    freefoam-surfaceOrient.1
    Set normal consistent with respect to a user provided outside point.
    freefoam-surfacePointMerge.1
    Merges points on surface if they are within absolute distance.
    freefoam-surfaceRedistributePar.1
    (re)distribution of trisurface. either takes an undecomposed surface or an already decomposed surface and redistribute it so each processor has all triangles that overlap its mesh.
    freefoam-surfaceRefineRedGreen.1
    Refine by splitting all three edges of triangle (red refinement). neighbouring triangles (which are not marked for refinement get split in half (green) refinement.
    freefoam-surfaceSmooth.1
    Example of simple laplacian smoother
    freefoam-surfaceSplitByPatch.1
    Writes regions of trisurface to separate files.
    freefoam-surfaceSplitNonManifolds.1
    Takes multiply connected surface and tries to split surface at multiply connected edges by duplicating points.
    freefoam-surfaceSubset.1
    A surface analysis tool which sub-sets the trisurface to choose only a part of interest.
    freefoam-surfaceToPatch.1
    Reads surface and applies surface regioning to a mesh.
    freefoam-surfaceTransformPoints.1
    Transform (scale/rotate) a surface.
    freefoam-tetgenToFoam.1
    Converts .ele and .node and .face files, written by tetgen.
    freefoam-transformPoints.1
    Transforms the mesh points in the polymesh directory according to the translate, rotate and scale options.
    freefoam-twoLiquidMixing.1
    Solver for mixing 2 incompressible fluids.
    freefoam-twoPhaseEuler.1
    Solver for a system of 2 incompressible fluid phases with one phase dispersed, e.g. gas bubbles in a liquid.
    freefoam-uncoupledKinematicParcel.1
    Transient solver for the passive transport of a single kinematic particle cloud.
    freefoam-upgradeFvSolution.1
    Simple tool to upgrade the syntax of system/fvsolution::solvers
    freefoam-uprime.1
    Calculates and writes the scalar field of uprime (sqrt(2/3 k)).
    freefoam-vorticity.1
    Calculates and writes the vorticity of velocity field u.
    freefoam-wallGradU.1
    Calculates and writes the gradient of u at the wall
    freefoam-wallHeatFlux.1
    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.
    freefoam-wallShearStress.1
    Calculates and writes the wall shear stress, for the specified times.
    freefoam-wdot.1
    Calculates and writes wdot for each time.
    freefoam-writeCellCentres.1
    Write the three components of the cell centres as volscalarfields so they can be used in postprocessing in thresholding.
    freefoam-writeMeshObj.1
    For mesh debugging: writes mesh as three separate obj files which can be viewed with e.g. javaview.
    freefoam-yPlusLES.1
    Calculates and reports yplus for all wall patches, for the specified times.
    freefoam-yPlusRAS.1
    Calculates and reports yplus for all wall patches, for the specified times when using ras turbulence models.
    freefoam-zipUpMesh.1
    Reads in a mesh with hanging vertices and zips up the cells to guarantee that all polyhedral cells of valid shape are closed.