3.7 Standard libraries

Back to OpenFOAM Home

OpenCFD®

Company profile

OpenFOAM support

OpenFOAM development

OpenFOAM training

Solutions

Contact OpenCFD

Recruitment

3.7 Standard libraries

The libraries with the OpenFOAM distribution are in the $FOAM_LIB/$WM_OPTIONS directory, reached quickly by typing lib at the command line. Again, the names are prefixed by lib and reasonably descriptive, e.g.incompressibleTransportModels contains the library of incompressible transport models. For ease of presentation, the libraries are separated into two types:

General libraries: those that provide general classes and associated functions listed in 3.7;
Model libraries: those that specify models used in computational continuum mechanics, listed in 3.8, 3.9 and 3.10.

Library of basic OpenFOAM tools -- OpenFOAM

algorithms

Algorithms

containers

Container classes

Database classes

dimensionSet

dimensionSet class

dimensionedTypes

dimensioned<Type> class and derivatives

fields

Field classes

finiteVolume

Finite volume discretisation classes

global

Global settings

interpolations

Interpolation schemes

matrices

Matrix classes

meshes

Mesh classes

primitives

Primitive classes

Library of CFD tools -- cfdTools

adjustPhi

Adjusts boundary fluxes

bound

Bounds scalar fields

compressible

Compressible flow CFD tools

incompressible

Incompressible flow CFD tools

wallDist

Calculations relating to wall boundaries

Post-processing libraries

incompressiblePostProcessing

Tools for post-processing incompressible flow data

sampling

Tools for sampling field data at prescribed locations in a domain

Solution and mesh manipulation libraries

cellDecompFiniteElement

Cell decomposed finite element scheme

dynamicMesh

For solving systems with moving meshes

edgeMesh

For handling edge-based mesh descriptions

errorEstimation

Error estimation tools

faceDecompFiniteElement

Face decomposed finite element scheme

ODE

Solvers for ordinary differential equations

shapeMeshTools

Tools for handling a mesh whose cells are defined by a set of standard shapes

meshTools

Tools for handling a OpenFOAM mesh

triSurface

For handling standard triangulated surface-based mesh descriptions

Lagrangian particle tracking libraries

dieselSpray

Diesel spray tracking solution scheme

lagrangian

Basic Lagrangian, or particle-tracking, solution scheme

Public domain libraries

mico-2.3.13

Implementation of the Common Object Request Broker Architecture (CORBA)

mpich-1.2.4

Portable message-passing interface for parallel processing

openmpi-1.2.6

Portable message-passing interface for parallel processing

zlib-1.2.3

General purpose data compression

Miscellaneous libraries

engine

Tools for engine calculations

Gstream

2D graphics stream

randomProcesses

Tools for analysing and generating random processes

Table 3.7:

Shared object libraries for general use.

Basic thermophysical models -- basicThermophysicalModels

hThermo

