Interface Guide

From OpenFOAMWiki
Revision as of 13:19, 20 June 2016 by Nickninevah (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

1 Interface Guide

This provides documentation on the various options and dictionaries found for modifying openFoam settings. This webpage is organized according to the directory structure of the dictionaries within an OpenFOAM case. Each guide should specify the following elements.

  • Keywords
  • Specify if keywords are required or not
  • Expected format for any keyword values (best shown through an example)
  • Description of what the keyword controls
  • Range of possible values.
  • Any notes on usage tips or known bugs.

These pages serve more as a reference than an explanation. They do not necessarily expand on the expectations and implications of adjusting each of these settings. They only list the different ranges of possible inputs. For example, this guide may not describe the correct combination of different settings necessary in snappyHexMeshDict to achieve a valid mesh. It will only list the possible settings and their valid ranges.

1.1 Case Root Directory

Case Name .foam File


1.2 Constant Directory

1.2.1 dynamicMeshDict

Controls mesh morphing. Optional dictionary only used in cases where you have a dynamic mesh.

1.2.2 g

Specifies gravitational acceleration.

1.2.3 RAS Properties

Specifies turbulence model properties.

1.2.4 turbulenceProperties

Specifies the turbulence model.

1.2.5 transportProperties

Specifies material properties for your fluid or fluids.



1.2.6 TriSurface Directory

1.3 System Directory