General thermophysical model calculation based on enthalpy $h \special {t4ht=$

pureMixture

General thermophysical model calculation for passive gas mixtures

Combustion models -- combustionThermophysicalModels

hMixtureThermo

Calculates enthalpy for combustion mixture

hhuMixtureThermo

Calculates enthalpy for unburnt gas and combustion mixture

homogeneousMixture

Combustion mixture based on normalised fuel mass fraction $b \special {t4ht=$

inhomogeneousMixture

Combustion mixture based on $b \special {t4ht=$ and total fuel mass fraction $ft \special {t4ht=$

veryInhomogeneousMixture

Combustion mixture based on $b \special {t4ht=$ , $ft \special {t4ht=$ and unburnt fuel mass fraction $fu \special {t4ht=$

dieselMixture

Combustion mixture based on $ft \special {t4ht=$ and $fu \special {t4ht=$

multiComponentMixture

Combustion mixture based on multiple components [**]

chemkinMixture

Combustion mixture using CHEMKIN thermodynamics and reaction schemes database files

Laminar flame speed models -- laminarFlameSpeedModels

constLaminarFlameSpeed

Constant laminar flame speed

guldersLaminarFlameSpeed

Gülder’s laminar flame speed model

Thermophysical properties of liquids -- liquids

nHeptane

Thermophysical properties of nHeptane

nOctane

Thermophysical properties of nOctane

nDecane

Thermophysical properties of nDecane

nDodecane

Thermophysical properties of nDodecane

isoOctane

Thermophysical properties of isoOctane

diMethylEther

Thermophysical properties of diMethylEther

diEthylEther

Thermophysical properties of diEthylEther

water

Thermophysical properties of water

Thermophysical properties of gaseous species -- specie

perfectGas

Perfect gas equation of state

hConstThermo

Constant specific heat $cp \special {t4ht=$ model with evaluation of enthalpy $h \special {t4ht=$ and entropy $s \special {t4ht=$

janafThermo

$cp \special {t4ht=$ evaluated by a function with coefficients from JANAF thermodynamic tables, from which $h \special {t4ht=$ , $s \special {t4ht=$ are evaluated

specieThermo

Thermophysical properties of species, derived from $cp \special {t4ht=$ , $h \special {t4ht=$ and/or $s \special {t4ht=$

constTransport

Constant transport properties

sutherlandTransport

Sutherland’s formula for temperature-dependent transport properties

Functions/tables of thermophysical properties -- thermophysicalFunctions

NSRDSfunctions

National Standard Reference Data System (NSRDS) - American Institute of Chemical Engineers (AICHE) data compilation tables

APIfunctions

American Petroleum Institute (API) function for vapour mass diffusivity

Probability density functions -- pdf

RosinRammler

Rosin-Rammler distribution

normal

Normal distribution

uniform

Uniform distribution

exponential

Exponential distribution

general

General distribution

Chemistry model -- chemistryModel

chemistryModel

Chemical reaction model

chemistrySolver

Chemical reaction solver

Table 3.8:

Libraries of thermophysical models.

RAS turbulence models for incompressible fluids -- incompressibleRASModels

laminar

Dummy turbulence model for laminar flow

kEpsilon

Standard $k - e \special {t4ht=$ model with wall functions

RNGkEpsilon

RNG $k - e \special {t4ht=$ model with wall functions

NonlinearKEShih

Non-linear Shih $k- e \special {t4ht=$ model with wall functions

LienCubicKE

Lien cubic $k - e \special {t4ht=$ model with wall functions

QZeta

$q- z \special {t4ht=$ model

LaunderSharmaKE

Launder-Sharma low- $Re \special {t4ht=$ $k- e \special {t4ht=$ model

LamBremhorstKE

Lam-Bremhorst low- $Re \special {t4ht=$ $k - e \special {t4ht=$ model

LienCubicKELowRE

Lien cubic low- $Re \special {t4ht=$ $k - e \special {t4ht=$ model

LienLeschzinerLowRE

Lien-Leschziner low- $Re \special {t4ht=$ $k- e \special {t4ht=$ model

LRR

Launder-Reece-Rodi RSTM with wall functions

LaunderGibsonRSTM

Launder-Gibson RSTM with wall-reflection terms and wall functions

SpalartAllmaras

Spalart-Allmaras 1-eqn mixing-length model for external flows

RAS turbulence models for compressible fluids -- compressibleRASModels

laminar

Dummy turbulence model for laminar flow

kEpsilon

Standard $k - e \special {t4ht=$ model with wall functions

RNGkEpsilon

RNG $k - e \special {t4ht=$ model with wall functions

LaunderSharmaKE

Launder-Sharma low- $Re \special {t4ht=$ $k- e \special {t4ht=$ model

LRR

Launder-Reece-Rodi RSTM with wall functions

LaunderGibsonRSTM

Launder-Gibson RSTM with wall-reflection terms and wall functions

Large-eddy simulation (LES) filters -- LESfilters

laplaceFilter

Laplace filters

simpleFilter

Simple filter

anisotropicFilter

Anisotropic filter

Large-eddy simulation deltas -- LESdeltas

PrandtlDelta

Prandtl delta

cubeRootVolDelta

Cube root of cell volume delta

smoothDelta

Smoothing of delta

Incompressible LES turbulence models -- incompressibleLESModels

Smagorinsky

Smagorinsky model

Smagorinsky2

Smagorinsky model with 3-D filter

dynSmagorinsky

Dynamic Smagorinsky

scaleSimilarity

Scale similarity model

mixedSmagorinsky

Mixed Smagorinsky/scale similarity model

dynMixedSmagorinsky

Dynamic mixed Smagorinsky/scale similarity model

oneEqEddy

$k \special {t4ht=$ -equation eddy-viscosity model

dynOneEqEddy

Dynamic $k \special {t4ht=$ -equation eddy-viscosity model

locDynOneEqEddy

Localised dynamic $k \special {t4ht=$ -equation eddy-viscosity model

spectEddyVisc

Spectral eddy viscosity model

LRDDiffStress

LRR differential stress model

DeardorffDiffStress

Deardorff differential stress model

SpalartAllmaras

Spalart-Allmaras model

Compressible LES turbulence models -- compressibleLESModels

Smagorinsky

Smagorinsky model

oneEqEddy

$k \special {t4ht=$ -equation eddy-viscosity model

dynOneEqEddy

Dynamic $k \special {t4ht=$ -equation eddy-viscosity model

lowReOneEqEddy

Low- $Re \special {t4ht=$ $k \special {t4ht=$ -equation eddy-viscosity model

DeardorffDiffStress

Deardorff differential stress model

Table 3.9:

Libraries of RAS and LES turbulence models.

Transport models for incompressible fluids -- incompressibleTransportModels

Newtonian

Linear viscous fluid model

CrossPowerLaw

Cross Power law nonlinear viscous model

BirdCarreau

Bird-Carreau nonlinear viscous model

Table 3.10:

Shared object libraries of transport models.

[next] [prev] [prev-tail] [front] [up]