OpenFOAM

The Open Source CFD Toolbox

Programmer’s Guide

Version 3.0.1
13th December 2015
P-2

c 2011-2015 OpenFOAM Foundation Ltd.

Copyright °
Author: Christopher J. Greenshields, CFD Direct Ltd.

This work is licensed under a

Creative Commons Attribution-NonCommercial-NoDerivs 3.0 Unported License.

Typeset in LATEX.

License
THE WORK (AS DEFINED BELOW) IS PROVIDED UNDER THE TERMS OF THIS CRE-
ATIVE COMMONS PUBLIC LICENSE (“CCPL” OR “LICENSE”). THE WORK IS PRO-
TECTED BY COPYRIGHT AND/OR OTHER APPLICABLE LAW. ANY USE OF THE WORK
OTHER THAN AS AUTHORIZED UNDER THIS LICENSE OR COPYRIGHT LAW IS PRO-
HIBITED.

BY EXERCISING ANY RIGHTS TO THE WORK PROVIDED HERE, YOU ACCEPT AND
AGREE TO BE BOUND BY THE TERMS OF THIS LICENSE. TO THE EXTENT THIS LI-
CENSE MAY BE CONSIDERED TO BE A CONTRACT, THE LICENSOR GRANTS YOU THE
RIGHTS CONTAINED HERE IN CONSIDERATION OF YOUR ACCEPTANCE OF SUCH
TERMS AND CONDITIONS.

1. Definitions
a. “Adaptation” means a work based upon the Work, or upon the Work and other pre-existing
works, such as a translation, adaptation, derivative work, arrangement of music or other
alterations of a literary or artistic work, or phonogram or performance and includes cine-
matographic adaptations or any other form in which the Work may be recast, transformed, or
adapted including in any form recognizably derived from the original, except that a work that
constitutes a Collection will not be considered an Adaptation for the purpose of this License.
For the avoidance of doubt, where the Work is a musical work, performance or phonogram,
the synchronization of the Work in timed-relation with a moving image (“synching”) will be
considered an Adaptation for the purpose of this License.

b. “Collection” means a collection of literary or artistic works, such as encyclopedias and an-
thologies, or performances, phonograms or broadcasts, or other works or subject matter
other than works listed in Section 1(f) below, which, by reason of the selection and arrange-
ment of their contents, constitute intellectual creations, in which the Work is included in its
entirety in unmodified form along with one or more other contributions, each constituting
separate and independent works in themselves, which together are assembled into a collec-
tive whole. A work that constitutes a Collection will not be considered an Adaptation (as
defined above) for the purposes of this License.

c. “Distribute” means to make available to the public the original and copies of the Work
through sale or other transfer of ownership.

d. “Licensor” means the individual, individuals, entity or entities that offer(s) the Work under
the terms of this License.

e. “Original Author” means, in the case of a literary or artistic work, the individual, individuals,
entity or entities who created the Work or if no individual or entity can be identified, the

OpenFOAM-3.0.1
 P-3

publisher; and in addition (i) in the case of a performance the actors, singers, musicians,
dancers, and other persons who act, sing, deliver, declaim, play in, interpret or otherwise
perform literary or artistic works or expressions of folklore; (ii) in the case of a phonogram
the producer being the person or legal entity who first fixes the sounds of a performance
or other sounds; and, (iii) in the case of broadcasts, the organization that transmits the
broadcast.
f. “Work” means the literary and/or artistic work offered under the terms of this License
including without limitation any production in the literary, scientific and artistic domain,
whatever may be the mode or form of its expression including digital form, such as a book,
pamphlet and other writing; a lecture, address, sermon or other work of the same nature;
a dramatic or dramatico-musical work; a choreographic work or entertainment in dumb
show; a musical composition with or without words; a cinematographic work to which are
assimilated works expressed by a process analogous to cinematography; a work of drawing,
painting, architecture, sculpture, engraving or lithography; a photographic work to which are
assimilated works expressed by a process analogous to photography; a work of applied art; an
illustration, map, plan, sketch or three-dimensional work relative to geography, topography,
architecture or science; a performance; a broadcast; a phonogram; a compilation of data to
the extent it is protected as a copyrightable work; or a work performed by a variety or circus
performer to the extent it is not otherwise considered a literary or artistic work.
g. “You” means an individual or entity exercising rights under this License who has not pre-
viously violated the terms of this License with respect to the Work, or who has received
express permission from the Licensor to exercise rights under this License despite a previous
violation.
h. “Publicly Perform” means to perform public recitations of the Work and to communicate to
the public those public recitations, by any means or process, including by wire or wireless
means or public digital performances; to make available to the public Works in such a way
that members of the public may access these Works from a place and at a place individu-
ally chosen by them; to perform the Work to the public by any means or process and the
communication to the public of the performances of the Work, including by public digital
performance; to broadcast and rebroadcast the Work by any means including signs, sounds
or images.
i. “Reproduce” means to make copies of the Work by any means including without limitation
by sound or visual recordings and the right of fixation and reproducing fixations of the Work,
including storage of a protected performance or phonogram in digital form or other electronic
medium.

2. Fair Dealing Rights.

Nothing in this License is intended to reduce, limit, or restrict any uses free from copyright or
rights arising from limitations or exceptions that are provided for in connection with the copyright
protection under copyright law or other applicable laws.

3. License Grant.
Subject to the terms and conditions of this License, Licensor hereby grants You a worldwide,
royalty-free, non-exclusive, perpetual (for the duration of the applicable copyright) license to ex-
ercise the rights in the Work as stated below:
a. to Reproduce the Work, to incorporate the Work into one or more Collections, and to
Reproduce the Work as incorporated in the Collections;

OpenFOAM-3.0.1
P-4

b. and, to Distribute and Publicly Perform the Work including as incorporated in Collections.

The above rights may be exercised in all media and formats whether now known or hereafter
devised. The above rights include the right to make such modifications as are technically necessary
to exercise the rights in other media and formats, but otherwise you have no rights to make
Adaptations. Subject to 8(f), all rights not expressly granted by Licensor are hereby reserved,
including but not limited to the rights set forth in Section 4(d).

4. Restrictions.
The license granted in Section 3 above is expressly made subject to and limited by the following
restrictions:

a. You may Distribute or Publicly Perform the Work only under the terms of this License. You
must include a copy of, or the Uniform Resource Identifier (URI) for, this License with every
copy of the Work You Distribute or Publicly Perform. You may not offer or impose any terms
on the Work that restrict the terms of this License or the ability of the recipient of the Work
to exercise the rights granted to that recipient under the terms of the License. You may not
sublicense the Work. You must keep intact all notices that refer to this License and to the
disclaimer of warranties with every copy of the Work You Distribute or Publicly Perform.
When You Distribute or Publicly Perform the Work, You may not impose any effective
technological measures on the Work that restrict the ability of a recipient of the Work from
You to exercise the rights granted to that recipient under the terms of the License. This
Section 4(a) applies to the Work as incorporated in a Collection, but this does not require
the Collection apart from the Work itself to be made subject to the terms of this License. If
You create a Collection, upon notice from any Licensor You must, to the extent practicable,
remove from the Collection any credit as required by Section 4(c), as requested.

b. You may not exercise any of the rights granted to You in Section 3 above in any manner
that is primarily intended for or directed toward commercial advantage or private monetary
compensation. The exchange of the Work for other copyrighted works by means of digital file-
sharing or otherwise shall not be considered to be intended for or directed toward commercial
advantage or private monetary compensation, provided there is no payment of any monetary
compensation in connection with the exchange of copyrighted works.

c. If You Distribute, or Publicly Perform the Work or Collections, You must, unless a request
has been made pursuant to Section 4(a), keep intact all copyright notices for the Work
and provide, reasonable to the medium or means You are utilizing: (i) the name of the
Original Author (or pseudonym, if applicable) if supplied, and/or if the Original Author
and/or Licensor designate another party or parties (e.g., a sponsor institute, publishing
entity, journal) for attribution (“Attribution Parties”) in Licensor’s copyright notice, terms
of service or by other reasonable means, the name of such party or parties; (ii) the title of
the Work if supplied; (iii) to the extent reasonably practicable, the URI, if any, that Licensor
specifies to be associated with the Work, unless such URI does not refer to the copyright
notice or licensing information for the Work. The credit required by this Section 4(c) may be
implemented in any reasonable manner; provided, however, that in the case of a Collection,
at a minimum such credit will appear, if a credit for all contributing authors of Collection
appears, then as part of these credits and in a manner at least as prominent as the credits
for the other contributing authors. For the avoidance of doubt, You may only use the credit
required by this Section for the purpose of attribution in the manner set out above and, by
exercising Your rights under this License, You may not implicitly or explicitly assert or imply
any connection with, sponsorship or endorsement by the Original Author, Licensor and/or

OpenFOAM-3.0.1
 P-5

Attribution Parties, as appropriate, of You or Your use of the Work, without the separate,
express prior written permission of the Original Author, Licensor and/or Attribution Parties.

d. For the avoidance of doubt:

i. Non-waivable Compulsory License Schemes. In those jurisdictions in which the

right to collect royalties through any statutory or compulsory licensing scheme cannot
be waived, the Licensor reserves the exclusive right to collect such royalties for any
exercise by You of the rights granted under this License;
ii. Waivable Compulsory License Schemes. In those jurisdictions in which the right
to collect royalties through any statutory or compulsory licensing scheme can be waived,
the Licensor reserves the exclusive right to collect such royalties for any exercise by You
of the rights granted under this License if Your exercise of such rights is for a purpose
or use which is otherwise than noncommercial as permitted under Section 4(b) and
otherwise waives the right to collect royalties through any statutory or compulsory
licensing scheme; and,
iii. Voluntary License Schemes. The Licensor reserves the right to collect royalties,
whether individually or, in the event that the Licensor is a member of a collecting
society that administers voluntary licensing schemes, via that society, from any exercise
by You of the rights granted under this License that is for a purpose or use which is
otherwise than noncommercial as permitted under Section 4(b).

e. Except as otherwise agreed in writing by the Licensor or as may be otherwise permitted by

applicable law, if You Reproduce, Distribute or Publicly Perform the Work either by itself or
as part of any Collections, You must not distort, mutilate, modify or take other derogatory
action in relation to the Work which would be prejudicial to the Original Author’s honor or
reputation.

5. Representations, Warranties and Disclaimer

UNLESS OTHERWISE MUTUALLY AGREED BY THE PARTIES IN WRITING, LICENSOR
OFFERS THE WORK AS-IS AND MAKES NO REPRESENTATIONS OR WARRANTIES OF
ANY KIND CONCERNING THE WORK, EXPRESS, IMPLIED, STATUTORY OR OTHER-
WISE, INCLUDING, WITHOUT LIMITATION, WARRANTIES OF TITLE, MERCHANTIBIL-
ITY, FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR THE ABSENCE
OF LATENT OR OTHER DEFECTS, ACCURACY, OR THE PRESENCE OF ABSENCE OF
ERRORS, WHETHER OR NOT DISCOVERABLE. SOME JURISDICTIONS DO NOT ALLOW
THE EXCLUSION OF IMPLIED WARRANTIES, SO SUCH EXCLUSION MAY NOT APPLY
TO YOU.

6. Limitation on Liability.
EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE LAW, IN NO EVENT WILL LI-
CENSOR BE LIABLE TO YOU ON ANY LEGAL THEORY FOR ANY SPECIAL, INCIDEN-
TAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES ARISING OUT OF THIS
LICENSE OR THE USE OF THE WORK, EVEN IF LICENSOR HAS BEEN ADVISED OF
THE POSSIBILITY OF SUCH DAMAGES.

7. Termination
a. This License and the rights granted hereunder will terminate automatically upon any breach
by You of the terms of this License. Individuals or entities who have received Collections

OpenFOAM-3.0.1
P-6

from You under this License, however, will not have their licenses terminated provided such
individuals or entities remain in full compliance with those licenses. Sections 1, 2, 5, 6, 7,
and 8 will survive any termination of this License.

b. Subject to the above terms and conditions, the license granted here is perpetual (for the
duration of the applicable copyright in the Work). Notwithstanding the above, Licensor
reserves the right to release the Work under different license terms or to stop distributing
the Work at any time; provided, however that any such election will not serve to withdraw
this License (or any other license that has been, or is required to be, granted under the terms
of this License), and this License will continue in full force and effect unless terminated as
stated above.

8. Miscellaneous
a. Each time You Distribute or Publicly Perform the Work or a Collection, the Licensor offers
to the recipient a license to the Work on the same terms and conditions as the license granted
to You under this License.

b. If any provision of this License is invalid or unenforceable under applicable law, it shall
not affect the validity or enforceability of the remainder of the terms of this License, and
without further action by the parties to this agreement, such provision shall be reformed to
the minimum extent necessary to make such provision valid and enforceable.

c. No term or provision of this License shall be deemed waived and no breach consented to
unless such waiver or consent shall be in writing and signed by the party to be charged with
such waiver or consent.

d. This License constitutes the entire agreement between the parties with respect to the Work
licensed here. There are no understandings, agreements or representations with respect to
the Work not specified here. Licensor shall not be bound by any additional provisions that
may appear in any communication from You.

e. This License may not be modified without the mutual written agreement of the Licensor
and You. The rights granted under, and the subject matter referenced, in this License were
drafted utilizing the terminology of the Berne Convention for the Protection of Literary
and Artistic Works (as amended on September 28, 1979), the Rome Convention of 1961,
the WIPO Copyright Treaty of 1996, the WIPO Performances and Phonograms Treaty of
1996 and the Universal Copyright Convention (as revised on July 24, 1971). These rights
and subject matter take effect in the relevant jurisdiction in which the License terms are
sought to be enforced according to the corresponding provisions of the implementation of
those treaty provisions in the applicable national law. If the standard suite of rights granted
under applicable copyright law includes additional rights not granted under this License,
such additional rights are deemed to be included in the License; this License is not intended
to restrict the license of any rights under applicable law.

OpenFOAM-3.0.1
 P-7

Trademarks

ANSYS is a registered trademark of ANSYS Inc.

CFX is a registered trademark of Ansys Inc.
CHEMKIN is a registered trademark of Reaction Design Corporation
EnSight is a registered trademark of Computational Engineering International Ltd.
Fieldview is a registered trademark of Intelligent Light
Fluent is a registered trademark of Ansys Inc.
GAMBIT is a registered trademark of Ansys Inc.
Icem-CFD is a registered trademark of Ansys Inc.
I-DEAS is a registered trademark of Structural Dynamics Research Corporation
JAVA is a registered trademark of Sun Microsystems Inc.
Linux is a registered trademark of Linus Torvalds
OpenFOAM is a registered trademark of ESI Group
ParaView is a registered trademark of Kitware
STAR-CD is a registered trademark of Computational Dynamics Ltd.
UNIX is a registered trademark of The Open Group

OpenFOAM-3.0.1
P-8

OpenFOAM-3.0.1
Contents

Copyright Notice P-2

1. Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . P-2
2. Fair Dealing Rights. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . P-3
3. License Grant. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . P-3
4. Restrictions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . P-4
5. Representations, Warranties and Disclaimer . . . . . . . . . . . . . . . . . P-5
6. Limitation on Liability. . . . . . . . . . . . . . . . . . . . . . . . . . . . . P-5
7. Termination . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . P-5
8. Miscellaneous . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . P-6

Trademarks P-7

Contents P-9

1 Tensor mathematics P-13

1.1 Coordinate system . . . . . . . . . . . . . . . . . . . . . . . . . . . . . P-13
1.2 Tensors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . P-13
1.2.1 Tensor notation . . . . . . . . . . . . . . . . . . . . . . . . . . . P-15
1.3 Algebraic tensor operations . . . . . . . . . . . . . . . . . . . . . . . . P-16
1.3.1 The inner product . . . . . . . . . . . . . . . . . . . . . . . . . P-16
1.3.2 The double inner product of two tensors . . . . . . . . . . . . . P-17
1.3.3 The triple inner product of two third rank tensors . . . . . . . . P-17
1.3.4 The outer product . . . . . . . . . . . . . . . . . . . . . . . . . P-17
1.3.5 The cross product of two vectors . . . . . . . . . . . . . . . . . P-18
1.3.6 Other general tensor operations . . . . . . . . . . . . . . . . . . P-18
1.3.7 Geometric transformation and the identity tensor . . . . . . . . P-19
1.3.8 Useful tensor identities . . . . . . . . . . . . . . . . . . . . . . . P-19
1.3.9 Operations exclusive to tensors of rank 2 . . . . . . . . . . . . . P-20
1.3.10 Operations exclusive to scalars . . . . . . . . . . . . . . . . . . . P-21
1.4 OpenFOAM tensor classes . . . . . . . . . . . . . . . . . . . . . . . . . P-21
1.4.1 Algebraic tensor operations in OpenFOAM . . . . . . . . . . . . P-22
1.5 Dimensional units . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . P-24

2 Discretisation procedures P-25

2.1 Differential operators . . . . . . . . . . . . . . . . . . . . . . . . . . . . P-25
2.1.1 Gradient . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . P-25
2.1.2 Divergence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . P-26
2.1.3 Curl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . P-26
P-10 Contents

2.1.4 Laplacian . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . P-26

2.1.5 Temporal derivative . . . . . . . . . . . . . . . . . . . . . . . . . P-26
2.2 Overview of discretisation . . . . . . . . . . . . . . . . . . . . . . . . . P-27
2.2.1 OpenFOAM lists and fields . . . . . . . . . . . . . . . . . . . . P-27
2.3 Discretisation of the solution domain . . . . . . . . . . . . . . . . . . . P-28
2.3.1 Defining a mesh in OpenFOAM . . . . . . . . . . . . . . . . . . P-29
2.3.2 Defining a geometricField in OpenFOAM . . . . . . . . . . . . . P-30
2.4 Equation discretisation . . . . . . . . . . . . . . . . . . . . . . . . . . . P-31
2.4.1 The Laplacian term . . . . . . . . . . . . . . . . . . . . . . . . . P-36
2.4.2 The convection term . . . . . . . . . . . . . . . . . . . . . . . . P-36
2.4.3 First time derivative . . . . . . . . . . . . . . . . . . . . . . . . P-37
2.4.4 Second time derivative . . . . . . . . . . . . . . . . . . . . . . . P-37
2.4.5 Divergence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . P-37
2.4.6 Gradient . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . P-38
2.4.7 Grad-grad squared . . . . . . . . . . . . . . . . . . . . . . . . . P-39
2.4.8 Curl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . P-39
2.4.9 Source terms . . . . . . . . . . . . . . . . . . . . . . . . . . . . P-39
2.4.10 Other explicit discretisation schemes . . . . . . . . . . . . . . . P-39
2.5 Temporal discretisation . . . . . . . . . . . . . . . . . . . . . . . . . . . P-40
2.5.1 Treatment of temporal discretisation in OpenFOAM . . . . . . P-41
2.6 Boundary Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . P-41
2.6.1 Physical boundary conditions . . . . . . . . . . . . . . . . . . . P-42

3 Examples of the use of OpenFOAM P-43

3.1 Flow around a cylinder . . . . . . . . . . . . . . . . . . . . . . . . . . . P-43
3.1.1 Problem specification . . . . . . . . . . . . . . . . . . . . . . . . P-44
3.1.2 Note on potentialFoam . . . . . . . . . . . . . . . . . . . . . . . P-45
3.1.3 Mesh generation . . . . . . . . . . . . . . . . . . . . . . . . . . P-45
3.1.4 Boundary conditions and initial fields . . . . . . . . . . . . . . . P-47
3.1.5 Running the case . . . . . . . . . . . . . . . . . . . . . . . . . . P-48
3.2 Steady turbulent flow over a backward-facing step . . . . . . . . . . . . P-50
3.2.1 Problem specification . . . . . . . . . . . . . . . . . . . . . . . . P-50
3.2.2 Mesh generation . . . . . . . . . . . . . . . . . . . . . . . . . . P-53
3.2.3 Boundary conditions and initial fields . . . . . . . . . . . . . . . P-56
3.2.4 Case control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . P-57
3.2.5 Running the case and post-processing . . . . . . . . . . . . . . . P-57
3.3 Supersonic flow over a forward-facing step . . . . . . . . . . . . . . . . P-58
3.3.1 Problem specification . . . . . . . . . . . . . . . . . . . . . . . . P-58
3.3.2 Mesh generation . . . . . . . . . . . . . . . . . . . . . . . . . . P-59
3.3.3 Running the case . . . . . . . . . . . . . . . . . . . . . . . . . . P-61
3.3.4 Exercise . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . P-61
3.4 Decompression of a tank internally pressurised with water . . . . . . . P-61
3.4.1 Problem specification . . . . . . . . . . . . . . . . . . . . . . . . P-62
3.4.2 Mesh Generation . . . . . . . . . . . . . . . . . . . . . . . . . . P-63
3.4.3 Preparing the Run . . . . . . . . . . . . . . . . . . . . . . . . . P-65
3.4.4 Running the case . . . . . . . . . . . . . . . . . . . . . . . . . . P-66
3.4.5 Improving the solution by refining the mesh . . . . . . . . . . . P-67
3.5 Magnetohydrodynamic flow of a liquid . . . . . . . . . . . . . . . . . . P-67

OpenFOAM-3.0.1
Contents P-11

3.5.1 Problem specification . . . . . . . . . . . . . . . . . . . . . . . . P-67

3.5.2 Mesh generation . . . . . . . . . . . . . . . . . . . . . . . . . . P-69
3.5.3 Running the case . . . . . . . . . . . . . . . . . . . . . . . . . . P-70

Index P-73

OpenFOAM-3.0.1
P-12 Contents

OpenFOAM-3.0.1
Chapter 1

Tensor mathematics

This Chapter describes tensors and their algebraic operations and how they are represented
in mathematical text in this book. It then explains how tensors and tensor algebra are
programmed in OpenFOAM.

1.1 Coordinate system

OpenFOAM is primarily designed to solve problems in continuum mechanics, i.e. the branch
of mechanics concerned with the stresses in solids, liquids and gases and the deformation
or flow of these materials. OpenFOAM is therefore based in 3 dimensional space and
time and deals with physical entities described by tensors. The coordinate system used by
OpenFOAM is the right-handed rectangular Cartesian axes as shown in Figure 1.1. This
system of axes is constructed by defining an origin O from which three lines are drawn at
right angles to each other, termed the Ox, Oy, Oz axes. A right-handed set of axes is
defined such that to an observer looking down the Oz axis (with O nearest them), the arc
from a point on the Ox axis to a point on the Oy axis is in a clockwise sense.

x
Figure 1.1: Right handed axes

1.2 Tensors
The term tensor describes an entity that belongs to a particular space and obeys certain
mathematical rules. Briefly, tensors are represented by a set of component values relating
P-14 Tensor mathematics

to a set of unit base vectors; in OpenFOAM the unit base vectors ix , iy and iz are aligned
with the right-handed rectangular Cartesian axes x, y and z respectively. The base vectors
are therefore orthogonal, i.e. at right-angles to one another. Every tensor has the following
attributes:

Dimension d of the particular space to which they belong, i.e. d = 3 in OpenFOAM;

Rank An integer r ≥ 0, such that the number of component values = dr .

While OpenFOAM is set to 3 dimensions, it offers tensors of ranks 0 to 3 as standard

while being written in such a way to allow this basic set of ranks to be extended indefinitely.
Tensors of rank 0 and 1, better known as scalars and vectors, should be familiar to readers;
tensors of rank 2 and 3 may not be so familiar. For completeness all ranks of tensor offered
as standard in OpenFOAM are reviewed below.

Rank 0 ‘scalar’ Any property which can be represented by a single real number, denoted
by characters in italics, e.g. mass m, volume V , pressure p and viscosity µ.

Rank 1 ‘vector’ An entity which can be represented physically by both magnitude and
direction. In component form, the vector a = (a1 , a2 , a3 ) relates to a set of Cartesian
axes x, y, z respectively. The index notation presents the same vector as ai , i = 1, 2, 3,
although the list of indices i = 1, 2, 3 will be omitted in this book, as it is intuitive
since we are always dealing with 3 dimensions.

Rank 2 ‘tensor’ or second rank tensor, T has 9 components which can be expressed in
array notation as:
 
T11 T12 T13
T = Tij =  T21 T22 T23  (1.1)
T31 T32 T33

The components Tij are now represented using 2 indices since r = 2 and the list of
indices i, j = 1, 2, 3 is omitted as before. The components for which i = j are referred
to as the diagonal components, and those for which i 6= j are referred to as the off-
diagonal components. The transpose of T is produced by exchanging components
across the diagonal such that
 
T11 T21 T31
TT = Tji =  T12 T22 T32  (1.2)
T13 T23 T33

Note: a rank 2 tensor is often colloquially termed ‘tensor’ since the occurrence of
higher order tensors is fairly rare.

Symmetric rank 2 The term ‘symmetric’ refers to components being symmetric about the
diagonal, i.e. Tij = Tji . In this case, there are only 6 independent components since
T12 = T21 , T13 = T31 and T23 = T32 . OpenFOAM distinguishes between symmetric
and non-symmetric tensors to save memory by storing 6 components rather than 9
if the tensor is symmetric. Most tensors encountered in continuum mechanics are
symmetric.

OpenFOAM-3.0.1
1.2 Tensors P-15

Rank 3 has 27 components and is represented in index notation as Pijk which is too long
to represent in array notation as in Equation 1.1.

Symmetric rank 3 Symmetry of a rank 3 tensor is defined in OpenFOAM to mean that

Pijk = Pikj = Pjik = Pjki = Pkij = Pkji and therefore has 10 independent components.
More specifically, it is formed by the outer product of 3 identical vectors, where the
outer product operation is described in Section 1.3.4.

1.2.1 Tensor notation

This is a book on computational continuum mechanics that deals with problems involving
complex PDEs in 3 spatial dimensions and in time. It is vital from the beginning to adopt a
notation for the equations which is compact yet unambiguous. To make the equations easy
to follow, we must use a notation that encapsulates the idea of a tensor as an entity in the
own right, rather than a list of scalar components. Additionally, any tensor operation should
be perceived as an operation on the entire tensor entity rather than a series of operations
on its components.
Consequently, in this book the tensor notation is preferred in which any tensor of rank
1 and above, i.e. all tensors other than scalars, are represented by letters in bold face, e.g.
a. This actively promotes the concept of a tensor as a entity in its own right since it is
denoted by a single symbol, and it is also extremely compact. The potential drawback is
that the rank of a bold face symbol is not immediately apparent, although it is clearly not
zero. However, in practice this presents no real problem since we are aware of the property
each symbol represents and therefore intuitively know its rank, e.g. we know velocity U is
a tensor of rank 1.
A further, more fundamental idea regarding the choice of notation is that the mathemat-
ical representation of a tensor should not change depending on our coordinate system, i.e.
the vector ais the same vector irrespective of where we view it from. The tensor notation
supports this concept as it implies nothing about the coordinate system. However, other
notations, e.g. ai , expose the individual components of the tensor which naturally implies
the choice of coordinate system. The unsatisfactory consequence of this is that the tensor is
then represented by a set of values which are not unique — they depend on the coordinate
system.
That said, the index notation, introduced in Section 1.2, is adopted from time to time
in this book mainly to expand tensor operations into the constituent components. When
using the index notation, we adopt the summation convention which states that whenever
the same letter subscript occurs twice in a term, the that subscript is to be given all values,
i.e. 1, 2, 3, and the results added together, e.g.

3
X
ai b i = ai b i = a1 b 1 + a2 b 2 + a3 b 3 (1.3)
i=1

P
In the remainder of the book the symbol is omitted since the repeated subscript
indicates the summation.

OpenFOAM-3.0.1
P-16 Tensor mathematics

1.3 Algebraic tensor operations

This section describes all the algebraic operations for tensors that are available in Open-
FOAM. Let us first review the most simple tensor operations: addition, subtraction, and
scalar multiplication and division. Addition and subtraction are both commutative and as-
sociative and are only valid between tensors of the same rank. The operations are performed
by addition/subtraction of respective components of the tensors, e.g. the subtraction of two
vectors a and b is
a − b = ai − bi = (a1 − b1 , a2 − b2 , a3 − b3 ) (1.4)
Multiplication of any tensor a by a scalar s is also commutative and associative and is
performed by multiplying all the tensor components by the scalar. For example,
sa = sai = (sa1 , sa2 , sa3 ) (1.5)
Division between a tensor a and a scalar is only relevant when the scalar is the second
argument of the operation, i.e.
a/s = ai /s = (a1 /s, a2 /s, a3 /s) (1.6)
Following these operations are a set of more complex products between tensors of rank 1
and above, described in the following Sections.

1.3.1 The inner product

The inner product operates on any two tensors of rank r1 and r2 such that the rank of the
result r = r1 + r2 − 2. Inner product operations with tensors up to rank 3 are described
below:
• The inner product of two vectors a and b is commutative and produces a scalar
s = a • b where
s = ai b i = a1 b 1 + a2 b 2 + a3 b 3 (1.7)

• The inner product of a tensor T and vector a produces a vector b = T • a, represented

below as a column array for convenience
 
T11 a1 + T12 a2 + T13 a3
bi = Tij aj =  T21 a1 + T22 a2 + T23 a3  (1.8)
T31 a1 + T32 a2 + T33 a3
It is non-commutative if T is non-symmetric such that b = a • T = TT • a is
 
a1 T11 + a2 T21 + a3 T31
bi = aj Tji =  a1 T12 + a2 T22 + a3 T32  (1.9)
a1 T13 + a2 T23 + a3 T33

• The inner product of two tensors T and S produces a tensor P = T • S whose com-
ponents are evaluated as:
Pij = Tik Skj (1.10)
¡ ¢T
It is non-commutative such that T • S = ST • TT

OpenFOAM-3.0.1
1.3 Algebraic tensor operations P-17

• The inner product of a vector a and third rank tensor P produces a second rank tensor
T = a • P whose components are
Tij = ak Pkij (1.11)
Again this is non-commutative so that T = P • a is
Tij = Pijk ak (1.12)

• The inner product of a second rank tensor T and third rank tensor P produces a third
rank tensor Q = T • P whose components are
Qijk = Til Pljk (1.13)
Again this is non-commutative so that Q = P • T is
Qijk = Pijl Tlk (1.14)

1.3.2 The double inner product of two tensors

The double inner product of two second-rank tensors T and S produces a scalar s = T •• S
which can be evaluated as the sum of the 9 products of the tensor components
s = Tij Sij = T11 S11 + T12 S12 + T13 S13 + (1.15)
T21 S21 + T22 S22 + T23 S23 +
T31 S31 + T32 S32 + T33 S33
The double inner product between a second rank tensor T and third rank tensor P
produces a vector a = T •• P with components
ai = Tjk Pjki (1.16)
This is non-commutative so that a = P •• T is
ai = Pijk Tjk (1.17)

1.3.3 The triple inner product of two third rank tensors

The triple inner product of two third rank tensors P and Q produces a scalar s = P •3 Q
which can be evaluated as the sum of the 27 products of the tensor components
s = Pijk Qijk (1.18)

1.3.4 The outer product

The outer product operates between vectors and tensors as follows:
• The outer product of two vectors a and b is non-commutative and produces a tensor
T = ab = (ba)T whose components are evaluated as:
 
a1 b 1 a1 b 2 a1 b 3
Tij = ai bj =  a2 b1 a2 b2 a2 b3  (1.19)
a3 b 1 a3 b 2 a3 b 3

OpenFOAM-3.0.1
P-18 Tensor mathematics

• An outer product of a vector a and second rank tensor T produces a third rank tensor
P = aT whose components are
Pijk = ai Tjk (1.20)
This is non-commutative so that P = T a produces
Pijk = Tij ak (1.21)

1.3.5 The cross product of two vectors

The cross product operation is exclusive to vectors only. For two vectors a with b, it
produces a vector c = a × b whose components are
ci = eijk aj bk = (a2 b3 − a3 b2 , a3 b1 − a1 b3 , a1 b2 − a2 b1 ) (1.22)
where the permutation symbol is defined by

0
 when any two indices are equal
eijk = +1 when i,j,k are an even permutation of 1,2,3 (1.23)


−1 when i,j,k are an odd permutation of 1,2,3
in which the even permutations are 123, 231 and 312 and the odd permutations are 132,
213 and 321.

1.3.6 Other general tensor operations

Some less common tensor operations and terminology used by OpenFOAM are described
below.
Square of a tensor is defined as the outer product of the tensor with itself, e.g. for a vector
a, the square a2 = aa.
nth power of a tensor is evaluated by n outer products of the tensor, e.g. for a vector a,
the 3rd power a3 = aaa.
Magnitude squared of a tensor is the rth inner product of the tensor of rank r with itself,
to produce a scalar. For example, for a second rank tensor T, |T|2 = T •• T.
√
Magnitude is the square root of the magnitude squared, e.g. for a tensor T, |T| = T •• T.
Vectors of unit magnitude are referred to as unit vectors.
Component maximum is the component of the tensor with greatest value, inclusive of
sign, i.e. not the largest magnitude.
Component minimum is the component of the tensor with smallest value.
Component average is the mean of all components of a tensor.
Scale As the name suggests, the scale function is a tool for scaling the components of one
tensor by the components of another tensor of the same rank. It is evaluated as the
product of corresponding components of 2 tensors, e.g., scaling vector a by vector b
would produce vector c whose components are
ci = scale(a, b) = (a1 b1 , a2 b2 , a3 b3 ) (1.24)

OpenFOAM-3.0.1
1.3 Algebraic tensor operations P-19

1.3.7 Geometric transformation and the identity tensor

A second rank tensor T is strictly defined as a linear vector function, i.e. it is a function
which associates an argument vector a to another vector b by the inner product b = T • a.
The components of T can be chosen to perform a specific geometric transformation of a
tensor from the x, y, z coordinate system to a new coordinate system x∗ , y ∗ , z ∗ ; T is
then referred to as the transformation tensor . While a scalar remains unchanged under a
transformation, the vector a is transformed to a∗ by

a∗ = T • a (1.25)

A second rank tensor S is transformed to S∗ according to

S∗ = T • S • TT (1.26)

The identity tensor I is defined by the requirement that it transforms another tensor
onto itself. For all vectors a

a=I•a (1.27)

and therefore
 
1 0 0
I = δij =  0 1 0  (1.28)
0 0 1

where δij is known as the Kronecker delta symbol.

1.3.8 Useful tensor identities

Several identities are listed below which can be verified by under the assumption that all
the relevant derivatives exist and are continuous. The identities are expressed for scalar s
and vector a.

∇ • (∇ × a) ≡ 0
∇ × (∇s) ≡ 0
∇ • (sa) ≡ s∇ • a + a • ∇s
∇ × (sa) ≡ s∇ × a + ∇s × a
∇(a • b) ≡ a × (∇ × b) + b × (∇ × a) + (a • ∇)b + (b • ∇)a (1.29)
∇ • (a × b) ≡ b • (∇ × a) − a • (∇ × b)
∇ × (a × b) ≡ a(∇ • b) − b(∇ • a) + (b • ∇)a − (a • ∇)b
∇ × (∇ × a) ≡ ∇(∇ • a) − ∇2 a
(∇ × a) × a ≡ a • (∇a) − ∇(a • a)

It is sometimes useful to know the e − δ identity to help to manipulate equations in index

notation:

eijk eirs = δjr δks − δjs δkr (1.30)

OpenFOAM-3.0.1
P-20 Tensor mathematics

1.3.9 Operations exclusive to tensors of rank 2

There are several operations that manipulate the components of tensors of rank 2 that are
listed below:
Transpose of a tensor T = Tij is TT = Tji as described in Equation 1.2.

Symmetric and skew (antisymmetric) tensors As discussed in section 1.2, a tensor is

said to be symmetric if its components are symmetric about the diagonal, i.e. T =
TT . A skew or antisymmetric tensor has T = −TT which intuitively implies that
T11 = T22 = T33 = 0. Every second order tensor can be decomposed into symmetric
and skew parts by
1 1
T = (T + TT ) + (T − TT ) = symm T + skew T (1.31)
|2 {z } |2 {z }
symmetric skew

Trace The trace of a tensor T is a scalar, evaluated by summing the diagonal components

tr T = T11 + T22 + T33 (1.32)

Diagonal returns a vector whose components are the diagonal components of the second
rank tensor T

diag T = (T11 , T22 , T33 ) (1.33)

Deviatoric and hydrostatic tensors Every second rank tensor T can be decomposed
into a deviatoric component, for which tr T = 0 and a hydrostatic component of the
form T = sI where s is a scalar. Every second rank tensor can be decomposed into
deviatoric and hydrostatic parts as follows:
1 1
T = T − (tr T) I + (tr T) I = dev T + hyd T (1.34)
| 3{z } |3 {z }
deviatoric hydrostatic

Determinant The determinant of a second rank tensor is evaluated by

¯ ¯
¯ T11 T12 T13 ¯
¯ ¯
det T = ¯¯ T21 T22 T23 ¯ = T11 (T22 T33 − T23 T32 ) −
¯
¯ T31 T32 T33 ¯ T12 (T21 T33 − T23 T31 ) +
(1.35)
T13 (T21 T32 − T22 T31 )
1
= eijk epqr Tip Tjq Tkr
6

Cofactors The minors of a tensor are evaluated for each component by deleting the row
and column in which the component is situated and evaluating the resulting entries
as a 2 × 2 determinant. For example, the minor of T12 is
¯ ¯
¯ T11 T12 T13 ¯ ¯ ¯
¯ T21 T22 T23 ¯ = ¯ T21 T23 ¯ = T21 T33 − T23 T31
¯ ¯ ¯ ¯
¯ ¯ ¯ T31 T33 ¯ (1.36)
¯ T31 T32 T33 ¯

OpenFOAM-3.0.1
1.4 OpenFOAM tensor classes P-21

The cofactors are signed minors where each minor is component is given a sign based
on the rule
+ve if i + j is even
(1.37)
−ve if i + j is odd

The cofactors of T can be evaluated as

1
cof T = ejkr eist Tsk Ttr (1.38)
2
Inverse The inverse of a tensor can be evaluated as
cof TT
inv T = (1.39)
det T
Hodge dual of a tensor is a vector whose components are
∗ T = (T23 , −T13 , T12 ) (1.40)

1.3.10 Operations exclusive to scalars

OpenFOAM supports most of the well known functions that operate on scalars, e.g. square
root, exponential, logarithm, sine, cosine etc.., a list of which can be found in Table 1.2.
There are 3 additional functions defined within OpenFOAM that are described below:
Sign of a scalar s is
(
1 if s ≥ 0,
sgn(s) = (1.41)
−1 if s < 0.

Positive of a scalar s is
(
1 if s ≥ 0,
pos(s) = (1.42)
0 if s < 0.

Limit of a scalar s by the scalar n

(
s if s < n,
limit(s, n) = (1.43)
0 if s ≥ n.

1.4 OpenFOAM tensor classes

OpenFOAM contains a C++ class library primitive that contains the classes for the tensor
mathematics described so far. The basic tensor classes that are available as standard in
OpenFOAM are listed in Table 1.1. The Table also lists the functions that allow the user
to access individual components of a tensor, known as access functions.
We can declare the tensor
 
1 2 3
T= 4 5 6  (1.44)
7 8 9
in OpenFOAM by the line:

OpenFOAM-3.0.1
 P-22 Tensor mathematics

Rank Common name Basic class Access functions

0 Scalar scalar
1 Vector vector x(), y(), z()
2 Tensor tensor xx(), xy(), xz(). . .
‫ﺗوﺟﮫ ﺑﺷﮫ ﮐﮫ اوﻟﯾن دراﯾﮫ‬
‫ﯾﮏ ھﺳت‬ Table 1.1: Basic tensor classes in OpenFOAM

‫دﻗت ﺷود ﮐﮫ اﭘﻧﻔوم ﺑﮫ‬

‫ﺻورت ﺧطﯽ ﻧﻣﺎﯾش ﻣﯾده‬
‫ﻣﺎﺗرﯾس ھﺎ رو‬
tensor T(1, 2, 3, 4, 5, 6, 7, 8, 9);

We can then access the component T13 , or Txz using the xz() access function. For
instance the code

Info << ``Txz = '' << T.xz() << endl;

‫ﻧﺣوه ی دﺳﺗرﺳﯽ ﺑﮫ ھر ﮐدام‬
outputs to the screen: ‫از دراﯾﮫ ھﺎ‬

Txz = 3

1.4.1 Algebraic tensor operations in OpenFOAM

The algebraic operations described in Section 1.3 are all available to the OpenFOAM tensor
classes using syntax which closely mimics the notation used in written mathematics. Some
functions are represented solely by descriptive functions, e.g.symm(), but others can also be
executed using symbolic operators, e.g.*. All functions are listed in Table 1.2.

Operation Comment Mathematical Description

Description in OpenFOAM
Addition a+b a + b
Subtraction a−b a - b
Scalar multiplication sa s * a
Scalar division a/s a / s
‫دﻗت ﺷود ﮐﮫ‬ Outer product rank a, b >= 1 ab a * b
‫ﺻرب ﺧﺎرﺟﯽ‬
‫و ﺿرب ﮐراس‬
Inner product rank a, b >= 1 a • b a & b
‫ﻣﺗﻔﺎوت اﺳت‬ Double inner product rank a, b >= 2 a •• b a && b
Cross product rank a, b = 1 a×b a ^ b
Square a2 sqr(a)
Magnitude squared |a|2 magSqr(a)
Magnitude |a| mag(a)
Power n = 0, 1, ..., 4 an pow(a,n)
Component average i = 1, ..., N ai cmptAv(a)
Component maximum i = 1, ..., N max(ai ) max(a)
Component minimum i = 1, ..., N min(ai ) min(a)
Scale scale(a,b) scale(a,b)
Geometric transformation transforms a using tensor T transform(T,a)

Operations exclusive to tensors of rank 2

Continued on next page
OpenFOAM-3.0.1
1.4 OpenFOAM tensor classes P-23

Continued from previous page

Operation Comment Mathematical Description
Description in OpenFOAM
Transpose TT T.T()
Diagonal diag T diag(T)
Trace tr T tr(T)
Deviatoric component dev T dev(T)
Symmetric component symm T symm(T)
Skew-symmetric component skew T skew(T)
Determinant det T det(T)
Cofactors cof T cof(T)
Inverse inv T inv(T)
Hodge dual ∗T *T

Operations exclusive to scalars

Sign (boolean) sgn(s) sign(s)
Positive (boolean) s >= 0 pos(s)
Negative (boolean) s<0 neg(s)
Limit n scalar limit(s,
√ n) limit(s,n)
Square root s sqrt(s)
Exponential exp s exp(s)
Natural logarithm ln s log(s) ‫ﻣﺛل ﻣﺗﻠﺑﮫ‬
Base 10 logarithm log10 s log10(s)
Sine sin s sin(s)
Cosine cos s cos(s)
Tangent tan s tan(s)
Arc sine asin s asin(s)
Arc cosine acos s acos(s)
Arc tangent atan s atan(s)
Hyperbolic sine sinh s sinh(s)
Hyperbolic cosine cosh s cosh(s)
Hyperbolic tangent tanh s tanh(s)
Hyperbolic arc sine asinh s asinh(s)
Hyperbolic arc cosine acosh s acosh(s)
Hyperbolic arc tangent atanh s atanh(s)
Error function erf s erf(s)
Complement error function erfc s erfc(s)
Logarithm gamma function ln Γs lgamma(s)
Type 1 Bessel function of order 0 J0 s j0(s)
Type 1 Bessel function of order 1 J1 s j1(s)
Type 2 Bessel function of order 0 Y0 s y0(s)
Type 2 Bessel function of order 1 Y1 s y1(s)
a, b are tensors of arbitrary rank unless otherwise stated
s is a scalar, N is the number of tensor components
Table 1.2: Algebraic tensor operations in OpenFOAM

OpenFOAM-3.0.1
 P-24 Tensor mathematics

1.5 Dimensional units

In continuum mechanics, properties are represented in some chosen units, e.g. mass in
kilograms (kg), volume in cubic metres (m3 ), pressure in Pascals (kg m s−2 ). Algebraic
operations must be performed on these properties using consistent units of measurement; in
particular, addition, subtraction and equality are only physically meaningful for properties of
the same dimensional units. As a safeguard against implementing a meaningless operation,
OpenFOAM encourages the user to attach dimensional units to any tensor and will then
perform dimension checking of any tensor operation.
Units are defined using the dimensionSet class, e.g.

‫ھﻣون ﻣﻌﻧﯾﮫ ﭘﺎﺳﮑﺎﻟﮫ‬

dimensionSet pressureDims(1, -1, -2, 0, 0, 0, 0);

‫ﻧﺣوه ی ﺗﻌﯾﯾن اﺑﻌﺎد ﭘﺎراﻣﺗرھﺎ‬

(‫)ﺗﺎﻧﺳورھﺎ‬ No. Property Unit Symbol
1 Mass kilogram k
‫ﻧﺑﺎﯾد ﻣﺛﺑت‬ 2 Length metre m
‫ﺑﺎﺷد؟‬
3 Time second s
4 Temperature Kelvin K
5 Quantity moles mol
6 Current ampere A
7 Luminous intensity candela cd

Table 1.3: S.I. base units of measurement

where each of the values corresponds to the power of each of the S.I. base units of mea-
surement listed in Table 1.3. The line of code declares pressureDims to be the dimensionSet
for pressure kg m s−2 since the first entry in the pressureDims array, 1, corresponds to k1 ,
the second entry, -1, corresponds to m−1 etc.. A tensor with units is defined using the
dimensioned<Type> template class, the <Type> being scalar, vector, tensor, etc.. The dimen-
sioned<Type> stores a variable name of class word,the value <Type> and a dimensionSet

dimensionedTensor sigma
(
"sigma",
dimensionSet(1, -1, -2, 0, 0, 0, 0),
tensor(1e6,0,0,0,1e6,0,0,0,1e6),
);

creates a tensor with correct dimensions of pressure, or stress

 6 
10 0 0
σ =  0 106 0  (1.45)
0 0 106

OpenFOAM-3.0.1
 Chapter 2

Discretisation procedures

So far we have dealt with algebra of tensors at a point. The PDEs we wish to solve involve
derivatives of tensors with respect to time and space. We therefore need to extend our
description to a tensor field, i.e. a tensor that varies across time and spatial domains. In
this Chapter we will first present a mathematical description of all the differential operators
we may encounter. We will then show how a tensor field is constructed in OpenFOAM and
how the derivatives of these fields are discretised into a set of algebraic equations.

2.1 Differential operators

Before defining the spatial derivatives we first introduce the nabla vector operator ∇, rep-
resented in index notation as ∂i :
µ ¶
∂ ∂ ∂ ∂
∇ ≡ ∂i ≡ ≡ , , (2.1)
∂xi ∂x1 ∂x2 ∂x3

The nabla operator is a useful notation that obeys the following rules:

• it operates on the tensors to its right and the conventional rules of a derivative of a
product, e.g. ∂i ab = (∂i a) b + a (∂i b);

• otherwise the nabla operator behaves like any other vector in an algebraic operation.

2.1.1 Gradient
If a scalar field s is defined and continuously differentiable then the gradient of s, ∇s is a
vector field
µ ¶
∂s ∂s ∂s ‫ﮔرادﯾﺎن اﺳﮑﺎﻟر ﺑود ﺷد ﺑردار‬
∇s = ∂i s = , , (2.2)
∂x1 ∂x2 ∂x3

‫ﮔرادﯾﺎن ﭘﺷت ھر‬

The gradient can operate on any tensor field to produce a tensor field that is one rank
‫ﺗﺎﻧﺳوری ﻗرار‬ higher. For example, the gradient of a vector field a is a second rank tensor field
‫ﺑﮕﯾره ﯾﮫ رﻧﮏ‬  
‫ﻣﯾﺑرﺗش ﺑﺎﻻ‬ ∂a1 /∂x1 ∂a2 /∂x1 ∂a3 /∂x1
∇a = ∂i aj =  ∂a1 /∂x2 ∂a2 /∂x2 ∂a3 /∂x2  ‫ﮔرادﯾﺎن ﺑردار ﺑود ﺷد ﺗﺎﻧﺳور‬ (2.3)
∂a1 /∂x3 ∂a2 /∂x3 ∂a3 /∂x3
 P-26 Discretisation procedures
‫ﯾﺟوراﯾﯽ ﺑرﻋﮑﺳﮫ ﮔرادﯾﺎﻧﮫ‬
2.1.2 Divergence
If a vector field a is defined and continuously differentiable then the divergence of a is a
scalar field
∂a1 ∂a2 ∂a3 ‫ﮔرادﯾﺎن ﯾﮏ ﺑردار ﻣﯾﺷﮫ اﺳﮑﺎﻟر‬
∇ • a = ∂ i ai = + + (2.4)
∂x1 ∂x2 ∂x3

‫ﮔرادﯾﺎن ﭘﺷت ھر‬ The divergence can operate on any tensor field of rank 1 and above to produce a tensor
‫ﺗﺎﻧﺳوری ﻗرار‬ that is one rank lower. For example the divergence of a second rank tensor field T is a
‫ﺑﮕﯾره ﯾﮫ رﻧﮏ‬ vector field (expanding the vector as a column array for convenience)
‫ﻣﯾﺎرﺗش ﭘﺎﯾﯾن‬
 
∂T11 /∂x1 + ∂T21 /∂x2 + ∂T31 /∂x3 ‫ﮔرادﯾﺎن ﺗﺎﻧﺳور ﻣﯾﺷﮫ ﺑردار‬
∇ • T = ∂j Tji =  ∂T12 /∂x1 + ∂T22 /∂x2 + ∂T32 /∂x3  (2.5)
∂T13 /∂x1 + ∂T23 /∂x2 + ∂T33 /∂x3

2.1.3 Curl
If a vector field a is defined and continuously differentiable then the curl of a, ∇ × a is a
vector field
µ ¶
∂a3 ∂a2 ∂a1 ∂a3 ∂a2 ∂a1
∇ × a = eijk ∂j ak = − , − , − (2.6)
∂x2 ∂x3 ∂x3 ∂x1 ∂x1 ∂x2

The curl is related to the gradient by

∇ × a = 2 (∗ skew ∇a) (2.7)

2.1.4 Laplacian
The Laplacian is an operation that can be defined mathematically by a combination of
the divergence and gradient operators by ∇2 ≡ ∇ • ∇. However, the Laplacian should be
considered as a single operation that transforms a tensor field into another tensor field of
the same rank, rather than a combination of two operations, one which raises the rank by
1 and one which reduces the rank by 1.
‫ﺗوی ﻻﭘﻼﺳﯾن ﺗﻐﯾﯾر‬
‫رﻧﮏ ﻧدارﯾم‬ In fact, the Laplacian is best defined as a scalar operator , just as we defined nabla as a
vector operator, by

∂2 ∂2 ∂2
∇2 ≡ ∂ 2 ≡ + + (2.8)
∂x21 ∂x22 ∂x23

For example, the Laplacian of a scalar field s is the scalar field

∂ 2s ∂ 2s ∂ 2s
∇2 s = ∂ 2 s = + + (2.9)
∂x21 ∂x22 ∂x23

2.1.5 Temporal derivative

There is more than one definition of temporal, or time, derivative of a tensor. To describe
the temporal derivatives we must first recall that the tensor relates to a property of a volume
of material that may be moving. If we track an infinitesimally small volume of material, or

OpenFOAM-3.0.1
2.2 Overview of discretisation P-27

particle, as it moves and observe the change in the tensorial property φ in time, we have
the total, or material time derivative denoted by

Dφ ∆φ
= lim (2.10)
Dt ∆t→0 ∆t

However in continuum mechanics, particularly fluid mechanics, we often observe the change
of a φ in time at a fixed point in space as different particles move across that point. This
change at a point in space is termed the spatial time derivative which is denoted by ∂/∂t
and is related to the material derivative by:

Dφ ∂φ
= + U • ∇φ (2.11)
Dt ∂t

where U is the velocity field of property φ. The second term on the right is known as the
convective rate of change of φ.

2.2 Overview of discretisation

The term discretisation means approximation of a problem into discrete quantities. The FV
method and others, such as the finite element and finite difference methods, all discretise
the problem as follows:

Spatial discretisation Defining the solution domain by a set of points that fill and bound
a region of space when connected;

Temporal discretisation (For transient problems) dividing the time domain into into a
finite number of time intervals, or steps;

Equation discretisation Generating a system of algebraic equations in terms of discrete

quantities defined at specific locations in the domain, from the PDEs that characterise
the problem.

2.2.1 OpenFOAM lists and fields

OpenFOAM frequently needs to store sets of data and perform functions, such as math-
ematical operations, on the data. OpenFOAM therefore provides an array template class
List<Type>, making it possible to create a list of any object of class Type that inherits the
functions of the Type. For example a List of vector is List<vector>.
Lists of the tensor classes are defined as standard in OpenFOAM by the template class
Field<Type>. For better code legibility, all instances of Field<Type>, e.g.Field<vector>, are
renamed using typedef declarations as scalarField, vectorField, tensorField, symmTensorField,
tensorThirdField and symmTensorThirdField. Algebraic operations can be performed between
Fields subject to obvious restrictions such as the fields having the same number of elements.
OpenFOAM also supports operations between a field and single tensor, e.g. all values of a
Field U can be multiplied by the scalar 2 with the operation U = 2.0 * U.

OpenFOAM-3.0.1
P-28 Discretisation procedures

2.3 Discretisation of the solution domain

Discretisation of the solution domain is shown in Figure 2.1. The space domain is discretised
into computational mesh on which the PDEs are subsequently discretised. Discretisation
of time, if required, is simple: it is broken into a set of time steps ∆t that may change
during a numerical simulation, perhaps depending on some condition calculated during the
simulation.

y
Space domain
x

∆t t

Time domain
Figure 2.1: Discretisation of the solution domain

P Sf

d N

Figure 2.2: Parameters in finite volume discretisation

On a more detailed level, discretisation of space requires the subdivision of the domain
into a number of cells, or control volumes. The cells are contiguous, i.e. they do not overlap
one another and completely fill the domain. A typical cell is shown in Figure 2.2. Dependent
variables and other properties are principally stored at the cell centroid P although they

OpenFOAM-3.0.1
2.3 Discretisation of the solution domain P-29

may be stored on faces or vertices. The cell is bounded by a set of flat faces, given the
generic label f . In OpenFOAM there is no limitation on the number of faces bounding
each cell, nor any restriction on the alignment of each face. This kind of mesh is often
referred to as “arbitrarily unstructured” to differentiate it from meshes in which the cell
faces have a prescribed alignment, typically with the coordinate axes. Codes with arbitrarily
unstructured meshes offer greater freedom in mesh generation and manipulation in particular
when the geometry of the domain is complex or changes over time.
Whilst most properties are defined at the cell centroids, some are defined at cell faces.
There are two types of cell face.

Internal faces Those faces that connect two cells (and it can never be more than two).
For each internal face, OpenFOAM designates one adjoining cell to be the face owner
and the other to be the neighbour ;

Boundary faces Those belonging to one cell since they coincide with the boundary of the
domain. These faces simply have an owner cell.

2.3.1 Defining a mesh in OpenFOAM

There are different levels of mesh description in OpenFOAM, beginning with the most basic
mesh class, named polyMesh since it is based on polyhedra. A polyMesh is constructed
using the minimum information required to define the mesh geometry described below and
presented in Figure 2.3:

Points A list of cell vertex point coordinate vectors, i.e. a vectorField, that is renamed
pointField using a typedef declaration;

Faces A list of cell faces List<face>, or faceList, where the face class is defined by a list of
vertex numbers, corresponding to the pointField;

Cells a list of cells List<cell>, or cellList, where the cell class is defined by a list of face
numbers, corresponding to the faceList described previously.

Boundary a polyBoundaryMesh decomposed into a list of patches, polyPatchList represent-

ing different regions of the boundary. The boundary is subdivided in this manner
to allow different boundary conditions to be specified on different patches during a
solution. All the faces of any polyPatch are stored as a single block of the faceList, so
that its faces can be easily accessed using the slice class which stores references to the
first and last face of the block. Each polyPatch is then constructed from

• a slice;
• a word to assign it a name.

FV discretisation uses specific data that is derived from the mesh geometry stored in
polyMesh. OpenFOAM therefore extends the polyMesh class to fvMesh which stores the
additional data needed for FV discretisation. fvMesh is constructed from polyMesh and
stores the data in Table 2.1 which can be updated during runtime in cases where the mesh
moves, is refined etc..

OpenFOAM-3.0.1
P-30 Discretisation procedures

Patch 1
Patch 2

Patch 3

Points Faces Cells

pointField faceList cellList
... ... ...
... ...
Internal
...
...
Boundary
... Boundary
...
polyPatchList
Patch 1
slice
Patch 2
Patch 3

Figure 2.3: Schematic of the basic mesh description used in OpenFOAM

2.3.2 Defining a geometricField in OpenFOAM

So far we can define a field, i.e. a list of tensors, and a mesh. These can be combined to
define a tensor field relating to discrete points in our domain, specified in OpenFOAM by
the template class geometricField<Type>. The Field values are separated into those defined
within the internal region of the domain, e.g. at the cell centres, and those defined on
the domain boundary, e.g. on the boundary faces. The geometricField<Type> stores the
following information:

Internal field This is simply a Field<Type>, described in Section 2.2.1;

BoundaryField This is a GeometricBoundaryField, in which a Field is defined for the faces

of each patch and a Field is defined for the patches of the boundary. This is then a
field of fields, stored within an object of the FieldField<Type> class. A reference to the
fvBoundaryMesh is also stored [**].

Mesh A reference to an fvMesh, with some additional detail as to the whether the field is
defined at cell centres, faces, etc..

Dimensions A dimensionSet, described in Section 4.2.6.

Old values Discretisation of time derivatives requires field data from previous time steps.

OpenFOAM-3.0.1
2.4 Equation discretisation P-31

Class Description Symbol Access function

volScalarField Cell volumes V V()
surfaceVectorField Face area vectors Sf Sf()
surfaceScalarField Face area magnitudes |Sf | magSf()
volVectorField Cell centres C C()
surfaceVectorField Face centres Cf Cf()
surfaceScalarField Face motion fluxes ** φg phi()

Table 2.1: fvMesh stored data.

The geometricField<Type> will store references to stored fields from the previous, or
old, time step and its previous, or old-old, time step where necessary.

Previous iteration values The iterative solution procedures can use under-relaxation
which requires access to data from the previous iteration. Again, if required, geo-
metricField<Type> stores a reference to the data from the previous iteration.

As discussed in Section 2.3, we principally define a property at the cell centres but quite
often it is stored at the cell faces and on occasion it is defined on cell vertices. The geomet-
ricField<Type> is renamed using typedef declarations to indicate where the field variable is
defined as follows:

volField<Type> A field defined at cell centres;

surfaceField<Type> A field defined on cell faces;

pointField<Type> A field defined on cell vertices.

These typedef field classes of geometricField<Type>are illustrated in Figure 2.4. A

geometricField<Type> inherits all the tensor algebra of Field<Type> and has all operations
subjected to dimension checking using the dimensionSet. It can also be subjected to the
FV discretisation procedures described in the following Section. The class structure used to
build geometricField<Type> is shown in Figure 2.51 .

2.4 Equation discretisation

Equation discretisation converts the PDEs into a set of algebraic equations that are com-
monly expressed in matrix form as:

[A] [x] = [b] (2.12)

where [A] is a square matrix, [x] is the column vector of dependent variable and [b] is the
source vector. The description of [x] and [b] as ‘vectors’ comes from matrix terminology
rather than being a precise description of what they truly are: a list of values defined at
locations in the geometry, i.e. a geometricField<Type>, or more specifically a volField<Type>
when using FV discretisation.
1
The diagram is not an exact description of the class hierarchy, rather a representation of the general
structure leading from some primitive classes to geometric<Type>Field.

OpenFOAM-3.0.1
P-32 Discretisation procedures

Patch 1

Internal field
Boundary field
Patch 1 Patch 2
Patch 2
(a) A volField<Type>
Patch 1

Internal field
Boundary field
Patch 1 Patch 2
Patch 2
(b) A surfaceField<Type>
Patch 1

Internal field
Boundary field
Patch 1 Patch 2
Patch 2
(c) A pointField<Type>

Figure 2.4: Types of geometricField<Type> defined on a mesh with 2 boundary patches (in
2 dimensions for simplicity)

OpenFOAM-3.0.1
2.4 Equation discretisation P-33

geometricField<Type>

geometricBoundaryField<Type>

fvMesh fvBoundaryMesh fvPatchList

fvPatchField polyMesh polyBoundaryMesh fvPatch

pointField faceList cellList polyPatchList

Field<Type> face cell polyPatch

dimensioned<Type> labelList slice

dimensionSet <Type> List label word

scalar
vector
tensor
symmTensor
tensorThird
symmTensorThird

Figure 2.5: Basic class structure leading to geometricField<Type>

OpenFOAM-3.0.1
P-34 Discretisation procedures

[A] is a list of coefficients of a set of algebraic equations, and cannot be described as a

geometricField<Type>. It is therefore given a class of its own: fvMatrix. fvMatrix<Type> is
created through discretisation of a geometric<Type>Field and therefore inherits the <Type>.
It supports many of the standard algebraic matrix operations of addition +, subtraction -
and multiplication *.
Each term in a PDE is represented individually in OpenFOAM code using the classes
of static functions finiteVolumeMethod and finiteVolumeCalculus, abbreviated by a typedef
to fvm and fvc respectively. fvm and fvc contain static functions, representing differential
operators, e.g. ∇2 , ∇ • and ∂/∂t, that discretise geometricField<Type>s. The purpose of
defining these functions within two classes, fvm and fvc, rather than one, is to distinguish:
• functions of fvm that calculate implicit derivatives of and return an fvMatrix<Type>
• some functions of fvc that calculate explicit derivatives and other explicit calculations,
returning a geometricField<Type>.
Figure 2.6 shows a geometricField<Type> defined on a mesh with 2 boundary patches and
illustrates the explicit operations merely transform one field to another and drawn in 2D
for simplicity.

geometricField<Type>
volField<Type>
surfaceField<Type>
pointField<Type>

finiteVolumeCalculus (fvc)
finiteVolumeMethod (fvm)
Other explicit operations
(Implicit)
(Explict)

geometricField<Type>
fvMatrix<Type> volField<Type>
surfaceField<Type>
pointField<Type>

Figure 2.6: A geometricField<Type> and its operators

Table 2.2 lists the main functions that are available in fvm and fvc to discretise terms
that may be found in a PDE. FV discretisation of each term is formulated by first integrating
the term over a cell volume V . Most spatial derivative terms are then converted to integrals
over the cell surface S bounding the volume using Gauss’s theorem
Z Z
∇ ⋆ φ dV = dS ⋆ φ (2.13)
V S

where S is the surface area vector, φ can represent any tensor field and the star notation
⋆ is used to represent any tensor product, i.e. inner, outer and cross and the respective

OpenFOAM-3.0.1
2.4 Equation discretisation P-35

Term description Implicit / Text fvm::/fvc:: functions

Explicit expression
Laplacian Imp/Exp ∇2 φ laplacian(phi)
∇ • Γ∇φ laplacian(Gamma, phi)
∂φ
Time derivative Imp/Exp ddt(phi)
∂t
∂ρφ
ddt(rho,phi)
∂t
µ ¶
∂ ∂φ
Second time derivative Imp/Exp ρ d2dt2(rho, phi)
∂t ∂t
Convection Imp/Exp ∇ • (ψ) div(psi,scheme)*
∇ • (ψφ) div(psi, phi, word)*
div(psi, phi)
Divergence Exp ∇•χ div(chi)
Gradient Exp ∇χ grad(chi)
∇φ gGrad(phi)
lsGrad(phi)
snGrad(phi)
snGradCorrection(phi)
2
Grad-grad squared Exp |∇∇φ| sqrGradGrad(phi)
Curl Exp ∇×φ curl(phi)
Source Imp ρφ Sp(rho,phi)
Imp/Exp† SuSp(rho,phi)
†fvm::SuSp source is discretised implicit or explicit depending on the sign of rho.
†An explicit source can be introduced simply as a vol<Type>Field, e.g.rho*phi.
Function arguments can be of the following classes:
phi: vol<Type>Field
Gamma: scalar volScalarField, surfaceScalarField, volTensorField, surfaceTensorField.
rho: scalar, volScalarField
psi: surfaceScalarField.
chi: surface<Type>Field, vol<Type>Field.
Table 2.2: Discretisation of PDE terms in OpenFOAM

OpenFOAM-3.0.1
P-36 Discretisation procedures

derivatives: divergence ∇ • φ, gradient ∇φ and ∇ × φ. Volume and surface integrals are

then linearised using appropriate schemes which are described for each term in the following
Sections. Some terms are always discretised using one scheme, a selection of schemes is
offered in OpenFOAM for the discretisation of other terms. The choice of scheme is either
made by a direct specification within the code or it can be read from an input file at job
run-time and stored within an fvSchemes class object.

2.4.1 The Laplacian term

The Laplacian term is integrated over a control volume and linearised as follows:
Z Z X
∇ (Γ∇φ) dV =
• dS • (Γ∇φ) = Γf Sf • (∇φ)f (2.14)
V S f

The face gradient discretisation is implicit when the length vector d between the centre of
the cell of interest P and the centre of a neighbouring cell N is orthogonal to the face plane,
i.e. parallel to Sf :
φN − φ P
Sf • (∇φ)f = |Sf | (2.15)
|d|
In the case of non-orthogonal meshes, an additional explicit term is introduced which is
evaluated by interpolating cell centre gradients, themselves calculated by central differencing
cell centre values.

2.4.2 The convection term

The convection term is integrated over a control volume and linearised as follows:
Z Z X X
∇ • (ρUφ) dV = dS • (ρUφ) = Sf • (ρU)f φf = F φf (2.16)
V S f f

The face field φf can be evaluated using a variety of schemes:

Central differencing (CD) is second-order accurate but unbounded
φf = fx φP + (1 − fx )φN (2.17)
where fx ≡ f N /P N where f N is the distance between f and cell centre N and P N
is the distance between cell centres P and N .
Upwind differencing (UD) determines φf from the direction of flow and is bounded at
the expense of accuracy
(
φP for F ≥ 0
φf = (2.18)
φN for F < 0

Blended differencing (BD) schemes combine UD and CD in an attempt to preserve

boundedness with reasonable accuracy,
φf = (1 − γ) (φf )U D + γ (φf )CD (2.19)
OpenFOAM has several implementations of the Gamma differencing scheme to select
the blending coefficient γ but it offers other well-known schemes such as van Leer,
SUPERBEE, MINMOD etc..

OpenFOAM-3.0.1
2.4 Equation discretisation P-37

2.4.3 First time derivative

The first time derivative ∂/∂t is integrated over a control volume as follows:
Z
∂
ρφ dV (2.20)
∂t V

The term is discretised by simple differencing in time using:

new values φn ≡ φ(t + ∆t) at the time step we are solving for;

old values φo ≡ φ(t) that were stored from the previous time step;

old-old values φoo ≡ φ(t − ∆t) stored from a time step previous to the last.

One of two discretisation schemes can be declared using the timeScheme keyword in the
appropriate input file, described in detail in section 4.4 of the User Guide.

Euler implicit scheme, timeScheme EulerImplicit, that is first order accurate in time:
Z
∂ (ρP φP V )n − (ρP φP V )o
ρφ dV = (2.21)
∂t V ∆t

Backward differencing scheme, timeScheme BackwardDifferencing, that is second or-

der accurate in time by storing the old-old values and therefore with a larger overhead
in data storage than EulerImplicit:
Z
∂ 3 (ρP φP V )n − 4 (ρP φP V )o + (ρP φP V )oo
ρφ dV = (2.22)
∂t V 2∆t

2.4.4 Second time derivative

The second time derivative is integrated over a control volume and linearised as follows:
Z
∂ ∂φ (ρP φP V )n − 2 (ρP φP V )o + (ρP φP V )oo
ρ dV = (2.23)
∂t V ∂t ∆t2
It is first order accurate in time.

2.4.5 Divergence
The divergence term described in this Section is strictly an explicit term that is distinguished
from the convection term of Section 2.4.2, i.e. in that it is not the divergence of the product
of a velocity and dependent variable. The term is integrated over a control volume and
linearised as follows:
Z Z X
∇ φ dV =
• dS • φ = Sf • φf (2.24)
V S f

The fvc::div function can take as its argument either a surface<Type>Field, in which case
φf is specified directly, or a vol<Type>Field which is interpolated to the face by central
differencing as described in Section 2.4.10:

OpenFOAM-3.0.1
P-38 Discretisation procedures

2.4.6 Gradient
The gradient term is an explicit term that can be evaluated in a variety of ways. The scheme
can be evaluated either by selecting the particular grad function relevant to the discretisation
scheme, e.g.fvc::gGrad, fvc::lsGrad etc., or by using the fvc::grad function combined
with the appropriate gradScheme keyword in an input file
Gauss integration is invoked using the fvc::grad function with gradScheme Gauss or
directly using the fvc::gGrad function. The discretisation is performed using the
standard method of applying Gauss’s theorem to the volume integral:
Z Z X
∇φ dV = dS φ = Sf φf (2.25)
V S f

As with the fvc::div function, the Gaussian integration fvc::grad function can take
either a surfaceField<Type> or a volField<Type> as an argument.

Least squares method is based on the following idea:

1. a value at point P can be extrapolated to neighbouring point N using the gradient

at P ;
2. the extrapolated value at N can be compared to the actual value at N , the
difference being the error;
3. if we now minimise the sum of the square of weighted errors at all neighbours of
P with the respect to the gradient, then the gradient should be a good approxi-
mation.

Least squares is invoked using the fvc::grad function with timeScheme leastSquares
or directly using the fvc::lsGrad function. The discretisation is performed as by first
calculating the tensor G at every point P by summing over neighbours N :
X
2
G= wN dd (2.26)
N

where d is the vector from P to N and the weighting function wN = 1/|d|. The
gradient is then evaluated as:
X
2
(∇φ)P = wN G−1 • d (φN − φP ) (2.27)
N

Surface normal gradient The gradient normal to a surface nf • (∇φ)f can be evaluated
at cell faces using the scheme
φN − φ P
(∇φ)f = (2.28)
|d|
This gradient is called by the function fvc::snGrad and returns a surfaceField<Type>.
The scheme is directly analogous to that evaluated for the Laplacian discretisation
scheme in Section 2.4.1, and in the same manner, a correction can be introduced to
improve the accuracy of this face gradient in the case of non-orthogonal meshes. This
correction is called using the function fvc::snGradCorrection.

OpenFOAM-3.0.1
2.4 Equation discretisation P-39

2.4.7 Grad-grad squared

The grad-grad squared term is evaluated by: taking the gradient of the field; taking the
gradient of the resulting gradient field; and then calculating the magnitude squared of the
result. The mathematical expression for grad-grad squared of φ is |∇ (∇φ)|2 .

2.4.8 Curl
The curl is evaluated from the gradient term described in Section 2.4.6. First, the gradient is
discretised and then the curl is evaluated using the relationship from Equation 2.7, repeated
here for convenience

∇ × φ = 2 ∗(skew ∇φ)

2.4.9 Source terms

Source terms can be specified in 3 ways

Explicit Every explicit term is a volField<Type>. Hence, an explicit source term can be
incorporated into an equation simply as a field of values. For example if we wished
to solve Poisson’s equation ∇2 φ = f , we would define phi and f as volScalarField and
then do

solve(fvm::laplacian(phi) == f)

Implicit An implicit source term is integrated over a control volume and linearised by
Z
ρφ dV = ρP VP φP (2.29)
V

Implicit/Explicit The implicit source term changes the coefficient of the diagonal of the
matrix. Depending on the sign of the coefficient and matrix terms, this will either
increase or decrease diagonal dominance of the matrix. Decreasing the diagonal dom-
inance could cause instability during iterative solution of the matrix equation. There-
fore OpenFOAM provides a mixed source discretisation procedure that is implicit
when the coefficients that are greater than zero, and explicit for the coefficients less
than zero. In mathematical terms the matrix coefficient for node P is VP max(ρP , 0)
and the source term is VP φP min(ρP , 0).

2.4.10 Other explicit discretisation schemes

There are some other discretisation procedures that convert volField<Type>s into surface<Type>Fields
and visa versa.

Surface integral fvc::surfaceIntegrate performs a summation of surface P <Type>Field

face values bounding each cell and dividing by the cell volume, i.e. ( f φf )/VP . It
returns a volField<Type>.

Surface sum fvc::surfaceSum P performs a summation of surface<Type>Field face values

bounding each cell, i.e. f φf returning a volField<Type>.

OpenFOAM-3.0.1
P-40 Discretisation procedures

Average fvc::average
P produces
P an area weighted average of surface<Type>Field face val-
ues, i.e. ( f Sf φf )/ f Sf , and returns a volField<Type>.
Reconstruct
Face interpolate The geometric<Type>Field function faceInterpolate() interpolates volField<Type
cell centre values to cell faces using central differencing, returning a surface<Type>Field.

2.5 Temporal discretisation

Although we have described the discretisation of temporal derivatives in Sections 2.4.3 and
2.4.4, we need to consider how to treat the spatial derivatives in a transient problem. If we
denote all the spatial terms as Aφ where A is any spatial operator, e.g. Laplacian, then we
can express a transient PDE in integral form as
Z t+∆t · Z Z ¸
∂
ρφ dV + Aφ dV dt = 0 (2.30)
t ∂t V V

Using the Euler implicit method of Equation 2.21, the first term can be expressed as
Z t+∆t · Z ¸ Z t+∆t
∂ (ρP φP V )n − (ρP φP V )o
ρφ dV dt = dt
t ∂t V t ∆t (2.31)
(ρP φP V )n − (ρP φP V )o
= ∆t
∆t
The second term can be expressed as
Z t+∆t ·Z ¸ Z t+∆t
Aφ dV dt = A∗ φ dt (2.32)
t V t

where A∗ represents the spatial discretisation of A. The time integral can be discretised in
three ways:
Euler implicit uses implicit discretisation of the spatial terms, thereby taking current
values φn .
Z t+∆t
A∗ φ dt = A∗ φn ∆t (2.33)
t

It is first order accurate in time, guarantees boundedness and is unconditionally stable.

Explicit uses explicit discretisation of the spatial terms, thereby taking old values φo .
Z t+∆t
A∗ φ dt = A∗ φo ∆t (2.34)
t

It is first order accurate in time and is unstable if the Courant number Co is greater
than 1. The Courant number is defined as
Uf • d
Co = (2.35)
|d|2 ∆t
where Uf is a characteristic velocity, e.g. velocity of a wave front, velocity of flow.

OpenFOAM-3.0.1
2.6 Boundary Conditions P-41

Crank Nicolson uses the trapezoid rule to discretise the spatial terms, thereby taking a
mean of current values φn and old values φo .
Z t+∆t µ n ¶
∗ ∗ φ + φo
A φ dt = A ∆t (2.36)
t 2

It is second order accurate in time, is unconditionally stable but does not guarantee
boundedness.

2.5.1 Treatment of temporal discretisation in OpenFOAM

At present the treatment of the temporal discretisation is controlled by the implementation
of the spatial derivatives in the PDE we wish to solve. For example, let us say we wish to
solve a transient diffusion equation

∂φ
= κ∇2 φ (2.37)
∂t
An Euler implicit implementation of this would read

solve(fvm::ddt(phi) == kappa*fvm::laplacian(phi))

where we use the fvm class to discretise the Laplacian term implicitly. An explicit imple-
mentation would read

solve(fvm::ddt(phi) == kappa*fvc::laplacian(phi))

where we now use the fvc class to discretise the Laplacian term explicitly. The Crank
Nicolson scheme can be implemented by the mean of implicit and explicit terms:

solve
(
fvm::ddt(phi)
==
kappa*0.5*(fvm::laplacian(phi) + fvc::laplacian(phi))
)

2.6 Boundary Conditions

Boundary conditions are required to complete the problem we wish to solve. We therefore
need to specify boundary conditions on all our boundary faces. Boundary conditions can
be divided into 2 types:

Dirichlet prescribes the value of the dependent variable on the boundary and is therefore
termed ‘fixed value’ in this guide;

Neumann prescribes the gradient of the variable normal to the boundary and is therefore
termed ‘fixed gradient’ in this guide.

OpenFOAM-3.0.1
P-42 Discretisation procedures
P
When we perform discretisation of terms that include the sum over faces f, we need
to consider what happens when one of the faces is a boundary face.
Fixed value We specify a fixed value at the boundary φb
• We can simply substitute φb in cases where the discretisation requires the value
on a boundary face φf , e.g. in the convection term in Equation 2.16.
• In terms where the face gradient (∇φ)f is required, e.g. Laplacian, it is calculated
using the boundary face value and cell centre value,
φb − φ P
Sf • (∇φ)f = |Sf | (2.38)
|d|
Fixed gradient The fixed gradient boundary condition gb is a specification on inner prod-
uct of the gradient and unit normal to the boundary, or
µ ¶
S
gb = • ∇φ (2.39)
|S| f

• When discretisation requires the value on a boundary face φf we must interpolate

the cell centre value to the boundary by
φf = φP + d • (∇φ)f
(2.40)
= φP + |d| gb

• φb can be directly substituted in cases where the discretisation requires the face
gradient to be evaluated,
Sf • (∇φ)f = |Sf | gb (2.41)

2.6.1 Physical boundary conditions

The specification of boundary conditions is usually an engineer’s interpretation of the true
behaviour. Real boundary conditions are generally defined by some physical attributes
rather than the numerical description as described of the previous Section. In incompressible
fluid flow there are the following physical boundaries
Inlet The velocity field at the inlet is supplied and, for consistency, the boundary condition
on pressure is zero gradient.
Outlet The pressure field at the outlet is supplied and a zero gradient boundary condition
on velocity is specified.
No-slip impermeable wall The velocity of the fluid is equal to that of the wall itself, i.e.
a fixed value condition can be specified. The pressure is specified zero gradient since
the flux through the wall is zero.
In a problem whose solution domain and boundary conditions are symmetric about a
plane, we only need to model half the domain to one side of the symmetry plane. The
boundary condition on the plane must be specified according to
Symmetry plane The symmetry plane condition specifies the component of the gradient
normal to the plane should be zero.

OpenFOAM-3.0.1
Chapter 3

Examples of the use of OpenFOAM

In this section we shall describe several test cases supplied with the OpenFOAM distribu-
tion. The intention is to provide example cases, including those in the tutorials in chapter 2
of the User Guide, for every standard solver. The examples are designed to introduce cer-
tain tools and features of OpenFOAM, e.g. within pre-/post-processing, numerical schemes,
algorithms. They also provide a means for validation of solvers although that is not their
principal function.
Each example contains a description of the problem: the geometry, initial and boundary
conditions, a brief description of the equations being solved, models used, and physical
properties required. The solution domain is selected which may be a portion of the original
geometry, e.g. if we introduce symmetry planes. The method of meshing, usually blockMesh,
is specified; of course the user can simply view the mesh since every example is distributed
with the polyMesh directory containing the data files that describe the mesh.
The examples coexist with the tutorials in the tutorials subdirectory of the OpenFOAM
installation. They are organised into a set of subdirectories by solver, e.g. all the icoFoam
cases are stored within a subdirectory icoFoam. Before running a particular example, the
user is urged to copy it into their user account. We recommend that the user stores all
OpenFOAM cases in a directory we recommend that the tutorials are copied into a directory
$FOAM RUN. If this directory structure has not yet been created in the user’s account, it
can be created with

mkdir -p $FOAM RUN

The tutorials can then be copied into this directory with

cp -r $FOAM TUTORIALS/* $FOAM RUN

3.1 Flow around a cylinder

In this example we shall investigate potential flow around a cylinder using potentialFoam.
This example introduces the following OpenFOAM features:

• non-orthogonal meshes;

• generating an analytical solution to a problem in OpenFOAM.

P-44 Examples of the use of OpenFOAM

3.1.1 Problem specification

The problem is defined as follows:
Solution domain The domain is 2 dimensional and consists of a square domain with a
cylinder collocated with the centre of the square as shown in Figure 3.1.

Ux = 1.0 m/s p = 0 bar

symmetry
4.0 m
0 x

0.5 m

4.0 m
Figure 3.1: Geometry of flow round a cylinder

Governing equations
• Mass continuity for an incompressible fluid
∇•U=0 (3.1)
• Pressure equation for an incompressible, irrotational fluid assuming steady-state
conditions
∇2 p = 0 (3.2)
Boundary conditions
• Inlet (left) with fixed velocity U = (1, 0, 0) m/s.
• Outlet (right) with a fixed pressure p = 0 Pa.
• No-slip wall (bottom);
• Symmetry plane (top).
Initial conditions U = 0 m/s, p = 0 Pa — required in OpenFOAM input files but not
necessary for the solution since the problem is steady-state.
Solver name potentialFoam: a potential flow code, i.e. assumes the flow is incompressible,
steady, irrotational, inviscid and it ignores gravity.
Case name cylinder case located in the $FOAM TUTORIALS/potentialFoam directory.

OpenFOAM-3.0.1
3.1 Flow around a cylinder P-45

3.1.2 Note on potentialFoam

potentialFoam is a useful solver to validate OpenFOAM since the assumptions of potential
flow are such that an analytical solution exists for cases whose geometries are relatively
simple. In this example of flow around a cylinder an analytical solution exists with which
we can compare our numerical solution. potentialFoam can also be run more like a utility
to provide a (reasonably) conservative initial U field for a problem. When running certain
cases, this can useful for avoiding instabilities due to the initial field being unstable. In short,
potentialFoam creates a conservative field from a non-conservative initial field supplied by
the user.

3.1.3 Mesh generation

Mesh generation using blockMesh has been described in tutorials in the User Guide. In this
case, the mesh consists of 10 blocks as shown in Figure 3.2. Remember that all meshes
up
17 18 8 7 6

9 4
8 3

9
left right

14 15 5 0 4 3

10
7 16 2
6 5 1
y
13 12 11 x 0 1 2
down cylinder down

Figure 3.2: Blocks in cylinder geometry

are treated as 3 dimensional in OpenFOAM. If we wish to solve a 2 dimensional problem,

we must describe a 3 dimensional mesh that is only one cell thick in the third direction
that is not solved. In Figure 3.2 we show only the back plane of the geometry, along
z = −0.5, in which the vertex numbers are numbered 0-18. The other 19 vertices in the
front plane, z = +0.5, are numbered in the same order as the back plane, as shown in the
mesh description file below:
1 /*--------------------------------*- C++ -*----------------------------------*\
2 | ========= | |
3 | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox |
4 | \\ / O peration | Version: 3.0.1 |
5 | \\ / A nd | Web: www.OpenFOAM.org |
6 | \\/ M anipulation | |
7 \*---------------------------------------------------------------------------*/
8 FoamFile
9 {
10 version 2.0;
11 format ascii;
12 class dictionary;

OpenFOAM-3.0.1
P-46 Examples of the use of OpenFOAM

13 object blockMeshDict;
14 }
15 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
16
17 convertToMeters 1;
18
19 vertices #codeStream
20 {
21 codeInclude
22 #{
23 #include "pointField.H"
24 #};
25
26 code
27 #{
28 pointField points(19);
29 points[0] = point(0.5, 0, -0.5);
30 points[1] = point(1, 0, -0.5);
31 points[2] = point(2, 0, -0.5);
32 points[3] = point(2, 0.707107, -0.5);
33 points[4] = point(0.707107, 0.707107, -0.5);
34 points[5] = point(0.353553, 0.353553, -0.5);
35 points[6] = point(2, 2, -0.5);
36 points[7] = point(0.707107, 2, -0.5);
37 points[8] = point(0, 2, -0.5);
38 points[9] = point(0, 1, -0.5);
39 points[10] = point(0, 0.5, -0.5);
40 points[11] = point(-0.5, 0, -0.5);
41 points[12] = point(-1, 0, -0.5);
42 points[13] = point(-2, 0, -0.5);
43 points[14] = point(-2, 0.707107, -0.5);
44 points[15] = point(-0.707107, 0.707107, -0.5);
45 points[16] = point(-0.353553, 0.353553, -0.5);
46 points[17] = point(-2, 2, -0.5);
47 points[18] = point(-0.707107, 2, -0.5);
48
49 // Duplicate z points
50 label sz = points.size();
51 points.setSize(2*sz);
52 for (label i = 0; i < sz; i++)
53 {
54 const point& pt = points[i];
55 points[i+sz] = point(pt.x(), pt.y(), -pt.z());
56 }
57
58 os << points;
59 #};
60 };
61
62
63 blocks
64 (
65 hex (5 4 9 10 24 23 28 29) (10 10 1) simpleGrading (1 1 1)
66 hex (0 1 4 5 19 20 23 24) (10 10 1) simpleGrading (1 1 1)
67 hex (1 2 3 4 20 21 22 23) (20 10 1) simpleGrading (1 1 1)
68 hex (4 3 6 7 23 22 25 26) (20 20 1) simpleGrading (1 1 1)
69 hex (9 4 7 8 28 23 26 27) (10 20 1) simpleGrading (1 1 1)
70 hex (15 16 10 9 34 35 29 28) (10 10 1) simpleGrading (1 1 1)
71 hex (12 11 16 15 31 30 35 34) (10 10 1) simpleGrading (1 1 1)
72 hex (13 12 15 14 32 31 34 33) (20 10 1) simpleGrading (1 1 1)
73 hex (14 15 18 17 33 34 37 36) (20 20 1) simpleGrading (1 1 1)
74 hex (15 9 8 18 34 28 27 37) (10 20 1) simpleGrading (1 1 1)
75 );
76
77 edges
78 (
79 arc 0 5 (0.469846 0.17101 -0.5)
80 arc 5 10 (0.17101 0.469846 -0.5)
81 arc 1 4 (0.939693 0.34202 -0.5)
82 arc 4 9 (0.34202 0.939693 -0.5)
83 arc 19 24 (0.469846 0.17101 0.5)
84 arc 24 29 (0.17101 0.469846 0.5)
85 arc 20 23 (0.939693 0.34202 0.5)

OpenFOAM-3.0.1
3.1 Flow around a cylinder P-47

86 arc 23 28 (0.34202 0.939693 0.5)

87 arc 11 16 (-0.469846 0.17101 -0.5)
88 arc 16 10 (-0.17101 0.469846 -0.5)
89 arc 12 15 (-0.939693 0.34202 -0.5)
90 arc 15 9 (-0.34202 0.939693 -0.5)
91 arc 30 35 (-0.469846 0.17101 0.5)
92 arc 35 29 (-0.17101 0.469846 0.5)
93 arc 31 34 (-0.939693 0.34202 0.5)
94 arc 34 28 (-0.34202 0.939693 0.5)
95 );
96
97 boundary
98 (
99 down
100 {
101 type symmetryPlane;
102 faces
103 (
104 (0 1 20 19)
105 (1 2 21 20)
106 (12 11 30 31)
107 (13 12 31 32)
108 );
109 }
110 right
111 {
112 type patch;
113 faces
114 (
115 (2 3 22 21)
116 (3 6 25 22)
117 );
118 }
119 up
120 {
121 type symmetryPlane;
122 faces
123 (
124 (7 8 27 26)
125 (6 7 26 25)
126 (8 18 37 27)
127 (18 17 36 37)
128 );
129 }
130 left
131 {
132 type patch;
133 faces
134 (
135 (14 13 32 33)
136 (17 14 33 36)
137 );
138 }
139 cylinder
140 {
141 type symmetry;
142 faces
143 (
144 (10 5 24 29)
145 (5 0 19 24)
146 (16 10 29 35)
147 (11 16 35 30)
148 );
149 }
150 );
151
152 mergePatchPairs
153 (
154 );
155
156 // ************************************************************************* //

3.1.4 Boundary conditions and initial fields

Using FoamX or editing case files by hand, set the boundary conditions in accordance with
the problem description in Figure 3.1, i.e. the left boundary should be an Inlet, the right

OpenFOAM-3.0.1
P-48 Examples of the use of OpenFOAM

boundary should be an Outlet and the down and cylinder boundaries should be symme-
tryPlane. The top boundary conditions is chosen so that we can make the most genuine
comparison with our analytical solution which uses the assumption that the domain is infi-
nite in the y direction. The result is that the normal gradient of U is small along a plane
coinciding with our boundary. We therefore impose the condition that the normal com-
ponent is zero, i.e. specify the boundary as a symmetryPlane, thereby ensuring that the
comparison with the analytical is reasonable.

3.1.5 Running the case

No fluid properties need be specified in this problem since the flow is assumed to be in-
compressible and inviscid. In the system subdirectory, the controlDict specifies the control
parameters for the run. Note that since we assume steady flow, we only run for 1 time step:
1 /*--------------------------------*- C++ -*----------------------------------*\
2 | ========= | |
3 | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox |
4 | \\ / O peration | Version: 3.0.1 |
5 | \\ / A nd | Web: www.OpenFOAM.org |
6 | \\/ M anipulation | |
7 \*---------------------------------------------------------------------------*/
8 FoamFile
9 {
10 version 2.0;
11 format ascii;
12 class dictionary;
13 location "system";
14 object controlDict;
15 }
16 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
17
18 application potentialFoam;
19
20 startFrom startTime;
21
22 startTime 0;
23
24 stopAt endTime;
25
26 endTime 1;
27
28 deltaT 1;
29
30 writeControl timeStep;
31
32 writeInterval 1;
33
34 purgeWrite 0;
35
36 writeFormat ascii;
37
38 writePrecision 6;
39
40 writeCompression off;
41
42 timeFormat general;
43
44 timePrecision 6;
45
46 runTimeModifiable true;
47
48 functions
49 {
50 difference
51 {
52 // Load the library containing the 'coded' functionObject
53 functionObjectLibs ("libutilityFunctionObjects.so");
54 type coded;
55 // Name of on-the-fly generated functionObject
56 redirectType error;
57 code

OpenFOAM-3.0.1
3.1 Flow around a cylinder P-49

58 #{
59 // Lookup U
60 Info<< "Looking up field U\n" << endl;
61 const volVectorField& U = mesh().lookupObject<volVectorField>("U");
62
63 Info<< "Reading inlet velocity uInfX\n" << endl;
64
65 scalar ULeft = 0.0;
66 label leftI = mesh().boundaryMesh().findPatchID("left");
67 const fvPatchVectorField& fvp = U.boundaryField()[leftI];
68 if (fvp.size())
69 {
70 ULeft = fvp[0].x();
71 }
72 reduce(ULeft, maxOp<scalar>());
73
74 dimensionedScalar uInfX
75 (
76 "uInfx",
77 dimensionSet(0, 1, -1, 0, 0),
78 ULeft
79 );
80
81 Info << "U at inlet = " << uInfX.value() << " m/s" << endl;
82
83
84 scalar magCylinder = 0.0;
85 label cylI = mesh().boundaryMesh().findPatchID("cylinder");
86 const fvPatchVectorField& cylFvp = mesh().C().boundaryField()[cylI];
87 if (cylFvp.size())
88 {
89 magCylinder = mag(cylFvp[0]);
90 }
91 reduce(magCylinder, maxOp<scalar>());
92
93 dimensionedScalar radius
94 (
95 "radius",
96 dimensionSet(0, 1, 0, 0, 0),
97 magCylinder
98 );
99
100 Info << "Cylinder radius = " << radius.value() << " m" << endl;
101
102 volVectorField UA
103 (
104 IOobject
105 (
106 "UA",
107 mesh().time().timeName(),
108 U.mesh(),
109 IOobject::NO_READ,
110 IOobject::AUTO_WRITE
111 ),
112 U
113 );
114
115 Info<< "\nEvaluating analytical solution" << endl;
116
117 const volVectorField& centres = UA.mesh().C();
118 volScalarField magCentres(mag(centres));
119 volScalarField theta(acos((centres & vector(1,0,0))/magCentres));
120
121 volVectorField cs2theta
122 (
123 cos(2*theta)*vector(1,0,0)
124 + sin(2*theta)*vector(0,1,0)
125 );
126
127 UA = uInfX*(dimensionedVector(vector(1,0,0))
128 - pow((radius/magCentres),2)*cs2theta);
129
130 // Force writing of UA (since time has not changed)
131 UA.write();
132
133 volScalarField error("error", mag(U-UA)/mag(UA));
134
135 Info<<"Writing relative error in U to " << error.objectPath()

OpenFOAM-3.0.1
P-50 Examples of the use of OpenFOAM

136 << endl;

137
138 error.write();
139 #};
140 }
141 }
142
143
144 // ************************************************************************* //

potentialFoam executes an iterative loop around the pressure equation which it solves in
order that explicit terms relating to non-orthogonal correction in the Laplacian term may
be updated in successive iterations. The number of iterations around the pressure equation is
controlled by the nNonOrthogonalCorrectors keyword in controlDict. In the first instance
we can set nNonOrthogonalCorrectors to 0 so that no loops are performed, i.e. the pressure
equation is solved once, and there is no non-orthogonal correction. The solution is shown
in Figure 3.3(a) (at t = 1, when the steady-state simulation is complete). We expect
the solution to show smooth streamlines passing across the domain as in the analytical
solution in Figure 3.3(c), yet there is clearly some error in the regions where there is high
non-orthogonality in the mesh, e.g. at the join of blocks 0, 1 and 3. The case can be run a
second time with some non-orthogonal correction by setting nNonOrthogonalCorrectors to
3. The solution shows smooth streamlines with no significant error due to non-orthogonality
as shown in Figure 3.3(b).

3.2 Steady turbulent flow over a backward-facing step

In this example we shall investigate steady turbulent flow over a backward-facing step.
The problem description is taken from one used by Pitz and Daily in an experimental
investigation [**] against which the computed solution can be compared. This example
introduces the following OpenFOAM features for the first time:
• generation of a mesh using blockMesh using full mesh grading capability;
• steady turbulent flow.

3.2.1 Problem specification

The problem is defined as follows:
Solution domain The domain is 2 dimensional, consisting of a short inlet, a backward-
facing step and converging nozzle at outlet as shown in Figure 3.4.
Governing equations
• Mass continuity for incompressible flow
∇•U=0 (3.3)

• Steady flow momentum equation

∇ • (UU) + ∇ • R = −∇p (3.4)
where p is kinematic pressure and (in slightly over-simplistic terms) R = νef f ∇U
is the viscous stress term with an effective kinematic viscosity νef f , calculated
from selected transport and turbulence models.

OpenFOAM-3.0.1
3.2 Steady turbulent flow over a backward-facing step P-51

(a) With no non-orthogonal correction

(b) With non-orthogonal correction

(c) Analytical solution

Figure 3.3: Streamlines of potential flow

OpenFOAM-3.0.1
P-52 Examples of the use of OpenFOAM

Inlet: Ux = 10.0 m/s Outlet: p = 0 Pa

y
50.8 33.2
x

20.6 206.0 84.0

Dimensions in mm
Figure 3.4: Geometry of backward-facing step

OpenFOAM-3.0.1
3.2 Steady turbulent flow over a backward-facing step P-53

Initial conditions U = 0 m/s, p = 0 Pa — required in OpenFOAM input files but not

necessary for the solution since the problem is steady-state.

Boundary conditions

• Inlet (left) with fixed velocity U = (10, 0, 0) m/s;

• Outlet (right) with fixed pressure p = 0 Pa;
• No-slip walls on other boundaries.

Transport properties

• Kinematic viscosity of air ν = µ/ρ = 18.1 × 10−6 /1.293 = 14.0 µm2 /s

Turbulence model

• Standard k − ǫ;
• Coefficients: Cµ = 0.09; C1 = 1.44; C2 = 1.92; αk = 1; αǫ = 0.76923.

Solver name simpleFoam: an implementation for steady incompressible flow.

Case name pitzDaily, located in the $FOAM TUTORIALS/simpleFoam directory.

The problem is solved using simpleFoam, so-called as it is an implementation for steady

flow using the SIMPLE algorithm [**]. The solver has full access to all the turbulence
models in the incompressibleTurbulenceModels library and the non-Newtonian models incom-
pressibleTransportModels library of the standard OpenFOAM release.

3.2.2 Mesh generation

We expect that the flow in this problem is reasonably complex and an optimum solution will
require grading of the mesh. In general, the regions of highest shear are particularly critical,
requiring a finer mesh than in the regions of low shear. We can anticipate where high shear
will occur by considering what the solution might be in advance of any calculation. At
the inlet we have strong uniform flow in the x direction and, as it passes over the step, it
generates shear on the fluid below, generating a vortex in the bottom half of the domain.
The regions of high shear will therefore be close to the centreline of the domain and close
to the walls.
The domain is subdivided into 12 blocks as shown in Figure 3.5.
The mesh is 3 dimensional, as always in OpenFOAM, so in Figure 3.5 we are viewing
the back plane along z = −0.5. The full set of vertices and blocks are given in the mesh
description file below:
1 /*--------------------------------*- C++ -*----------------------------------*\
2 | ========= | |
3 | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox |
4 | \\ / O peration | Version: 3.0.1 |
5 | \\ / A nd | Web: www.OpenFOAM.org |
6 | \\/ M anipulation | |
7 \*---------------------------------------------------------------------------*/
8 FoamFile
9 {
10 version 2.0;
11 format ascii;
12 class dictionary;
13 object blockMeshDict;

OpenFOAM-3.0.1
P-54 Examples of the use of OpenFOAM

upperWall
9 15
3
2 7
8 14 12
21
inlet 2 6
1 13 11 20
7 19 10 outlet
1
0 6 4 12 9 18
0 5 5 17
11 8
3 16
4 10
lowerWall
Figure 3.5: Blocks in backward-facing step

14 }
15 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
16
17 convertToMeters 0.001;
18
19 vertices
20 (
21 (-20.6 0 -0.5)
22 (-20.6 3 -0.5)
23 (-20.6 12.7 -0.5)
24 (-20.6 25.4 -0.5)
25 (0 -25.4 -0.5)
26 (0 -5 -0.5)
27 (0 0 -0.5)
28 (0 3 -0.5)
29 (0 12.7 -0.5)
30 (0 25.4 -0.5)
31 (206 -25.4 -0.5)
32 (206 -8.5 -0.5)
33 (206 0 -0.5)
34 (206 6.5 -0.5)
35 (206 17 -0.5)
36 (206 25.4 -0.5)
37 (290 -16.6 -0.5)
38 (290 -6.3 -0.5)
39 (290 0 -0.5)
40 (290 4.5 -0.5)
41 (290 11 -0.5)
42 (290 16.6 -0.5)
43 (-20.6 0 0.5)
44 (-20.6 3 0.5)
45 (-20.6 12.7 0.5)
46 (-20.6 25.4 0.5)
47 (0 -25.4 0.5)
48 (0 -5 0.5)
49 (0 0 0.5)
50 (0 3 0.5)
51 (0 12.7 0.5)
52 (0 25.4 0.5)
53 (206 -25.4 0.5)
54 (206 -8.5 0.5)
55 (206 0 0.5)
56 (206 6.5 0.5)
57 (206 17 0.5)
58 (206 25.4 0.5)
59 (290 -16.6 0.5)
60 (290 -6.3 0.5)
61 (290 0 0.5)
62 (290 4.5 0.5)
63 (290 11 0.5)
64 (290 16.6 0.5)
65 );
66
67 blocks
68 (

OpenFOAM-3.0.1
3.2 Steady turbulent flow over a backward-facing step P-55

69 hex (0 6 7 1 22 28 29 23) (18 7 1) simpleGrading (0.5 1.8 1)

70 hex (1 7 8 2 23 29 30 24) (18 10 1) simpleGrading (0.5 4 1)
71 hex (2 8 9 3 24 30 31 25) (18 13 1) simpleGrading (0.5 0.25 1)
72 hex (4 10 11 5 26 32 33 27) (180 18 1) simpleGrading (4 1 1)
73 hex (5 11 12 6 27 33 34 28) (180 9 1) edgeGrading (4 4 4 4 0.5 1 1 0.5 1 1 1 1)
74 hex (6 12 13 7 28 34 35 29) (180 7 1) edgeGrading (4 4 4 4 1.8 1 1 1.8 1 1 1 1)
75 hex (7 13 14 8 29 35 36 30) (180 10 1) edgeGrading (4 4 4 4 4 1 1 4 1 1 1 1)
76 hex (8 14 15 9 30 36 37 31) (180 13 1) simpleGrading (4 0.25 1)
77 hex (10 16 17 11 32 38 39 33) (25 18 1) simpleGrading (2.5 1 1)
78 hex (11 17 18 12 33 39 40 34) (25 9 1) simpleGrading (2.5 1 1)
79 hex (12 18 19 13 34 40 41 35) (25 7 1) simpleGrading (2.5 1 1)
80 hex (13 19 20 14 35 41 42 36) (25 10 1) simpleGrading (2.5 1 1)
81 hex (14 20 21 15 36 42 43 37) (25 13 1) simpleGrading (2.5 0.25 1)
82 );
83
84 edges
85 (
86 );
87
88 boundary
89 (
90 inlet
91 {
92 type patch;
93 faces
94 (
95 (0 22 23 1)
96 (1 23 24 2)
97 (2 24 25 3)
98 );
99 }
100 outlet
101 {
102 type patch;
103 faces
104 (
105 (16 17 39 38)
106 (17 18 40 39)
107 (18 19 41 40)
108 (19 20 42 41)
109 (20 21 43 42)
110 );
111 }
112 upperWall
113 {
114 type wall;
115 faces
116 (
117 (3 25 31 9)
118 (9 31 37 15)
119 (15 37 43 21)
120 );
121 }
122 lowerWall
123 {
124 type wall;
125 faces
126 (
127 (0 6 28 22)
128 (6 5 27 28)
129 (5 4 26 27)
130 (4 10 32 26)
131 (10 16 38 32)
132 );
133 }
134 frontAndBack
135 {
136 type empty;
137 faces
138 (
139 (22 28 29 23)
140 (23 29 30 24)
141 (24 30 31 25)
142 (26 32 33 27)
143 (27 33 34 28)
144 (28 34 35 29)
145 (29 35 36 30)
146 (30 36 37 31)

OpenFOAM-3.0.1
P-56 Examples of the use of OpenFOAM

147 (32 38 39 33)

148 (33 39 40 34)
149 (34 40 41 35)
150 (35 41 42 36)
151 (36 42 43 37)
152 (0 1 7 6)
153 (1 2 8 7)
154 (2 3 9 8)
155 (4 5 11 10)
156 (5 6 12 11)
157 (6 7 13 12)
158 (7 8 14 13)
159 (8 9 15 14)
160 (10 11 17 16)
161 (11 12 18 17)
162 (12 13 19 18)
163 (13 14 20 19)
164 (14 15 21 20)
165 );
166 }
167 );
168
169 mergePatchPairs
170 (
171 );
172
173 // ************************************************************************* //

A major feature of this problem is the use of the full mesh grading capability of blockMesh
that is described in section 5.3.1 of the User Guide. The user can see that blocks 4,5 and 6
use the full list of 12 expansion ratios. The expansion ratios correspond to each edge of the
block, the first 4 to the edges aligned in the local x1 direction, the second 4 to the edges
in the local x2 direction and the last 4 to the edges in the local x3 direction. In blocks 4,
5, and 6, the ratios are equal for all edges in the local x1 and x3 directions but not for the
edges in the x2 direction that corresponds in all blocks to the global y. If we consider the
ratios used in relation to the block definition in section 5.3.1 of the User Guide, we realize
that different gradings have been prescribed along the left and right edges in blocks 4,5 and
6 in Figure 3.5. The purpose of this differential grading is to generate a fine mesh close to
the most critical region of flow, the corner of the step, and allow it to expand into the rest
of the domain.
The mesh can be generated using blockMesh from the command line or from within
FoamX and viewed as described in previous examples.

3.2.3 Boundary conditions and initial fields

The case files can be viewed, or edited from within FoamX or by hand. In this case, we are
required to set the initial and boundary fields for velocity U, pressure p, turbulent kinetic
energy k and dissipation rate ε. The boundary conditions can be specified by setting the
physical patch types in FoamX: the upper and lower walls are set to Wall, the left patch
to Inlet and the right patch to Outlet. These physical boundary conditions require us to
specify a fixedValue at the inlet on U, k and ε. U is given in the problem specification,
but the values of k and ǫ must be chosen by the user in a similar manner to that described
in section 2.1.8.1 of the User Guide. We assume that the inlet turbulence is isotropic and
estimate the fluctuations to be 5% of U at the inlet. We have
5
Ux′ = Uy′ = Uz′ = 10 = 0.5 m/s (3.5)
100
and
3
k = (0.5)2 = 0.375 m2 /s2 (3.6)
2

OpenFOAM-3.0.1
3.2 Steady turbulent flow over a backward-facing step P-57

If we estimate the turbulent length scale l to be 10% of the width of the inlet then

Cµ0.75 k 1.5 0.090.75 0.3751.5

ε= = = 14.855 m2 /s3 (3.7)
l 0.1 × 25.4 × 10 −3

At the outlet we need only specify the pressure p = 0Pa.

3.2.4 Case control

The choices of fvSchemes are as follows: the timeScheme should be SteadyState; the
gradScheme and laplacianScheme should be set as default to Gauss; and, the divScheme
should be set to UD to ensure boundedness.
Special attention should be paid to the settings of fvTolerances. Although the top level
simpleFoam code contains only equations for p and U, the turbulent model solves equations
for k, ε and R, and tolerance settings are required for all 5 equations. A solverTolerance
of 10−5 and solverRelativeTolerance of 0.1 are acceptable for all variables with the
exception of p when 10−6 and 0.01 are recommended. Under-relaxation of the solution is
required since the problem is steady. A relaxationFactor of 0.7 is acceptable for U, k, ε
and R but 0.3 is required for p to avoid numerical instability.
Finally, in controlDict, the time step deltaT should be set to 1 since in steady state
cases such as this is effectively an iteration counter. With benefit of hindsight we know that
the solution requires 1000 iterations reach reasonable convergence, hence endTime is set to
1000. Ensure that the writeFrequency is sufficiently high, e.g. 50, that you will not fill the
hard disk with data during run time.

3.2.5 Running the case and post-processing

(a) Velocity vectors after 50 iterations

(b) Velocity vectors at 1000 iterations

(c) Streamlines at 1000 iterations

Figure 3.6: Development of a vortex in the backward-facing step.

OpenFOAM-3.0.1
P-58 Examples of the use of OpenFOAM

Run the case and post-process the results. After a few iterations, e.g. 50, a vortex
develops beneath the corner of the step that is the height of the step but narrow in the
x-direction as shown by the vector plot of velocities is shown Figure 3.6(a). Over several
iterations the vortex stretches in the x-direction from the step to the outlet until at 1000
iterations the system reaches a steady-state in which the vortex is fully developed as shown
in Figure 3.6(b-c).

3.3 Supersonic flow over a forward-facing step

In this example we shall investigate supersonic flow over a forward-facing step. The problem
description involves a flow of Mach 3 at an inlet to a rectangular geometry with a step near
the inlet region that generates shock waves.
This example introduces the following OpenFOAM features for the first time:

• supersonic flow;

3.3.1 Problem specification

The problem is defined as follows:

Solution domain The domain is 2 dimensional and consists of a short inlet section fol-
lowed by a forward-facing step of 20% the height of the section as shown in Figure 3.7

Inlet: Ux = Mach 3, p = 1 N/m2

1.0

y
0.2
x
0.6 2.4
Dimensions in m
Figure 3.7: Geometry of the forward step geometry

Governing equations

• Mass continuity

∂ρ
+ ∇ • (ρU) = 0 (3.8)
∂t

• Ideal gas

p = ρRT (3.9)

OpenFOAM-3.0.1
3.3 Supersonic flow over a forward-facing step P-59

• Momentum equation for Newtonian fluid

∂ρU
+ ∇ • (ρUU) − ∇ • µ∇U = −∇p (3.10)
∂t
• Energy equation for fluid (ignoring some viscous terms), e = Cv T , with Fourier’s
Law q = −k∇T
µ ¶
∂ρe k
+ ∇ • (ρUe) − ∇ • ∇e = p∇ • U (3.11)
∂t Cv

Initial conditions U = 0 m/s, p = 1 Pa, T = 1 K.

Boundary conditions

• Inlet (left) with fixedValue for velocity U = 3 m/s = Mach 3, pressure p = 1 Pa

and temperature T = 1 K;
• Outlet (right) with zeroGradient on U , p and T ;
• No-slip adiabatic wall (bottom);
• Symmetry plane (top).

Transport properties

• Dynamic viscosity of air µ = 18.1µPa s

Thermodynamic properties

• Specific heat at constant volume Cv = 1.78571 J/kg K

• Gas constant R = 0.714286 J/kg K
• Conductivity k = 32.3 µW/m K

Case name forwardStep case located in the $FOAM TUTORIALS/sonicFoam directory.

Solver name sonicFoam: an implementation for compressible trans-sonic/supersonic lam-

inar gas flow.
√
The case is designed such that the speed of sound of the gas c = γRT = 1 m/s, the
consequence being that the velocities are directly equivalent to the Mach number, e.g. the
inlet velocity of 3 m/s is equivalent to Mach 3. This speed of sound calculation can be
verified using the relationship for a perfect gas, Cp − Cv = R, i.e. the ratio of specific heats
R
γ = Cp /Cv = +1 (3.12)
Cv

3.3.2 Mesh generation

The mesh used in this case is relatively simple, specified with uniform rectangular cells of
length 0.06 m in the x direction and 0.05 m in the y direction. The geometry can simply
be divided into 3 blocks, one below the top of the step, and two above the step, one either
side of the step front. The full set of vertices and blocks are given in the mesh description
file below:

OpenFOAM-3.0.1
P-60 Examples of the use of OpenFOAM

1 /*--------------------------------*- C++ -*----------------------------------*\

2 | ========= | |
3 | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox |
4 | \\ / O peration | Version: 3.0.1 |
5 | \\ / A nd | Web: www.OpenFOAM.org |
6 | \\/ M anipulation | |
7 \*---------------------------------------------------------------------------*/
8 FoamFile
9 {
10 version 2.0;
11 format ascii;
12 class dictionary;
13 object blockMeshDict;
14 }
15 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
16
17 convertToMeters 1;
18
19 vertices
20 (
21 (0 0 -0.05)
22 (0.6 0 -0.05)
23 (0 0.2 -0.05)
24 (0.6 0.2 -0.05)
25 (3 0.2 -0.05)
26 (0 1 -0.05)
27 (0.6 1 -0.05)
28 (3 1 -0.05)
29 (0 0 0.05)
30 (0.6 0 0.05)
31 (0 0.2 0.05)
32 (0.6 0.2 0.05)
33 (3 0.2 0.05)
34 (0 1 0.05)
35 (0.6 1 0.05)
36 (3 1 0.05)
37 );
38
39 blocks
40 (
41 hex (0 1 3 2 8 9 11 10) (25 10 1) simpleGrading (1 1 1)
42 hex (2 3 6 5 10 11 14 13) (25 40 1) simpleGrading (1 1 1)
43 hex (3 4 7 6 11 12 15 14) (100 40 1) simpleGrading (1 1 1)
44 );
45
46 edges
47 (
48 );
49
50 boundary
51 (
52 inlet
53 {
54 type patch;
55 faces
56 (
57 (0 8 10 2)
58 (2 10 13 5)
59 );
60 }
61 outlet
62 {
63 type patch;
64 faces
65 (
66 (4 7 15 12)
67 );
68 }
69 bottom
70 {
71 type symmetryPlane;
72 faces
73 (
74 (0 1 9 8)
75 );
76 }
77 top
78 {
79 type symmetryPlane;

OpenFOAM-3.0.1
3.4 Decompression of a tank internally pressurised with water P-61

80 faces
81 (
82 (5 13 14 6)
83 (6 14 15 7)
84 );
85 }
86 obstacle
87 {
88 type patch;
89 faces
90 (
91 (1 3 11 9)
92 (3 4 12 11)
93 );
94 }
95 );
96
97 mergePatchPairs
98 (
99 );
100
101 // ************************************************************************* //

3.3.3 Running the case

The case approaches a steady-state at some time after 5 s. The results for pressure at 10 s
are shown in Figure 3.8. The results clearly show discontinuities in pressure, i.e. shock
waves, emanating from ahead of the base of the step.
pressure
Shock fronts
14
12
10
8
6
4
2

Figure 3.8: Shock fronts in the forward step problem

3.3.4 Exercise
The user can examine the effect on the solution of increasing the inlet velocity.

3.4 Decompression of a tank internally pressurised with

water
In this example we shall investigate a problem of rapid opening of a pipe valve close to
a pressurised liquid-filled tank. The prominent feature of the result in such cases is the
propagation of pressure waves which must therefore be modelled as a compressible liquid.
This tutorial introduces the following OpenFOAM features for the first time:
• Mesh refinement

OpenFOAM-3.0.1
P-62 Examples of the use of OpenFOAM

• Pressure waves in liquids

3.4.1 Problem specification

Solution domain The domain is 2 dimensional and consists of a tank with a small outflow
pipe as shown in Figure 3.9

x
100

50 50 240
Outlet: p = 0 bar
Dimensions in mm
10 Note: image is rotated through -90◦ from normal
orientation of horizontal x-axis
Figure 3.9: Geometry of a tank with outflow pipe

Governing equations This problem requires a model for compressibility ψ in the fluid
in order to be able to resolve waves propagating at a finite speed. A barotropic
relationship is used to relate density ρ and pressure p are related to ψ.

• Mass continuity
∂ρ
+ ∇ • (ρU) = 0 (3.13)
∂t
• The barotropic relationship
∂ρ ρ
= =ψ (3.14)
∂p K
where K is the bulk modulus
• Equation 3.14 is linearised as

ρ ≈ ρ0 + ψ (p − p0 ) (3.15)

where ρ0 and p0 are the reference density and pressure respectively such that
ρ(p0 ) = ρ0 .
• Momentum equation for Newtonian fluid
∂ρU
+ ∇ • (ρUU) − ∇ • µ∇U = −∇p (3.16)
∂t
Boundary conditions Using FoamX the following physical boundary conditions can be
set:

OpenFOAM-3.0.1
3.4 Decompression of a tank internally pressurised with water P-63

• outerWall is specified the wall condition;

• axis is specified as the symmetryPlane;
• nozzle is specified as a pressureOutlet where p = 0 bar.
• front and back boundaries are specified as empty.

Initial conditions U = 0 m/s, p = 100 bar.

Transport properties

• Dynamic viscosity of water µ = 1.0 mPa s

Thermodynamic properties

• Density of water ρ = 1000 kg/m3

• Reference pressure p0 = 1 bar
• Compressibility of water ψ = 4.54 × 10−7 s2 /m2

Solver name sonicLiquidFoam: a compressible sonic laminar liquid flow code.

Case name decompressionTank case located in the $FOAM TUTORIALS/sonicLiquidFoam

directory.

3.4.2 Mesh Generation

The full geometry is modelled in this case; the set of vertices and blocks are given in the
mesh description file below:
1 /*--------------------------------*- C++ -*----------------------------------*\
2 | ========= | |
3 | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox |
4 | \\ / O peration | Version: 3.0.1 |
5 | \\ / A nd | Web: www.OpenFOAM.org |
6 | \\/ M anipulation | |
7 \*---------------------------------------------------------------------------*/
8 FoamFile
9 {
10 version 2.0;
11 format ascii;
12 class dictionary;
13 object blockMeshDict;
14 }
15 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
16
17 convertToMeters 0.1;
18
19 vertices
20 (
21 (0 0 -0.1)
22 (1 0 -0.1)
23 (0 0.5 -0.1)
24 (1 0.5 -0.1)
25 (1.5 0.5 -0.1)
26 (0 0.6 -0.1)
27 (1 0.6 -0.1)
28 (1.5 0.6 -0.1)
29 (0 3 -0.1)
30 (1 3 -0.1)
31 (0 0 0.1)
32 (1 0 0.1)
33 (0 0.5 0.1)
34 (1 0.5 0.1)
35 (1.5 0.5 0.1)
36 (0 0.6 0.1)

OpenFOAM-3.0.1
P-64 Examples of the use of OpenFOAM

37 (1 0.6 0.1)
38 (1.5 0.6 0.1)
39 (0 3 0.1)
40 (1 3 0.1)
41 );
42
43 blocks
44 (
45 hex (0 1 3 2 10 11 13 12) (30 20 1) simpleGrading (1 1 1)
46 hex (2 3 6 5 12 13 16 15) (30 5 1) simpleGrading (1 1 1)
47 hex (3 4 7 6 13 14 17 16) (25 5 1) simpleGrading (1 1 1)
48 hex (5 6 9 8 15 16 19 18) (30 95 1) simpleGrading (1 1 1)
49 );
50
51 edges
52 (
53 );
54
55 boundary
56 (
57 outerWall
58 {
59 type wall;
60 faces
61 (
62 (0 1 11 10)
63 (1 3 13 11)
64 (3 4 14 13)
65 (7 6 16 17)
66 (6 9 19 16)
67 (9 8 18 19)
68 );
69 }
70 axis
71 {
72 type symmetryPlane;
73 faces
74 (
75 (0 10 12 2)
76 (2 12 15 5)
77 (5 15 18 8)
78 );
79 }
80 nozzle
81 {
82 type patch;
83 faces
84 (
85 (4 7 17 14)
86 );
87 }
88 back
89 {
90 type empty;
91 faces
92 (
93 (0 2 3 1)
94 (2 5 6 3)
95 (3 6 7 4)
96 (5 8 9 6)
97 );
98 }
99 front
100 {
101 type empty;
102 faces
103 (
104 (10 11 13 12)
105 (12 13 16 15)
106 (13 14 17 16)
107 (15 16 19 18)
108 );
109 }
110 );
111
112 mergePatchPairs
113 (
114 );
115
116 // ************************************************************************* //

OpenFOAM-3.0.1
3.4 Decompression of a tank internally pressurised with water P-65

In order to improve the numerical accuracy, we shall use the reference level of 1 bar for the
pressure field. Note that both the internal field level and the boundary conditions are offset
by the reference level.

3.4.3 Preparing the Run

Before we commence the setup of the calculation, we need to consider the characteristic
velocity of the phenomenon we are trying to capture. In the case under consideration, the
fluid velocity will be very small, but the pressure wave will propagate with the speed of
sound in water. The speed of sound is calculated as:
r r
1 1
c= = = 1483.2m/s. (3.17)
ψ 4.54 × 10−7

For the mesh described above, the characteristic mesh size is approximately 2 mm (note the
scaling factor of 0.1 in the blockMeshDict file). Using
U ∆t
Co = (3.18)
∆x
a reasonable time step is around ∆t = 5 × 10−7 s, giving the Co number of 0.35, based on
the speed of sound. Also, note that the reported Co number by the code (associated with
the convective velocity) will be two orders of magnitude smaller. As we are interested in
the pressure wave propagation, we shall set the simulation time to 0.25 ms. For reference,
the controlDict file is quoted below.
1 /*--------------------------------*- C++ -*----------------------------------*\
2 | ========= | |
3 | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox |
4 | \\ / O peration | Version: 3.0.1 |
5 | \\ / A nd | Web: www.OpenFOAM.org |
6 | \\/ M anipulation | |
7 \*---------------------------------------------------------------------------*/
8 FoamFile
9 {
10 version 2.0;
11 format ascii;
12 class dictionary;
13 location "system";
14 object controlDict;
15 }
16 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
17
18 application sonicLiquidFoam;
19
20 startFrom startTime;
21
22 startTime 0;
23
24 stopAt endTime;
25
26 endTime 0.0001;
27
28 deltaT 5e-07;
29
30 writeControl timeStep;
31
32 writeInterval 20;
33
34 purgeWrite 0;
35
36 writeFormat ascii;
37
38 writePrecision 6;
39

OpenFOAM-3.0.1
P-66 Examples of the use of OpenFOAM

40 writeCompression off;
41
42 timeFormat general;
43
44 timePrecision 6;
45
46 runTimeModifiable true;
47
48
49 // ************************************************************************* //

3.4.4 Running the case

Pressure, p
(bar)
100
90
80
70
60
50
40
30
20
10
0

(a) At t = 50 µs (b) At t = 100 µs (c) At t = 150 µs

Figure 3.10: Propagation of pressure waves

The user can run the case and view results in dxFoam. The liquid flows out through
the nozzle causing a wave to move along the nozzle. As it reaches the inlet to the tank,
some of the wave is transmitted into the tank and some of it is reflected. While a wave
is reflected up and down the inlet pipe, the waves transmitted into the tank expand and
propagate through the tank. In Figure 3.10, the pressures are shown as contours so that
the wave fronts are more clearly defined than if plotted as a normal isoline plot.
If the simulation is run for a long enough time for the reflected wave to return to the
pipe, we can see that negative absolute pressure is detected. The modelling permits this and
has some physical basis since liquids can support tension, i.e. negative pressures. In reality,
however, impurities or dissolved gases in liquids act as sites for cavitation, or vapourisa-
tion/boiling, of the liquid due to the low pressure. Therefore in practical situations, we
generally do not observe pressures falling below the vapourisation pressure of the liquid; not
at least for longer than it takes for the cavitation process to occur.

OpenFOAM-3.0.1
3.5 Magnetohydrodynamic flow of a liquid P-67

Pressure, p
(bar)
100
90
80
70
60
50
40
30
20
10
0

(a) At t = 50 µs (b) At t = 100 µs (c) At t = 150 µs

Figure 3.11: Propagation of pressure waves with refined mesh

3.4.5 Improving the solution by refining the mesh

Looking at the evolution of the resulting pressure field in time, we can clearly see the
propagation of the pressure wave into the tank and numerous reflections from the inside
walls. It is also obvious that the pressure wave is smeared over a number of cells. We shall
now refine the mesh and reduce the time step to obtain a sharper front resolution. Simply
edit the blockMeshDict and increase the number of cells by a factor of 4 in the x and y
directions, i.e. block 0 becomes (120 80 1) from (30 20 1) and so on. Run blockMesh on
this file. In addition, in order to maintain a Courant number below 1, the time step must
be reduced accordingly to ∆t = 10−7 s. The second simulation gives considerably better
resolution of the pressure waves as shown in Figure 3.11.

3.5 Magnetohydrodynamic flow of a liquid

In this example we shall investigate an flow of an electrically-conducting liquid through a
magnetic field. The problem is one belonging to the branch of fluid dynamics known as
magnetohydrodynamics (MHD) that uses mhdFoam.

3.5.1 Problem specification

The problem is known as the Hartmann problem, chosen as it contains an analytical solution
with which mhdFoam can be validated. It is defined as follows:
Solution domain The domain is 2 dimensional and consists of flow along two parallel
plates as shown in Fig. 3.12.
Governing equations

OpenFOAM-3.0.1
P-68 Examples of the use of OpenFOAM

20

y
By = 20 T 2
x

Inlet: Ux = 1 m/s Outlet: p = 0 bar

Figure 3.12: Geometry of the Hartmann problem

• Mass continuity for incompressible fluid

∇•U=0 (3.19)

• Momentum equation for incompressible fluid

∂U
+ ∇ • (UU) + ∇ • (2BΓBU B) + ∇ • (νU) + ∇ (ΓBU B •• B) = −∇p (3.20)
∂t
where B is the magnetic flux density, ΓBU = (2µρ)−1 .
• Maxwell’s equations
∂B
∇×E=− (3.21)
∂t
where E is the electric field strength.

∇•B=0 (3.22)

∂D
∇×H=J+ =J (3.23)
∂t
assuming ∂D/∂t ≪ J. Here, H is the magnetic field strength, J is the current
density and D is the electric flux density.
• Charge continuity

∇•J=0 (3.24)

• Constitutive law

B = µH (3.25)

• Ohm’s law

J = σ (E + U × B) (3.26)

• Combining Equation 3.21, Equation 3.23, Equation 3.26, and taking the curl
∂B
+ ∇ • (UB) − ∇ • (φB U) − ∇ • (ΓB B) = 0 (3.27)
∂t

OpenFOAM-3.0.1
3.5 Magnetohydrodynamic flow of a liquid P-69

Boundary conditions

• inlet is specified the inlet condition with fixed velocity U = (1, 0, 0) m/s;
• outlet is specified as the outlet with with fixed pressure p = 0 Pa;
• upperWall is specified as a wall where B = (0, 20, 0) T.
• lowerWall is specified as a wall where B = (0, 20, 0) T.
• front and back boundaries are specified as empty.

Initial conditions U = 0 m/s, p = 100 Pa, B = (0, 20, 0) T.

Transport properties

• Kinematic viscosity ν = 1 Pa s
• Density ρ = 1 kg m/s
• Electrical conductivity σ = 1 (Ω m)−1
• Permeability µ = 1 H/m

Solver name mhdFoam: an incompressible laminar magneto-hydrodynamics code.

Case name hartmann case located in the $FOAM TUTORIALS/mhdFoam directory.

3.5.2 Mesh generation

The geometry is simply modelled with 100 cells in the x-direction and 40 cells in the y-
direction; the set of vertices and blocks are given in the mesh description file below:
1 /*--------------------------------*- C++ -*----------------------------------*\
2 | ========= | |
3 | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox |
4 | \\ / O peration | Version: 3.0.1 |
5 | \\ / A nd | Web: www.OpenFOAM.org |
6 | \\/ M anipulation | |
7 \*---------------------------------------------------------------------------*/
8 FoamFile
9 {
10 version 2.0;
11 format ascii;
12 class dictionary;
13 object blockMeshDict;
14 }
15 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
16
17 convertToMeters 1;
18
19 vertices
20 (
21 (0 -1 0)
22 (20 -1 0)
23 (20 1 0)
24 (0 1 0)
25 (0 -1 0.1)
26 (20 -1 0.1)
27 (20 1 0.1)
28 (0 1 0.1)
29 );
30
31 blocks
32 (
33 hex (0 1 2 3 4 5 6 7) (100 40 1) simpleGrading (1 1 1)
34 );
35
36 edges

OpenFOAM-3.0.1
P-70 Examples of the use of OpenFOAM

37 (
38 );
39
40 boundary
41 (
42 inlet
43 {
44 type patch;
45 faces
46 (
47 (0 4 7 3)
48 );
49 }
50 outlet
51 {
52 type patch;
53 faces
54 (
55 (2 6 5 1)
56 );
57 }
58 lowerWall
59 {
60 type patch;
61 faces
62 (
63 (1 5 4 0)
64 );
65 }
66 upperWall
67 {
68 type patch;
69 faces
70 (
71 (3 7 6 2)
72 );
73 }
74 frontAndBack
75 {
76 type empty;
77 faces
78 (
79 (0 3 2 1)
80 (4 5 6 7)
81 );
82 }
83 );
84
85 mergePatchPairs
86 (
87 );
88
89 // ************************************************************************* //

3.5.3 Running the case

The user can run the case and view results in dxFoam. It is also useful at this stage to run
the Ucomponents utility to convert the U vector field into individual scalar components.
MHD flow is governed by, amongst other things, the Hartmann number which is a measure
of the ratio of electromagnetic body force to viscous force
r
σ
M = BL (3.28)
ρν

where L is the characteristic length scale. In this case with By = 20 T, M = 20 and the
electromagnetic body forces dominate the viscous forces. Consequently with the flow fairly
steady at t = 2 s the velocity profile is almost planar, viewed at a cross section midway
along the domain x = 10 m. The user can plot a graph of the profile of Ux in dxFoam.
Now the user should reduce the magnetic flux density B to 1 Tand re-run the code and
Ucomponents. In this case, M = 1 and the electromagnetic body forces no longer dominate.

OpenFOAM-3.0.1
3.5 Magnetohydrodynamic flow of a liquid P-71

y (m)
+1.0

By = 1 T

0.0 By = 20 T

-1.0
0.0 0.5 1.0 1.5
Ux (m/s)
Figure 3.13: Velocity profile in the Hartmann problem for By = 1 T and By = 20 T.

The velocity profile consequently takes on the parabolic form, characteristic of Poiseuille
flow as shown in Figure 3.13. To validate the code the analytical solution for the velocity
profile Ux is superimposed in Figure 3.13, given by:

Ux (y) cosh M − cosh M (y/L)

= (3.29)
Ux (0) cosh M − 1

where the characteristic length L is half the width of the domain, i.e. 1 m.

OpenFOAM-3.0.1
P-72 Examples of the use of OpenFOAM

OpenFOAM-3.0.1
Index P-73

Index
Symbols Numbers A B C D E F G H I J K L M N O P Q R S T U V W X Z

Symbols adjointShapeOptimizationFoam solver, U-86

* adjustableRunTime
tensor member function, P-23 keyword entry, U-62, U-114
+ adjustTimeStep keyword, U-62, U-115
tensor member function, P-23 agglomerator keyword, U-125
- algorithms tools, U-98
tensor member function, P-23 alphaContactAngle
/ boundary condition, U-59
tensor member function, P-23 analytical solution, P-43
/*...*/ Animations window panel, U-174
C++ syntax, U-78 anisotropicFilter model, U-103
// Annotation window panel, U-24
C++ syntax, U-78 ansysToFoam utility, U-91
OpenFOAM file syntax, U-106 APIfunctions model, U-102
# include applications, U-69
C++ syntax, U-72, U-78 Apply button, U-170, U-174
& applyBoundaryLayer utility, U-90
tensor member function, P-23 applyWallFunctionBoundaryConditions utility,
&& U-90
tensor member function, P-23 arbitrarily unstructured, P-29
^ arc
tensor member function, P-23 keyword entry, U-142
<LESModel>Coeffs keyword, U-198
arc keyword, U-141
<RASModel>Coeffs keyword, U-198
As keyword, U-193
<delta>Coeffs keyword, U-198
ascii
0.000000e+00 directory, U-106
keyword entry, U-114
1-dimensional mesh, U-133
attachMesh utility, U-92
1D mesh, U-133
Auto Accept button, U-174
2-dimensional mesh, U-133
autoMesh
2D mesh, U-133
library, U-99
Numbers autoPatch utility, U-92
0 directory, U-106 autoRefineMesh utility, U-93
axes
A right-handed, U-140
access functions, P-21 right-handed rectangular Cartesian, P-13,
addLayersControls keyword, U-150 U-18
adiabaticFlameT utility, U-97 axi-symmetric cases, U-137, U-148
adiabaticPerfectFluid model, U-101, U-195 axi-symmetric mesh, U-133

OpenFOAM-3.0.1
P-74 Index

B movingWallVelocity, U-139
background outlet, P-69
process, U-24, U-81 outletInlet, U-139
backward partialSlip, U-139
keyword entry, U-122 patch, U-136
Backward differencing, P-37 pressureDirectedInletVelocity, U-139
barotropicCompressibilityModels pressureInletVelocity, U-139
library, U-101 pressureOutlet, P-63
basicMultiComponentMixture model, U-100 pressureTransmissive, U-139
basicSolidThermo processor, U-138
library, U-102 setup, U-20
basicThermophysicalModels slip, U-139
library, U-100 supersonicFreeStream, U-139
binary surfaceNormalFixedValue, U-139
keyword entry, U-114 symmetryPlane, P-63, U-137
BirdCarreau model, U-104 totalPressure, U-139
blended differencing, P-36 turbulentInlet, U-139
block wall, U-41
expansion ratio, U-143 wall, P-63, P-69, U-59, U-137
block keyword, U-141 wedge, U-133, U-137, U-148
blocking zeroGradient, U-138
keyword entry, U-80 boundary conditions, P-41
blockMesh Dirichlet, P-41
library, U-99 inlet, P-42
blockMesh solver, P-45 Neumann, P-41
blockMesh utility, U-38, U-91, U-140 no-slip impermeable wall, P-42
blockMesh executable outlet, P-42
vertex numbering, U-143 physical, P-42
blockMeshDict symmetry plane, P-42
dictionary, U-18, U-20, U-36, U-49, U-140, boundaryField keyword, U-21, U-110
U-149 boundaryFoam solver, U-86
blocks keyword, U-20, U-31, U-142 bounded
boundaries, U-133 keyword entry, U-120, U-121
boundary, U-133 boxToCell keyword, U-60
boundary boxTurb utility, U-90
dictionary, U-132, U-140 breaking of a dam, U-56
boundary keyword, U-145 BSpline
boundary condition keyword entry, U-142
alphaContactAngle, U-59 buoyantBoussinesqPimpleFoam solver, U-88
buoyantPressure, U-139 buoyantBoussinesqSimpleFoam solver, U-88
calculated, U-138 buoyantPimpleFoam solver, U-88
cyclic, U-137, U-146 buoyantPressure
directionMixed, U-138 boundary condition, U-139
empty, P-63, P-69, U-18, U-133, U-137 buoyantSimpleFoam solver, U-88
fixedGradient, U-138 burntProducts keyword, U-193
fixedValue, U-138 button
fluxCorrectedVelocity, U-139 Apply, U-170, U-174
inlet, P-69 Auto Accept, U-174
inletOutlet, U-139 Camera Parallel Projection, U-174
mixed, U-138 Choose Preset, U-173

OpenFOAM-3.0.1
Index P-75

Delete, U-170 Charts window panel, U-174

Edit Color Map, U-172 checkMesh utility, U-92, U-160
Enable Line Series, U-35 chemFoam solver, U-88
Lights, U-174 chemistryModel
Orientation Axes, U-24 library, U-102
Refresh Times, U-25, U-171 chemistryModel model, U-102
Rescale to Data Range, U-25 chemistrySolver model, U-102
Reset, U-170 chemkinToFoam utility, U-97
Set Ambient Color, U-173 Choose Preset button, U-173
Update GUI, U-171 chtMultiRegionSimpleFoam solver, U-88
Use Parallel Projection, U-24 chtMultiRegionFoam solver, U-88
Chung
C library, U-101
C++ syntax
class
/*...*/, U-78
cell, P-29
//, U-78
dimensionSet, P-24, P-30, P-31
# include, U-72, U-78
face, P-29
cacheAgglomeration keyword, U-126
finiteVolumeCalculus, P-34
calculated
finiteVolumeMethod, P-34
boundary condition, U-138
fvMesh, P-29
cAlpha keyword, U-63
fvSchemes, P-36
Camera Parallel Projection button, U-174
fvc, P-34
cases, U-105
fvm, P-34
castellatedMesh keyword, U-150
castellatedMeshControls pointField, P-29
dictionary, U-152–U-154 polyBoundaryMesh, P-29
castellatedMeshControls keyword, U-150 polyMesh, P-29, U-129, U-131
cavitatingDyMFoam solver, U-87 polyPatchList, P-29
cavitatingFoam solver, U-87 polyPatch, P-29
cavity flow, U-17 scalarField, P-27
CEI ARCH scalar, P-22
environment variable, U-184 slice, P-29
CEI HOME symmTensorField, P-27
environment variable, U-184 symmTensorThirdField, P-27
cell tensorField, P-27
expansion ratio, U-143 tensorThirdField, P-27
cell class, P-29 tensor, P-22
cell vectorField, P-27
keyword entry, U-185 vector, P-22, U-109
cellLimited word, P-24, P-29
keyword entry, U-120 class keyword, U-107
cellPoint clockTime
keyword entry, U-185 keyword entry, U-114
cellPointFace cloud keyword, U-187
keyword entry, U-185 cloudFunctionObjects
cells library, U-98
dictionary, U-140 cmptAv
central differencing, P-36 tensor member function, P-23
cfdTools tools, U-98 Co utility, U-93
cfx4ToFoam utility, U-91, U-159 coalChemistryFoam solver, U-89
changeDictionary utility, U-90 coalCombustion

OpenFOAM-3.0.1
P-76 Index

library, U-99 temporal discretisation, P-41

cofactors CrankNicolson
tensor member function, P-23 keyword entry, U-122
coldEngineFoam solver, U-88 createExternalCoupledPatchGeometry utility,
collapseEdges utility, U-93 U-90
Color By menu, U-173 createBaffles utility, U-92
Color Legend window, U-29 createPatch utility, U-92
Color Legend window panel, U-173 createTurbulenceFields utility, U-94
Color Scale window panel, U-173 cross product, see tensor, vector cross product
Colors window panel, U-174 CrossPowerLaw
compressibleInterDyMFoam solver, U-87 keyword entry, U-60
compressibleInterFoam solver, U-87 CrossPowerLaw model, U-104
compressibleMultiphaseInterFoam solver, U-87 cubeRootVolDelta model, U-103
combinePatchFaces utility, U-93 cubicCorrected
comments, U-78 keyword entry, U-122
commsType keyword, U-80 cubicCorrection
compressed keyword entry, U-119
keyword entry, U-114 curl, P-35
compressibleLESModels curl
library, U-104 fvc member function, P-35
compressibleRASModels Current Time Controls menu, U-25, U-171
library, U-103 curve keyword, U-187
constant directory, U-105, U-191 Cv keyword, U-193
constant model, U-101 cyclic
constTransport model, U-101 boundary condition, U-137, U-146
containers tools, U-98 cyclic
keyword entry, U-137
continuum
cylinder
mechanics, P-13
flow around a, P-43
control
of time, U-113 D
controlDict d2dt2
dictionary, P-65, U-22, U-31, U-42, U-51, fvc member function, P-35
U-62, U-105, U-165 fvm member function, P-35
controlDict file, P-48 dam
convection, see divergence, P-36 breaking of a, U-56
convergence, U-39 datToFoam utility, U-91
conversion db tools, U-98
library, U-99 ddt
convertToMeters keyword, U-140 fvc member function, P-35
convertToMeters keyword, U-141 fvm member function, P-35
coordinate DeardorffDiffStress model, U-103, U-104
system, P-13 debug keyword, U-150
coordinate system, U-18 decompose model, U-100
corrected decomposePar utility, U-82, U-83, U-97
keyword entry, U-120, U-121 decomposeParDict
Courant number, P-40, U-22 dictionary, U-82
Cp keyword, U-193 decomposition
cpuTime of field, U-82
keyword entry, U-114 of mesh, U-82
Crank Nicolson decompositionMethods

OpenFOAM-3.0.1
Index P-77

library, U-99 SUPERBEE, P-36

decompression of a tank, P-61 upwind, P-36
defaultFieldValues keyword, U-60 van Leer, P-36
deformedGeom utility, U-92 DILU
Delete button, U-170 keyword entry, U-125
delta keyword, U-83, U-198 dimension
deltaT keyword, U-114 checking in OpenFOAM, P-24, U-109
dependencies, U-72 dimensional units, U-109
dependency lists, U-72 dimensioned<Type> template class, P-24
det dimensionedTypes tools, U-98
tensor member function, P-23 dimensions keyword, U-21, U-110
determinant, see tensor, determinant dimensionSet class, P-24, P-30, P-31
dev dimensionSet tools, U-98
tensor member function, P-23 directionMixed
diag boundary condition, U-138
tensor member function, P-23 directory
diagonal 0.000000e+00, U-106
keyword entry, U-124, U-125 0, U-106
DIC Make, U-73
keyword entry, U-125 constant, U-105, U-191
DICGaussSeidel fluentInterface, U-181
keyword entry, U-125 polyMesh, U-105, U-131
dictionary processorN , U-83
PISO, U-23 run, U-105
blockMeshDict, U-18, U-20, U-36, U-49, system, P-48, U-105
U-140, U-149 tutorials, P-43, U-17
boundary, U-132, U-140 discretisation
castellatedMeshControls, U-152–U-154 equation, P-31
cells, U-140 Display window panel, U-24, U-25, U-170, U-172
controlDict, P-65, U-22, U-31, U-42, U-51, distance
U-62, U-105, U-165 keyword entry, U-154, U-187
decomposeParDict, U-82 distributed model, U-100
faces, U-131, U-140 distributed keyword, U-83, U-84
fvSchemes, U-63, U-105, U-116 distributionModels
fvSolution, U-105, U-123 library, U-99
mechanicalProperties, U-51 div
neighbour, U-132 fvc member function, P-35
owner, U-131 fvm member function, P-35
points, U-131, U-140 divergence, P-35, P-37
thermalProperties, U-51 divSchemes keyword, U-116
thermophysicalProperties, U-191 dnsFoam solver, U-88
transportProperties, U-21, U-39, U-42, U-199 doLayers keyword, U-150
turbulenceProperties, U-41, U-61, U-197 double inner product, see tensor,double inner
differencing product
Backward, P-37 DPMFoam solver, U-89
blended, P-36 driftFluxFoam solver, U-87
central, P-36 dsmc
Euler implicit, P-37 library, U-99
Gamma, P-36 dsmcFieldsCalc utility, U-95
MINMOD, P-36 dsmcFoam solver, U-89

OpenFOAM-3.0.1
P-78 Index

dsmcInitialise utility, U-90 WM COMPILER LIB, U-76

dx WM COMPILER, U-76
keyword entry, U-185 WM COMPILE OPTION, U-76
dynamicFvMesh WM DIR, U-76
library, U-99 WM MPLIB, U-76
dynamicMesh WM OPTIONS, U-76
library, U-99 WM PRECISION OPTION, U-76
dynLagrangian model, U-103 WM PROJECT DIR, U-76
dynOneEqEddy model, U-103 WM PROJECT INST DIR, U-76
WM PROJECT USER DIR, U-76
E WM PROJECT VERSION, U-76
eConstThermo model, U-101 WM PROJECT, U-76
edgeGrading keyword, U-143 wmake, U-76
edgeMesh equationOfState keyword, U-192
library, U-99 equilibriumCO utility, U-97
edges keyword, U-141 equilibriumFlameT utility, U-97
Edit menu, U-174 errorReduction keyword, U-158
Edit Color Map button, U-172 Euler
egrMixture model, U-100 keyword entry, U-122
egrMixture keyword, U-193 Euler implicit
electrostaticFoam solver, U-89 differencing, P-37
empty temporal discretisation, P-40
boundary condition, P-63, P-69, U-18, examples
U-133, U-137 decompression of a tank, P-61
empty flow around a cylinder, P-43
keyword entry, U-137 flow over backward step, P-50
Enable Line Series button, U-35 Hartmann problem, P-67
endTime keyword, U-22, U-113, U-114 supersonic flow over forward step, P-58
energy keyword, U-192, U-196 execFlowFunctionObjects utility, U-95
engine expandDictionary utility, U-97
library, U-99 expansionRatio keyword, U-157
engineCompRatio utility, U-95 explicit
engineFoam solver, U-88 temporal discretisation, P-40
engineSwirl utility, U-90 extrude2DMesh utility, U-91
ensight74FoamExec utility, U-183 extrudeMesh utility, U-91
ENSIGHT7 INPUT extrudeToRegionMesh utility, U-91
environment variable, U-184
ENSIGHT7 READER F
environment variable, U-184 face class, P-29
ensightFoamReader utility, U-93 face keyword, U-187
enstrophy utility, U-93 faceAgglomerate utility, U-90
environment variable faceAreaPair
CEI ARCH, U-184 keyword entry, U-125
CEI HOME, U-184 faceLimited
ENSIGHT7 INPUT, U-184 keyword entry, U-120
ENSIGHT7 READER, U-184 faces
FOAM RUN, U-105 dictionary, U-131, U-140
WM ARCH OPTION, U-76 FDIC
WM ARCH, U-76 keyword entry, U-125
WM COMPILER BIN, U-76 featureAngle keyword, U-157
WM COMPILER DIR, U-76 features keyword, U-152

OpenFOAM-3.0.1
Index P-79

field flow
U, U-23 free surface, U-56
p, U-23 laminar, U-17
decomposition, U-82 steady, turbulent, P-50
FieldField<Type> template class, P-30 supersonic, P-58
fieldFunctionObjects turbulent, U-17
library, U-98 flow around a cylinder, P-43
fields, P-27 flow over backward step, P-50
mapping, U-165 flowType utility, U-93
fields tools, U-98 fluent3DMeshToFoam utility, U-91
fields keyword, U-185 fluentInterface directory, U-181
Field<Type> template class, P-27 fluentMeshToFoam utility, U-91, U-159
fieldValues keyword, U-60 fluxCorrectedVelocity
file boundary condition, U-139
Make/files, U-75 fluxRequired keyword, U-116
controlDict, P-48 OpenFOAM
files, U-73 cases, U-105
g, U-60 FOAM RUN
options, U-73 environment variable, U-105
snappyHexMeshDict, U-150 foamCalc utility, U-33
transportProperties, U-60 foamCalcFunctions
file format, U-106 library, U-98
fileFormats foamChemistryFile keyword, U-193
library, U-99 foamCorrectVrt script/alias, U-164
fileModificationChecking keyword, U-80 foamDataToFluent utility, U-93, U-181
fileModificationSkew keyword, U-80 foamDebugSwitches utility, U-97
files file, U-73 FoamFile keyword, U-107
filteredLinear2 foamFile
keyword entry, U-119 keyword entry, U-185
finalLayerThickness keyword, U-157 foamFormatConvert utility, U-97
financialFoam solver, U-90 foamHelp utility, U-97
find script/alias, U-179 foamInfoExec utility, U-97
finite volume foamJob script/alias, U-188
discretisation, P-25 foamListTimes utility, U-95
mesh, P-29 foamLog script/alias, U-188
finiteVolume foamMeshToFluent utility, U-91, U-181
library, U-98 foamToEnsight utility, U-93
finiteVolume tools, U-98 foamToEnsightParts utility, U-93
finiteVolumeCalculus class, P-34 foamToGMV utility, U-93
finiteVolumeMethod class, P-34 foamToStarMesh utility, U-91
fireFoam solver, U-88 foamToSurface utility, U-91
firstTime keyword, U-113 foamToTecplot360 utility, U-93
fixed foamToTetDualMesh utility, U-93
keyword entry, U-114 foamToVTK utility, U-93
fixedGradient foamUpgradeCyclics utility, U-90
boundary condition, U-138 foamUpgradeFvSolution utility, U-90
fixedValue foamyHexMeshBackgroundMesh utility, U-91
boundary condition, U-138 foamyHexMeshSurfaceSimplify utility, U-91
flattenMesh utility, U-92 foamyHexMesh utility, U-91
floatTransfer keyword, U-80 foamyQuadMesh utility, U-91

OpenFOAM-3.0.1
P-80 Index

forces gambitToFoam utility, U-91, U-159

library, U-98 GAMG
foreground keyword entry, U-53, U-124, U-125
process, U-24 Gamma
format keyword, U-107 keyword entry, U-119
fourth Gamma differencing, P-36
keyword entry, U-120, U-121 Gauss
fuel keyword, U-193 keyword entry, U-120
functionObjectLibs keyword, U-179 Gauss’s theorem, P-34
functions keyword, U-115, U-177 GaussSeidel
fvc class, P-34 keyword entry, U-125
fvc member function General window panel, U-174
curl, P-35 general
d2dt2, P-35 keyword entry, U-114
ddt, P-35 genericFvPatchField
div, P-35 library, U-99
gGrad, P-35 geometric-algebraic multi-grid, U-125
grad, P-35 GeometricBoundaryField template class, P-30
laplacian, P-35 geometricField<Type> template class, P-30
lsGrad, P-35 geometry keyword, U-150
snGrad, P-35 gGrad
snGradCorrection, P-35 fvc member function, P-35
sqrGradGrad, P-35 global tools, U-98
fvDOM gmshToFoam utility, U-91
library, U-101 gnuplot
FVFunctionObjects keyword entry, U-115, U-185
library, U-98 grad
fvm class, P-34 fvc member function, P-35
fvm member function (Grad Grad) squared, P-35
d2dt2, P-35 gradient, P-35, P-38
ddt, P-35 Gauss scheme, P-38
div, P-35 Gauss’s theorem, U-52
laplacian, P-35 least square fit, U-52
Su, P-35 least squares method, P-38, U-52
SuSp, P-35 surface normal, P-38
fvMatrices tools, U-98 gradSchemes keyword, U-116
fvMatrix template class, P-34 graph tools, U-98
fvMesh class, P-29 graphFormat keyword, U-115
fvMesh tools, U-98 GuldersEGRLaminarFlameSpeed model, U-101
fvMotionSolvers GuldersLaminarFlameSpeed model, U-101
library, U-99
fvSchemes H
dictionary, U-63, U-105, U-116 hConstThermo model, U-101
fvSchemes class, P-36 heheuPsiThermo model, U-100
fvSchemes heheuPsiThermo
menu entry, U-52 keyword entry, U-192
fvSolution Help menu, U-173
dictionary, U-105, U-123 hePsiThermo model, U-100
hePsiThermo
G keyword entry, U-192
g file, U-60 heRhoThermo model, U-100

OpenFOAM-3.0.1
Index P-81

heRhoThermo interPhaseChangeDyMFoam solver, U-87

keyword entry, U-192 interPhaseChangeFoam solver, U-87
HerschelBulkley model, U-104 interfaceProperties
hExponentialThermo library, U-104
library, U-102 interfaceProperties model, U-104
Hf keyword, U-193 interFoam solver, U-87
hierarchical interMixingFoam solver, U-87
keyword entry, U-82, U-83 internalField keyword, U-21, U-110
highCpCoeffs keyword, U-194 interpolation tools, U-98
homogenousDynOneEqEddy model, U-103, U-104 interpolationScheme keyword, U-185
homogenousDynSmagorinsky model, U-103 interpolations tools, U-98
homogeneousMixture model, U-100 interpolationSchemes keyword, U-116
homogeneousMixture keyword, U-193 inv
hPolynomialThermo model, U-101 tensor member function, P-23
iterations
I maximum, U-124
I
tensor member function, P-23 J
icoFoam solver, U-17, U-21, U-22, U-24, U-86 janafThermo model, U-101
icoPolynomial model, U-101, U-195 jobControl
icoUncoupledKinematicParcelFoam solver, U-89 library, U-98
ideasToFoam utility, U-159 jplot
ideasUnvToFoam utility, U-91 keyword entry, U-115, U-185
identities, see tensor, identities
identity, see tensor, identity K
incompressibleLESModels kEpsilon model, U-102, U-103
library, U-103 keyword
incompressiblePerfectGas model, U-101, U-195 As, U-193
incompressibleRASModels Cp, U-193
library, U-102 Cv, U-193
incompressibleTransportModels FoamFile, U-107
library, P-53, U-104 Hf, U-193
incompressibleTurbulenceModels LESModel, U-198
library, P-53 N2, U-193
index O2, U-193
notation, P-14, P-15 Pr, U-193
Information window panel, U-170 RASModel, U-198
inhomogeneousMixture model, U-100 Tcommon, U-194
inhomogeneousMixture keyword, U-193 Thigh, U-194
inlet Tlow, U-194
boundary condition, P-69 Ts, U-193
inletOutlet addLayersControls, U-150
boundary condition, U-139 adjustTimeStep, U-62, U-115
inner product, see tensor, inner product agglomerator, U-125
inotify arc, U-141
keyword entry, U-80 blocks, U-20, U-31, U-142
inotifyMaster block, U-141
keyword entry, U-80 boundaryField, U-21, U-110
inside boundary, U-145
keyword entry, U-154 boxToCell, U-60
insideCells utility, U-92 burntProducts, U-193

OpenFOAM-3.0.1
P-82 Index

cAlpha, U-63 interpolationScheme, U-185

cacheAgglomeration, U-126 laplacianSchemes, U-116
castellatedMeshControls, U-150 latestTime, U-39
castellatedMesh, U-150 layers, U-157
class, U-107 leastSquares, U-52
cloud, U-187 levels, U-154
commsType, U-80 libs, U-80, U-115
convertToMeters, U-141 locationInMesh, U-152, U-154
convertToMeters, U-140 location, U-107
curve, U-187 lowCpCoeffs, U-194
debug, U-150 manualCoeffs, U-83
defaultFieldValues, U-60 maxAlphaCo, U-62
deltaT, U-114 maxBoundarySkewness, U-158
delta, U-83, U-198 maxConcave, U-158
dimensions, U-21, U-110 maxCo, U-62, U-115
distributed, U-83, U-84 maxDeltaT, U-62
divSchemes, U-116 maxFaceThicknessRatio, U-157
doLayers, U-150 maxGlobalCells, U-152
edgeGrading, U-143 maxInternalSkewness, U-158
edges, U-141 maxIter, U-124
egrMixture, U-193 maxLocalCells, U-152
endTime, U-22, U-113, U-114 maxNonOrtho, U-158
energy, U-192, U-196 maxThicknessToMedialRatio, U-157
equationOfState, U-192 mergeLevels, U-126
errorReduction, U-158 mergePatchPairs, U-141
expansionRatio, U-157 mergeTolerance, U-150
face, U-187 meshQualityControls, U-150
featureAngle, U-157 method, U-83
features, U-152 midPointAndFace, U-187
fieldValues, U-60 midPoint, U-187
fields, U-185 minArea, U-158
fileModificationChecking, U-80 minDeterminant, U-158
fileModificationSkew, U-80 minFaceWeight, U-158
finalLayerThickness, U-157 minFlatness, U-158
firstTime, U-113 minMedianAxisAngle, U-157
floatTransfer, U-80 minRefinementCells, U-152
fluxRequired, U-116 minThickness, U-157
foamChemistryFile, U-193 minTriangleTwist, U-158
format, U-107 minTwist, U-158
fuel, U-193 minVolRatio, U-158
functionObjectLibs, U-179 minVol, U-158
functions, U-115, U-177 mixture, U-193
geometry, U-150 mode, U-154
gradSchemes, U-116 molWeight, U-196
graphFormat, U-115 multiComponentMixture, U-193
highCpCoeffs, U-194 mu, U-193
homogeneousMixture, U-193 nAlphaSubCycles, U-63
inhomogeneousMixture, U-193 nBufferCellsNoExtrude, U-157
internalField, U-21, U-110 nCellsBetweenLevels, U-152
interpolationSchemes, U-116 nFaces, U-132

OpenFOAM-3.0.1
Index P-83

nFinestSweeps, U-126 singleStepReactingMixture, U-193

nGrow, U-157 smoother, U-126
nLayerIter, U-157 snGradSchemes, U-116
nMoles, U-196 snapControls, U-150
nPostSweeps, U-126 snap, U-150
nPreSweeps, U-126 solvers, U-123
nRelaxIter, U-155, U-157 solver, U-53, U-123
nRelaxedIter, U-157 specie, U-196
nSmoothNormals, U-157 spline, U-141
nSmoothPatch, U-155 startFace, U-132
nSmoothScale, U-158 startFrom, U-22, U-113
nSmoothSurfaceNormals, U-157 startTime, U-22, U-113
nSmoothThickness, U-157 stopAt, U-113
nSolveIter, U-155 strategy, U-82, U-83
neighbourPatch, U-146 surfaceFormat, U-185
numberOfSubdomains, U-83 surfaces, U-185
nu, U-199 thermoType, U-191
n, U-83 thermodynamics, U-196
object, U-107 timeFormat, U-114
order, U-83 timePrecision, U-115
outputControl, U-179 timeScheme, U-116
oxidant, U-193 tolerance, U-53, U-124, U-155
pRefCell, U-23, U-128 topoSetSource, U-60
pRefValue, U-23, U-127 traction, U-51
p rhgRefCell, U-128 transport, U-192, U-196
p rhgRefValue, U-128 turbulence, U-198
patchMap, U-166 type, U-135, U-192
patches, U-141 uniform, U-187
preconditioner, U-124, U-125 valueFraction, U-138
pressure, U-51 value, U-21, U-138
printCoeffs, U-42, U-198 version, U-107
processorWeights, U-82 vertices, U-20, U-141
processorWeights, U-83 veryInhomogeneousMixture, U-193
purgeWrite, U-114 writeCompression, U-114
refGradient, U-138 writeControl, U-22, U-62, U-114
refinementRegions, U-152, U-154 writeFormat, U-55, U-114
refinementSurfaces, U-152, U-153 writeInterval, U-23, U-32, U-114
refinementRegions, U-154 writePrecision, U-114
regions, U-60 <LESModel>Coeffs, U-198
relTol, U-53, U-124 <RASModel>Coeffs, U-198
relativeSizes, U-157 <delta>Coeffs, U-198
relaxed, U-158 keyword entry
resolveFeatureAngle, U-152, U-153 BSpline, U-142
roots, U-83, U-84 CrankNicolson, U-122
runTimeModifiable, U-115 CrossPowerLaw, U-60
scotchCoeffs, U-83 DICGaussSeidel, U-125
setFormat, U-185 DIC, U-125
sets, U-185 DILU, U-125
simpleGrading, U-143 Euler, U-122
simulationType, U-41, U-61, U-197 FDIC, U-125

OpenFOAM-3.0.1
P-84 Index

GAMG, U-53, U-124, U-125 inotifyMaster, U-80

Gamma, U-119 inotify, U-80
GaussSeidel, U-125 inside, U-154
Gauss, U-120 jplot, U-115, U-185
LESModel, U-41 laminar, U-41, U-197
LES, U-41, U-197 latestTime, U-113
MGridGen, U-125 leastSquares, U-120
MUSCL, U-119 limitedCubic, U-119
Newtonian, U-60 limitedLinear, U-119
PBiCG, U-124 limited, U-120, U-121
PCG, U-124 linearUpwind, U-119, U-122
QUICK, U-122 linear, U-119, U-122
RASModel, U-41 line, U-142
RAS, U-41, U-197 localEuler, U-122
SFCD, U-119, U-122 manual, U-82, U-83
UMIST, U-117 metis, U-83
adjustableRunTime, U-62, U-114 midPoint, U-119
arc, U-142 nextWrite, U-114
ascii, U-114 noWriteNow, U-114
backward, U-122 nonBlocking, U-80
binary, U-114 none, U-117, U-125
blocking, U-80 null, U-185
bounded, U-120, U-121 outputTime, U-179
cellLimited, U-120 outside, U-154
cellPointFace, U-185 patch, U-137, U-186
cellPoint, U-185 polyLine, U-142
cell, U-185 processor, U-137
clockTime, U-114 pureMixture, U-193
compressed, U-114 raw, U-115, U-185
corrected, U-120, U-121 reactingMixture, U-193
cpuTime, U-114 runTime, U-32, U-114
cubicCorrected, U-122 scheduled, U-80
cubicCorrection, U-119 scientific, U-114
cyclic, U-137 scotch, U-82, U-83
diagonal, U-124, U-125 simple, U-82, U-83
distance, U-154, U-187 skewLinear, U-119, U-122
dx, U-185 smoothSolver, U-124
empty, U-137 spline, U-142
faceAreaPair, U-125 startTime, U-22, U-113
faceLimited, U-120 steadyState, U-122
filteredLinear2, U-119 stl, U-185
fixed, U-114 symmetryPlane, U-137
foamFile, U-185 timeStampMaster, U-80
fourth, U-120, U-121 timeStamp, U-80
general, U-114 timeStep, U-23, U-32, U-114, U-179
gnuplot, U-115, U-185 uncompressed, U-114
hePsiThermo, U-192 uncorrected, U-120, U-121
heRhoThermo, U-192 upwind, U-119, U-122
heheuPsiThermo, U-192 vanLeer, U-119
hierarchical, U-82, U-83 vtk, U-185

OpenFOAM-3.0.1
Index P-85

wall, U-137 library, U-103

wedge, U-137 LESModel
writeControl, U-114 keyword entry, U-41
writeInterval, U-179 LESModel keyword, U-198
writeNow, U-113 levels keyword, U-154
xmgr, U-115, U-185 libraries, U-69
xyz, U-187 library
x, U-187 Chung, U-101
y, U-187 FVFunctionObjects, U-98
z, U-187 LESdeltas, U-103
kivaToFoam utility, U-91 LESfilters, U-103
kkLOmega model, U-102 MGridGenGAMGAgglomeration, U-99
kOmega model, U-102 ODE, U-99
kOmegaSST model, U-102, U-103 OSspecific, U-99
kOmegaSSTSAS model, U-103 OpenFOAM, U-98
Kronecker delta, P-19 P1, U-101
PV4FoamReader, U-169
L SLGThermo, U-102
lagrangian
Wallis, U-101
library, U-99
autoMesh, U-99
lagrangianIntermediate
barotropicCompressibilityModels, U-101
library, U-99
basicSolidThermo, U-102
Lambda2 utility, U-94
basicThermophysicalModels, U-100
LamBremhorstKE model, U-102
laminar model, U-102, U-103 blockMesh, U-99
laminar chemistryModel, U-102
keyword entry, U-41, U-197 cloudFunctionObjects, U-98
laminarFlameSpeedModels coalCombustion, U-99
library, U-101 compressibleLESModels, U-104
laplaceFilter model, U-103 compressibleRASModels, U-103
Laplacian, P-36 conversion, U-99
laplacian, P-35 decompositionMethods, U-99
laplacian distributionModels, U-99
fvc member function, P-35 dsmc, U-99
fvm member function, P-35 dynamicFvMesh, U-99
laplacianFoam solver, U-86 dynamicMesh, U-99
laplacianSchemes keyword, U-116 edgeMesh, U-99
latestTime engine, U-99
keyword entry, U-113 fieldFunctionObjects, U-98
latestTime keyword, U-39 fileFormats, U-99
LaunderGibsonRSTM model, U-102, U-103 finiteVolume, U-98
LaunderSharmaKE model, U-102, U-103 foamCalcFunctions, U-98
layers keyword, U-157 forces, U-98
leastSquares fvDOM, U-101
keyword entry, U-120 fvMotionSolvers, U-99
leastSquares keyword, U-52 genericFvPatchField, U-99
LES hExponentialThermo, U-102
keyword entry, U-41, U-197 incompressibleLESModels, U-103
LESdeltas incompressibleRASModels, U-102
library, U-103 incompressibleTransportModels, P-53, U-104
LESfilters incompressibleTurbulenceModels, P-53

OpenFOAM-3.0.1
P-86 Index

interfaceProperties, U-104 limitedLinear

jobControl, U-98 keyword entry, U-119
lagrangianIntermediate, U-99 line
lagrangian, U-99 keyword entry, U-142
laminarFlameSpeedModels, U-101 Line Style menu, U-35
linear, U-101 linear
liquidMixtureProperties, U-102 library, U-101
liquidProperties, U-102 linear model, U-195
meshTools, U-99 linear
molecularMeasurements, U-99 keyword entry, U-119, U-122
molecule, U-99 linearUpwind
opaqueSolid, U-101 keyword entry, U-119, U-122
pairPatchAgglomeration, U-99 liquid
postCalc, U-98 electrically-conducting, P-67
potential, U-99 liquidMixtureProperties
primitive, P-21 library, U-102
radiationModels, U-100 liquidProperties
randomProcesses, U-99 library, U-102
reactionThermophysicalModels, U-100 lists, P-27
sampling, U-98 List<Type> template class, P-27
solidChemistryModel, U-102 localEuler
solidMixtureProperties, U-102 keyword entry, U-122
solidParticle, U-99 location keyword, U-107
solidProperties, U-102 locationInMesh keyword, U-152, U-154
solidSpecie, U-102 lowCpCoeffs keyword, U-194
solidThermo, U-102 lowReOneEqEddy model, U-104
specie, U-101 LRDDiffStress model, U-103
LRR model, U-102, U-103
spray, U-99
lsGrad
surfMesh, U-99
fvc member function, P-35
surfaceFilmModels, U-104
systemCall, U-99 M
thermophysicalFunctions, U-101 Mach utility, U-94
thermophysical, U-191 mag
topoChangerFvMesh, U-99 tensor member function, P-23
triSurface, U-99 magneticFoam solver, U-89
turbulence, U-99 magnetohydrodynamics, P-67
twoPhaseProperties, U-104 magSqr
utilityFunctionObjects, U-99 tensor member function, P-23
viewFactor, U-101 Make directory, U-73
vtkPV4Foam, U-169 make script/alias, U-71
libs keyword, U-80, U-115 Make/files file, U-75
lid-driven cavity flow, U-17 manual
LienCubicKE model, U-102 keyword entry, U-82, U-83
LienCubicKELowRe model, U-102 manualCoeffs keyword, U-83
LienLeschzinerLowRe model, U-102 mapFields utility, U-31, U-38, U-42, U-56, U-90,
Lights button, U-174 U-165
limited mapFieldsPar utility, U-90
keyword entry, U-120, U-121 mapping
limitedCubic fields, U-165
keyword entry, U-119 Marker Style menu, U-35

OpenFOAM-3.0.1
Index P-87

matrices tools, U-98 2-dimensional, U-133

max 2D, U-133
tensor member function, P-23 axi-symmetric, U-133
maxAlphaCo keyword, U-62 basic, P-29
maxBoundarySkewness keyword, U-158 block structured, U-140
maxCo keyword, U-62, U-115 decomposition, U-82
maxConcave keyword, U-158 description, U-129
maxDeltaT keyword, U-62 finite volume, P-29
maxDeltaxyz model, U-103 generation, U-140, U-149
maxFaceThicknessRatio keyword, U-157 grading, U-140, U-143
maxGlobalCells keyword, U-152 grading, example of, P-50
maximum iterations, U-124 non-orthogonal, P-43
maxInternalSkewness keyword, U-158 refinement, P-61
maxIter keyword, U-124 resolution, U-29
maxLocalCells keyword, U-152 specification, U-129
maxNonOrtho keyword, U-158 split-hex, U-149
maxThicknessToMedialRatio keyword, U-157 Stereolithography (STL), U-149
mdEquilibrationFoam solver, U-89 surface, U-149
mdFoam solver, U-89 validity constraints, U-129
mdInitialise utility, U-90 Mesh Parts window panel, U-24
mechanicalProperties meshes tools, U-98
dictionary, U-51 meshQualityControls keyword, U-150
memory tools, U-98 meshTools
menu library, U-99
Color By, U-173 message passing interface
Current Time Controls, U-25, U-171 openMPI, U-84
Edit, U-174 method keyword, U-83
Help, U-173 metis
Line Style, U-35 keyword entry, U-83
Marker Style, U-35 metisDecomp model, U-100
VCR Controls, U-25, U-171 MGridGenGAMGAgglomeration
View, U-170, U-173 library, U-99
menu entry MGridGen
Plot Over Line, U-34 keyword entry, U-125
Save Animation, U-175 mhdFoam solver, P-69, U-89
Save Screenshot, U-175 midPoint
Settings, U-174 keyword entry, U-119
Solid Color, U-173 midPoint keyword, U-187
Toolbars, U-173 midPointAndFace keyword, U-187
View Settings, U-24, U-173 min
Wireframe, U-173 tensor member function, P-23
fvSchemes, U-52 minArea keyword, U-158
mergeLevels keyword, U-126 minDeterminant keyword, U-158
mergeMeshes utility, U-92 minFaceWeight keyword, U-158
mergeOrSplitBaffles utility, U-92 minFlatness keyword, U-158
mergePatchPairs keyword, U-141 minMedianAxisAngle keyword, U-157
mergeTolerance keyword, U-150 MINMOD differencing, P-36
mesh minRefinementCells keyword, U-152
1-dimensional, U-133 minThickness keyword, U-157
1D, U-133 minTriangleTwist keyword, U-158

OpenFOAM-3.0.1
P-88 Index

minTwist keyword, U-158 eConstThermo, U-101

minVol keyword, U-158 egrMixture, U-100
minVolRatio keyword, U-158 hConstThermo, U-101
mirrorMesh utility, U-92 hPolynomialThermo, U-101
mixed hePsiThermo, U-100
boundary condition, U-138 heRhoThermo, U-100
mixedSmagorinsky model, U-103 heheuPsiThermo, U-100
mixture keyword, U-193 homogenousDynOneEqEddy, U-103, U-104
mixtureAdiabaticFlameT utility, U-97 homogenousDynSmagorinsky, U-103
mode keyword, U-154 homogeneousMixture, U-100
model icoPolynomial, U-101, U-195
APIfunctions, U-102 incompressiblePerfectGas, U-101, U-195
BirdCarreau, U-104 inhomogeneousMixture, U-100
CrossPowerLaw, U-104 interfaceProperties, U-104
DeardorffDiffStress, U-103, U-104 janafThermo, U-101
GuldersEGRLaminarFlameSpeed, U-101 kEpsilon, U-102, U-103
GuldersLaminarFlameSpeed, U-101 kOmegaSSTSAS, U-103
HerschelBulkley, U-104 kOmegaSST, U-102, U-103
LRDDiffStress, U-103 kOmega, U-102
LRR, U-102, U-103 kkLOmega, U-102
LamBremhorstKE, U-102 laminar, U-102, U-103
LaunderGibsonRSTM, U-102, U-103 laplaceFilter, U-103
LaunderSharmaKE, U-102, U-103 linear, U-195
LienCubicKELowRe, U-102 lowReOneEqEddy, U-104
LienCubicKE, U-102 maxDeltaxyz, U-103
LienLeschzinerLowRe, U-102 metisDecomp, U-100
NSRDSfunctions, U-102 mixedSmagorinsky, U-103
Newtonian, U-104 multiComponentMixture, U-100
NonlinearKEShih, U-102 multiphaseMixtureThermo, U-192
PengRobinsonGas, U-195 oneEqEddy, U-103, U-104
PrandtlDelta, U-103 perfectFluid, U-101, U-195
RNGkEpsilon, U-102, U-103 perfectGas, U-195
RaviPetersen, U-101 polynomialTransport, U-101
Smagorinsky2, U-103 powerLaw, U-104
Smagorinsky, U-103, U-104 psiReactionThermo, U-100, U-192
SpalartAllmarasDDES, U-104 psiThermo, U-192
SpalartAllmarasIDDES, U-104 psiuReactionThermo, U-100, U-192
SpalartAllmaras, U-102–U-104 ptsotchDecomp, U-100
adiabaticPerfectFluid, U-101, U-195 pureMixture, U-100
anisotropicFilter, U-103 qZeta, U-102
basicMultiComponentMixture, U-100 reactingMixture, U-100
chemistryModel, U-102 realizableKE, U-102, U-103
chemistrySolver, U-102 reconstruct, U-100
constTransport, U-101 rhoConst, U-101, U-195
constant, U-101 rhoReactionThermo, U-100, U-192
cubeRootVolDelta, U-103 rhoThermo, U-192
decompose, U-100 scaleSimilarity, U-103
distributed, U-100 scotchDecomp, U-100
dynLagrangian, U-103 simpleFilter, U-103
dynOneEqEddy, U-103 singleStepReactingMixture, U-100

OpenFOAM-3.0.1
Index P-89

smoothDelta, U-103 nGrow keyword, U-157

specieThermo, U-101 nLayerIter keyword, U-157
spectEddyVisc, U-103 nMoles keyword, U-196
sutherlandTransport, U-101 non-orthogonal mesh, P-43
v2f, U-103 nonBlocking
vanDriestDelta, U-104 keyword entry, U-80
veryInhomogeneousMixture, U-100 none
modifyMesh utility, U-93 keyword entry, U-117, U-125
molecularMeasurements NonlinearKEShih model, U-102
library, U-99 nonNewtonianIcoFoam solver, U-86
molecule noWriteNow
library, U-99 keyword entry, U-114
molWeight keyword, U-196 nPostSweeps keyword, U-126
moveDynamicMesh utility, U-92 nPreSweeps keyword, U-126
moveEngineMesh utility, U-92 nRelaxedIter keyword, U-157
moveMesh utility, U-92 nRelaxIter keyword, U-155, U-157
movingWallVelocity nSmoothNormals keyword, U-157
boundary condition, U-139 nSmoothPatch keyword, U-155
MPI nSmoothScale keyword, U-158
openMPI, U-84 nSmoothSurfaceNormals keyword, U-157
mshToFoam utility, U-91 nSmoothThickness keyword, U-157
mu keyword, U-193 nSolveIter keyword, U-155
multiComponentMixture model, U-100 NSRDSfunctions model, U-102
multiComponentMixture keyword, U-193 nu keyword, U-199
multigrid null
geometric-algebraic, U-125 keyword entry, U-185
multiphaseEulerFoam solver, U-87 numberOfSubdomains keyword, U-83
multiphaseInterFoam solver, U-87
multiphaseMixtureThermo model, U-192 O
MUSCL O2 keyword, U-193
keyword entry, U-119 object keyword, U-107
objToVTK utility, U-92
N ODE
n keyword, U-83 library, U-99
N2 keyword, U-193 oneEqEddy model, U-103, U-104
nabla Opacity text box, U-173
operator, P-25 opaqueSolid
nAlphaSubCycles keyword, U-63 library, U-101
nBufferCellsNoExtrude keyword, U-157 OpenFOAM
nCellsBetweenLevels keyword, U-152 applications, U-69
neighbour file format, U-106
dictionary, U-132 libraries, U-69
neighbourPatch keyword, U-146 OpenFOAM
netgenNeutralToFoam utility, U-91 library, U-98
Newtonian OpenFOAM file syntax
keyword entry, U-60 //, U-106
Newtonian model, U-104 openMPI
nextWrite message passing interface, U-84
keyword entry, U-114 MPI, U-84
nFaces keyword, U-132 operator
nFinestSweeps keyword, U-126 scalar, P-26

OpenFOAM-3.0.1
P-90 Index

vector, P-25 PDRFoam solver, U-88

Options window, U-174 PDRMesh utility, U-93
options file, U-73 Pe utility, U-94
order keyword, U-83 PengRobinsonGas model, U-195
Orientation Axes button, U-24 perfectFluid model, U-101, U-195
orientFaceZone utility, U-92 perfectGas model, U-195
OSspecific permutation symbol, P-18
library, U-99 pimpleFoam solver, U-86
outer product, see tensor, outer product Pipeline Browser window, U-24, U-170
outlet PISO
boundary condition, P-69 dictionary, U-23
outletInlet pisoFoam solver, U-17, U-86
boundary condition, U-139 Plot Over Line
outputControl keyword, U-179 menu entry, U-34
outputTime plot3dToFoam utility, U-91
keyword entry, U-179 pointField class, P-29
outside pointField<Type> template class, P-31
keyword entry, U-154 points
owner dictionary, U-131, U-140
dictionary, U-131 polyBoundaryMesh class, P-29
oxidant keyword, U-193 polyDualMesh utility, U-92
polyLine
P
keyword entry, U-142
p field, U-23
P1 polyMesh directory, U-105, U-131
library, U-101 polyMesh class, P-29, U-129, U-131
p rhgRefCell keyword, U-128 polynomialTransport model, U-101
p rhgRefValue keyword, U-128 polyPatch class, P-29
pairPatchAgglomeration polyPatchList class, P-29
library, U-99 post-processing, U-169
paraFoam, U-23, U-169 post-processing
parallel paraFoam, U-169
running, U-81 postCalc
Paramters window panel, U-171 library, U-98
partialSlip postChannel utility, U-95
boundary condition, U-139 potential
particleTracks utility, U-95 library, U-99
patch potentialFreeSurfaceFoam solver, U-87
boundary condition, U-136 potentialFoam solver, P-44, U-86
patch pow
keyword entry, U-137, U-186 tensor member function, P-23
patchAverage utility, U-94 powerLaw model, U-104
patches keyword, U-141 pPrime2 utility, U-94
patchIntegrate utility, U-94 Pr keyword, U-193
patchMap keyword, U-166 PrandtlDelta model, U-103
patchSummary utility, U-97 preconditioner keyword, U-124, U-125
PBiCG pRefCell keyword, U-23, U-128
keyword entry, U-124 pRefValue keyword, U-23, U-127
PCG pressure keyword, U-51
keyword entry, U-124 pressure waves
pdfPlot utility, U-95 in liquids, P-62

OpenFOAM-3.0.1
Index P-91

pressureDirectedInletVelocity RASModel
boundary condition, U-139 keyword entry, U-41
pressureInletVelocity RASModel keyword, U-198
boundary condition, U-139 RaviPetersen model, U-101
pressureOutlet raw
boundary condition, P-63 keyword entry, U-115, U-185
pressureTransmissive reactingEulerFoam solver, U-88
boundary condition, U-139 reactingFoam solver, U-88
primitive reactingMixture model, U-100
library, P-21 reactingMixture
primitives tools, U-98 keyword entry, U-193
printCoeffs keyword, U-42, U-198 reactingParcelFilmFoam solver, U-89
processorWeights keyword, U-82 reactingParcelFoam solver, U-89
probeLocations utility, U-95 reactionThermophysicalModels
process library, U-100
background, U-24, U-81 realizableKE model, U-102, U-103
foreground, U-24 reconstruct model, U-100
processor reconstructPar utility, U-85, U-97
boundary condition, U-138 reconstructParMesh utility, U-97
processor redistributePar utility, U-97
keyword entry, U-137 refGradient keyword, U-138
processorN directory, U-83 refineHexMesh utility, U-93
processorWeights keyword, U-83 refinementRegions keyword, U-154
Properties window, U-171, U-172 refinementLevel utility, U-93
Properties window panel, U-25, U-170 refinementRegions keyword, U-152, U-154
psiReactionThermo model, U-100, U-192 refinementSurfaces keyword, U-152, U-153
psiThermo model, U-192 refineMesh utility, U-92
psiuReactionThermo model, U-100, U-192 refineWallLayer utility, U-93
ptot utility, U-95 Refresh Times button, U-25, U-171
ptsotchDecomp model, U-100 regions keyword, U-60
pureMixture model, U-100 relative tolerance, U-124
pureMixture relativeSizes keyword, U-157
keyword entry, U-193 relaxed keyword, U-158
purgeWrite keyword, U-114 relTol keyword, U-53, U-124
PV4FoamReader removeFaces utility, U-93
library, U-169 Render View window, U-174
Q Render View window panel, U-173, U-174
Q utility, U-94 renumberMesh utility, U-92
QUICK Rescale to Data Range button, U-25
keyword entry, U-122 Reset button, U-170
qZeta model, U-102 resolveFeatureAngle keyword, U-152, U-153
restart, U-39
R Reynolds number, U-17, U-21
R utility, U-94 rhoPorousSimpleFoam solver, U-86
radiationModels rhoReactingBuoyantFoam solver, U-88
library, U-100 rhoCentralDyMFoam solver, U-86
randomProcesses rhoCentralFoam solver, U-86
library, U-99 rhoConst model, U-101, U-195
RAS rhoPimpleFoam solver, U-86
keyword entry, U-41, U-197 rhoReactingFoam solver, U-88

OpenFOAM-3.0.1
P-92 Index

rhoReactionThermo model, U-100, U-192 Seed window, U-175

rhoSimpleFoam solver, U-86 selectCells utility, U-93
rhoSimplecFoam solver, U-86 Set Ambient Color button, U-173
rhoThermo model, U-192 setFields utility, U-60, U-90
rmdepall script/alias, U-77 setFormat keyword, U-185
RNGkEpsilon model, U-102, U-103 sets keyword, U-185
roots keyword, U-83, U-84 setSet utility, U-92
rotateMesh utility, U-92 setsToZones utility, U-92
run Settings
parallel, U-81 menu entry, U-174
run directory, U-105 SFCD
runTime keyword entry, U-119, U-122
keyword entry, U-32, U-114 shallowWaterFoam solver, U-86
runTimeModifiable keyword, U-115 shape, U-143
SI units, U-110
S simple
sammToFoam utility, U-91
keyword entry, U-82, U-83
sample utility, U-95, U-184
simpleFilter model, U-103
sampling
simpleFoam solver, P-53, U-86
library, U-98
simpleGrading keyword, U-143
Save Animation
simulationType keyword, U-41, U-61, U-197
menu entry, U-175
singleCellMesh utility, U-92
Save Screenshot
singleStepReactingMixture model, U-100
menu entry, U-175
scalar, P-14 singleStepReactingMixture keyword, U-193
operator, P-26 skew
scalar class, P-22 tensor member function, P-23
scalarField class, P-27 skewLinear
scalarTransportFoam solver, U-86 keyword entry, U-119, U-122
scale SLGThermo
tensor member function, P-23 library, U-102
scalePoints utility, U-162 slice class, P-29
scaleSimilarity model, U-103 slip
scheduled boundary condition, U-139
keyword entry, U-80 Smagorinsky model, U-103, U-104
scientific Smagorinsky2 model, U-103
keyword entry, U-114 smapToFoam utility, U-93
scotch smoothDelta model, U-103
keyword entry, U-82, U-83 smoother keyword, U-126
scotchCoeffs keyword, U-83 smoothSolver
scotchDecomp model, U-100 keyword entry, U-124
script/alias snap keyword, U-150
find, U-179 snapControls keyword, U-150
foamCorrectVrt, U-164 snappyHexMesh utility
foamJob, U-188 background mesh, U-151
foamLog, U-188 cell removal, U-154
make, U-71 cell splitting, U-152
rmdepall, U-77 mesh layers, U-155
wclean, U-76 meshing process, U-149
wmake, U-71 snapping to surfaces, U-155
second time derivative, P-35 snappyHexMesh utility, U-91, U-149

OpenFOAM-3.0.1
Index P-93

snappyHexMeshDict file, U-150 fireFoam, U-88

snGrad icoFoam, U-17, U-21, U-22, U-24, U-86
fvc member function, P-35 icoUncoupledKinematicParcelFoam, U-89
snGradCorrection interFoam, U-87
fvc member function, P-35 interMixingFoam, U-87
snGradSchemes keyword, U-116 interPhaseChangeDyMFoam, U-87
Solid Color interPhaseChangeFoam, U-87
menu entry, U-173 laplacianFoam, U-86
solidChemistryModel magneticFoam, U-89
library, U-102 mdEquilibrationFoam, U-89
solidDisplacementFoam solver, U-89 mdFoam, U-89
solidDisplacementFoam solver, U-51 mhdFoam, P-69, U-89
solidEquilibriumDisplacementFoam solver, U-89 multiphaseEulerFoam, U-87
solidMixtureProperties multiphaseInterFoam, U-87
library, U-102 nonNewtonianIcoFoam, U-86
solidParticle pimpleFoam, U-86
library, U-99 pisoFoam, U-17, U-86
solidProperties potentialFoam, P-44, U-86
library, U-102 potentialFreeSurfaceFoam, U-87
solidSpecie reactingEulerFoam, U-88
library, U-102 reactingFoam, U-88
solidThermo reactingParcelFilmFoam, U-89
library, U-102 reactingParcelFoam, U-89
solver rhoCentralDyMFoam, U-86
DPMFoam, U-89 rhoCentralFoam, U-86
PDRFoam, U-88 rhoPimpleFoam, U-86
XiFoam, U-88 rhoReactingFoam, U-88
adjointShapeOptimizationFoam, U-86 rhoSimpleFoam, U-86
blockMesh, P-45 rhoSimplecFoam, U-86
boundaryFoam, U-86 rhoPorousSimpleFoam, U-86
buoyantBoussinesqPimpleFoam, U-88 rhoReactingBuoyantFoam, U-88
buoyantBoussinesqSimpleFoam, U-88 scalarTransportFoam, U-86
buoyantPimpleFoam, U-88 shallowWaterFoam, U-86
buoyantSimpleFoam, U-88 simpleFoam, P-53, U-86
cavitatingDyMFoam, U-87 solidDisplacementFoam, U-89
cavitatingFoam, U-87 solidDisplacementFoam, U-51
chemFoam, U-88 solidEquilibriumDisplacementFoam, U-89
chtMultiRegionFoam, U-88 sonicDyMFoam, U-86
chtMultiRegionSimpleFoam, U-88 sonicFoam, P-59, U-87
coalChemistryFoam, U-89 sonicLiquidFoam, P-63, U-87
coldEngineFoam, U-88 sprayFoam, U-89
compressibleInterDyMFoam, U-87 thermoFoam, U-88
compressibleInterFoam, U-87 twoLiquidMixingFoam, U-88
compressibleMultiphaseInterFoam, U-87 twoPhaseEulerFoam, U-88
dnsFoam, U-88 uncoupledKinematicParcelFoam, U-89
driftFluxFoam, U-87 solver keyword, U-53, U-123
dsmcFoam, U-89 solver relative tolerance, U-124
electrostaticFoam, U-89 solver tolerance, U-124
engineFoam, U-88 solvers keyword, U-123
financialFoam, U-90 sonicDyMFoam solver, U-86

OpenFOAM-3.0.1
P-94 Index

sonicFoam solver, P-59, U-87 summation convention, P-15

sonicLiquidFoam solver, P-63, U-87 SUPERBEE differencing, P-36
source, P-35 supersonic flow, P-58
SpalartAllmaras model, U-102–U-104 supersonic flow over forward step, P-58
SpalartAllmarasDDES model, U-104 supersonicFreeStream
SpalartAllmarasIDDES model, U-104 boundary condition, U-139
specie surfaceLambdaMuSmooth utility, U-96
library, U-101 surface mesh, U-149
specie keyword, U-196 surfaceAdd utility, U-95
specieThermo model, U-101 surfaceAutoPatch utility, U-95
spectEddyVisc model, U-103 surfaceBooleanFeatures utility, U-95
spline surfaceCheck utility, U-95
keyword entry, U-142 surfaceClean utility, U-95
spline keyword, U-141 surfaceCoarsen utility, U-95
splitCells utility, U-93 surfaceConvert utility, U-95
splitMesh utility, U-92 surfaceFeatureConvert utility, U-95
splitMeshRegions utility, U-92 surfaceFeatureExtract utility, U-95, U-153
spray surfaceField<Type> template class, P-31
library, U-99 surfaceFilmModels
sprayFoam solver, U-89 library, U-104
sqr surfaceFind utility, U-95
tensor member function, P-23 surfaceFormat keyword, U-185
sqrGradGrad surfaceHookUp utility, U-95
fvc member function, P-35 surfaceInertia utility, U-96
star3ToFoam utility, U-91 surfaceMesh tools, U-98
star4ToFoam utility, U-91 surfaceMeshConvert utility, U-96
startFace keyword, U-132 surfaceMeshConvertTesting utility, U-96
startFrom keyword, U-22, U-113 surfaceMeshExport utility, U-96
starToFoam utility, U-159 surfaceMeshImport utility, U-96
startTime surfaceMeshInfo utility, U-96
keyword entry, U-22, U-113 surfaceMeshTriangulate utility, U-96
startTime keyword, U-22, U-113 surfaceNormalFixedValue
steady flow boundary condition, U-139
turbulent, P-50 surfaceOrient utility, U-96
steadyParticleTracks utility, U-95 surfacePointMerge utility, U-96
steadyState surfaceRedistributePar utility, U-96
keyword entry, U-122 surfaceRefineRedGreen utility, U-96
Stereolithography (STL), U-149 surfaces keyword, U-185
stitchMesh utility, U-92 surfaceSplitByPatch utility, U-96
stl surfaceSplitByTopology utility, U-96
keyword entry, U-185 surfaceSplitNonManifolds utility, U-96
stopAt keyword, U-113 surfaceSubset utility, U-96
strategy keyword, U-82, U-83 surfaceToPatch utility, U-96
streamFunction utility, U-94 surfaceTransformPoints utility, U-96
stress analysis of plate with hole, U-46 surfMesh
stressComponents utility, U-94 library, U-99
Style window panel, U-173 SuSp
Su fvm member function, P-35
fvm member function, P-35 sutherlandTransport model, U-101
subsetMesh utility, U-93 symm

OpenFOAM-3.0.1
Index P-95

tensor member function, P-23 identities, P-19

symmetryPlane identity, P-19
boundary condition, P-63, U-137 inner product, P-16
symmetryPlane inverse, P-21
keyword entry, U-137 magnitude, P-18
symmTensorField class, P-27 magnitude squared, P-18
symmTensorThirdField class, P-27 mathematics, P-13
system directory, P-48, U-105 notation, P-15
systemCall nth power, P-18
library, U-99 outer product, P-17
rank, P-14
T rank 3, P-15
T()
scalar division, P-16
tensor member function, P-23
scalar multiplication, P-16
Tcommon keyword, U-194
scale function, P-18
template class
second rank, P-14
GeometricBoundaryField, P-30
skew, P-20
fvMatrix, P-34
square of, P-18
dimensioned<Type>, P-24
subtraction, P-16
FieldField<Type>, P-30
symmetric, P-20
Field<Type>, P-27
symmetric rank 2, P-14
geometricField<Type>, P-30
symmetric rank 3, P-15
List<Type>, P-27
trace, P-20
pointField<Type>, P-31
surfaceField<Type>, P-31 transformation, P-19
volField<Type>, P-31 transpose, P-14, P-20
temporal discretisation, P-40 triple inner product, P-17
Crank Nicolson, P-41 vector cross product, P-18
Euler implicit, P-40 tensor class, P-22
explicit, P-40 tensor member function
in OpenFOAM, P-41 *, P-23
temporalInterpolate utility, U-95 +, P-23
tensor, P-13 -, P-23
addition, P-16 /, P-23
algebraic operations, P-16 &, P-23
algebraic operations in OpenFOAM, P-22 &&, P-23
antisymmetric, see tensor, skew ^, P-23
calculus, P-25 cmptAv, P-23
classes in OpenFOAM, P-21 cofactors, P-23
cofactors, P-20 det, P-23
component average, P-18 dev, P-23
component maximum, P-18 diag, P-23
component minimum, P-18 I, P-23
determinant, P-20 inv, P-23
deviatoric, P-20 mag, P-23
diagonal, P-20 magSqr, P-23
dimension, P-14 max, P-23
double inner product, P-17 min, P-23
geometric transformation, P-19 pow, P-23
Hodge dual, P-21 scale, P-23
hydrostatic, P-20 skew, P-23

OpenFOAM-3.0.1
P-96 Index

sqr, P-23 dimensionedTypes, U-98

symm, P-23 fields, U-98
T(), P-23 finiteVolume, U-98
tr, P-23 fvMatrices, U-98
transform, P-23 fvMesh, U-98
tensorField class, P-27 global, U-98
tensorThirdField class, P-27 graph, U-98
tetgenToFoam utility, U-91 interpolations, U-98
text box interpolation, U-98
Opacity, U-173 matrices, U-98
thermalProperties memory, U-98
dictionary, U-51 meshes, U-98
thermodynamics keyword, U-196 primitives, U-98
thermoFoam solver, U-88 surfaceMesh, U-98
thermophysical volMesh, U-98
library, U-191 topoChangerFvMesh
thermophysicalFunctions library, U-99
library, U-101 topoSet utility, U-93
thermophysicalProperties topoSetSource keyword, U-60
dictionary, U-191 totalPressure
thermoType keyword, U-191 boundary condition, U-139
Thigh keyword, U-194 tr
time tensor member function, P-23
control, U-113 trace, see tensor, trace
time derivative, P-35 traction keyword, U-51
first, P-37 transform
second, P-35, P-37 tensor member function, P-23
time step, U-22 transformPoints utility, U-93
timeFormat keyword, U-114 transport keyword, U-192, U-196
timePrecision keyword, U-115 transportProperties
timeScheme keyword, U-116 dictionary, U-21, U-39, U-42, U-199
timeStamp transportProperties file, U-60
keyword entry, U-80 triple inner product, P-17
timeStampMaster triSurface
keyword entry, U-80 library, U-99
timeStep Ts keyword, U-193
keyword entry, U-23, U-32, U-114, U-179 turbulence
Tlow keyword, U-194 dissipation, U-40
tolerance kinetic energy, U-40
solver, U-124 length scale, U-41
solver relative, U-124 turbulence
tolerance keyword, U-53, U-124, U-155 library, U-99
Toolbars turbulence keyword, U-198
menu entry, U-173 turbulence model
tools RAS, U-40
algorithms, U-98 turbulenceProperties
cfdTools, U-98 dictionary, U-41, U-61, U-197
containers, U-98 turbulent flow
db, U-98 steady, P-50
dimensionSet, U-98 turbulentInlet

OpenFOAM-3.0.1
Index P-97

boundary condition, U-139 attachMesh, U-92

tutorials autoPatch, U-92
breaking of a dam, U-56 autoRefineMesh, U-93
lid-driven cavity flow, U-17 blockMesh, U-38, U-91, U-140
stress analysis of plate with hole, U-46 boxTurb, U-90
tutorials directory, P-43, U-17 cfx4ToFoam, U-91, U-159
twoLiquidMixingFoam solver, U-88 changeDictionary, U-90
twoPhaseEulerFoam solver, U-88 checkMesh, U-92, U-160
twoPhaseProperties chemkinToFoam, U-97
library, U-104 collapseEdges, U-93
type keyword, U-135, U-192 combinePatchFaces, U-93
createBaffles, U-92
U createPatch, U-92
U field, U-23
createTurbulenceFields, U-94
Ucomponents utility, P-70
createExternalCoupledPatchGeometry, U-90
UMIST
datToFoam, U-91
keyword entry, U-117
decomposePar, U-82, U-83, U-97
uncompressed
deformedGeom, U-92
keyword entry, U-114
dsmcFieldsCalc, U-95
uncorrected
dsmcInitialise, U-90
keyword entry, U-120, U-121
engineCompRatio, U-95
uncoupledKinematicParcelFoam solver, U-89
engineSwirl, U-90
uniform keyword, U-187
ensight74FoamExec, U-183
units
base, U-110 ensightFoamReader, U-93
of measurement, P-24, U-109 enstrophy, U-93
S.I. base, P-24 equilibriumCO, U-97
SI, U-110 equilibriumFlameT, U-97
Système International, U-110 execFlowFunctionObjects, U-95
United States Customary System, U-110 expandDictionary, U-97
USCS, U-110 extrude2DMesh, U-91
Update GUI button, U-171 extrudeMesh, U-91
uprime utility, U-94 extrudeToRegionMesh, U-91
upwind faceAgglomerate, U-90
keyword entry, U-119, U-122 flattenMesh, U-92
upwind differencing, P-36, U-63 flowType, U-93
USCS units, U-110 fluent3DMeshToFoam, U-91
Use Parallel Projection button, U-24 fluentMeshToFoam, U-91, U-159
utility foamCalc, U-33
Co, U-93 foamDataToFluent, U-93, U-181
Lambda2, U-94 foamDebugSwitches, U-97
Mach, U-94 foamFormatConvert, U-97
PDRMesh, U-93 foamHelp, U-97
Pe, U-94 foamInfoExec, U-97
Q, U-94 foamListTimes, U-95
R, U-94 foamMeshToFluent, U-91, U-181
Ucomponents, P-70 foamToEnsightParts, U-93
adiabaticFlameT, U-97 foamToEnsight, U-93
ansysToFoam, U-91 foamToGMV, U-93
applyBoundaryLayer, U-90 foamToStarMesh, U-91
applyWallFunctionBoundaryConditions, U-90 foamToSurface, U-91

OpenFOAM-3.0.1
P-98 Index

foamToTecplot360, U-93 renumberMesh, U-92

foamToTetDualMesh, U-93 rotateMesh, U-92
foamToVTK, U-93 sammToFoam, U-91
foamUpgradeCyclics, U-90 sample, U-95, U-184
foamUpgradeFvSolution, U-90 scalePoints, U-162
foamyHexMesh, U-91 selectCells, U-93
foamyQuadMesh, U-91 setFields, U-60, U-90
foamyHexMeshBackgroundMesh, U-91 setSet, U-92
foamyHexMeshSurfaceSimplify, U-91 setsToZones, U-92
gambitToFoam, U-91, U-159 singleCellMesh, U-92
gmshToFoam, U-91 smapToFoam, U-93
ideasToFoam, U-159 snappyHexMesh, U-91, U-149
ideasUnvToFoam, U-91 splitCells, U-93
insideCells, U-92 splitMeshRegions, U-92
kivaToFoam, U-91 splitMesh, U-92
mapFieldsPar, U-90 star3ToFoam, U-91
mapFields, U-31, U-38, U-42, U-56, U-90, star4ToFoam, U-91
U-165 starToFoam, U-159
mdInitialise, U-90 steadyParticleTracks, U-95
mergeMeshes, U-92 stitchMesh, U-92
mergeOrSplitBaffles, U-92 streamFunction, U-94
mirrorMesh, U-92 stressComponents, U-94
mixtureAdiabaticFlameT, U-97 subsetMesh, U-93
modifyMesh, U-93 surfaceLambdaMuSmooth, U-96
moveDynamicMesh, U-92 surfaceAdd, U-95
moveEngineMesh, U-92 surfaceAutoPatch, U-95
moveMesh, U-92 surfaceBooleanFeatures, U-95
mshToFoam, U-91 surfaceCheck, U-95
netgenNeutralToFoam, U-91 surfaceClean, U-95
objToVTK, U-92 surfaceCoarsen, U-95
orientFaceZone, U-92 surfaceConvert, U-95
pPrime2, U-94 surfaceFeatureConvert, U-95
particleTracks, U-95 surfaceFeatureExtract, U-95, U-153
patchAverage, U-94 surfaceFind, U-95
patchIntegrate, U-94 surfaceHookUp, U-95
patchSummary, U-97 surfaceInertia, U-96
pdfPlot, U-95 surfaceMeshConvertTesting, U-96
plot3dToFoam, U-91 surfaceMeshConvert, U-96
polyDualMesh, U-92 surfaceMeshExport, U-96
postChannel, U-95 surfaceMeshImport, U-96
probeLocations, U-95 surfaceMeshInfo, U-96
ptot, U-95 surfaceMeshTriangulate, U-96
reconstructParMesh, U-97 surfaceOrient, U-96
reconstructPar, U-85, U-97 surfacePointMerge, U-96
redistributePar, U-97 surfaceRedistributePar, U-96
refineHexMesh, U-93 surfaceRefineRedGreen, U-96
refineMesh, U-92 surfaceSplitByPatch, U-96
refineWallLayer, U-93 surfaceSplitByTopology, U-96
refinementLevel, U-93 surfaceSplitNonManifolds, U-96
removeFaces, U-93 surfaceSubset, U-96

OpenFOAM-3.0.1
Index P-99

surfaceToPatch, U-96 volMesh tools, U-98

surfaceTransformPoints, U-96 vorticity utility, U-94
temporalInterpolate, U-95 vtk
tetgenToFoam, U-91 keyword entry, U-185
topoSet, U-93 vtkPV4Foam
transformPoints, U-93 library, U-169
uprime, U-94 vtkUnstructuredToFoam utility, U-92
viewFactorsGen, U-90
vorticity, U-94 W
vtkUnstructuredToFoam, U-92 wall
wallFunctionTable, U-90 boundary condition, P-63, P-69, U-59, U-137
wallGradU, U-94 wall
wallHeatFlux, U-94 keyword entry, U-137
wallShearStress, U-94 wallFunctionTable utility, U-90
wdot, U-95 wallGradU utility, U-94
writeCellCentres, U-95 wallHeatFlux utility, U-94
writeMeshObj, U-92 Wallis
yPlus, U-94 library, U-101
zipUpMesh, U-93 wallShearStress utility, U-94
utilityFunctionObjects wclean script/alias, U-76
library, U-99 wdot utility, U-95
wedge
V boundary condition, U-133, U-137, U-148
v2f model, U-103 wedge
value keyword, U-21, U-138 keyword entry, U-137
valueFraction keyword, U-138 window
van Leer differencing, P-36 Color Legend, U-29
vanDriestDelta model, U-104 Options, U-174
vanLeer Pipeline Browser, U-24, U-170
keyword entry, U-119 Properties, U-171, U-172
VCR Controls menu, U-25, U-171 Render View, U-174
vector, P-14 Seed, U-175
operator, P-25 window panel
unit, P-18 Animations, U-174
vector class, P-22, U-109 Annotation, U-24
vector product, see tensor, vector cross product Charts, U-174
vectorField class, P-27 Color Legend, U-173
version keyword, U-107 Color Scale, U-173
vertices keyword, U-20, U-141 Colors, U-174
veryInhomogeneousMixture model, U-100 Display, U-24, U-25, U-170, U-172
veryInhomogeneousMixture keyword, U-193 General, U-174
View menu, U-170, U-173 Information, U-170
View Render window panel, U-24 Mesh Parts, U-24
View Settings Paramters, U-171
menu entry, U-24, U-173 Properties, U-25, U-170
viewFactor Render View, U-173, U-174
library, U-101 Style, U-173
viewFactorsGen utility, U-90 View Render, U-24
viscosity Wireframe
kinematic, U-22, U-42 menu entry, U-173
volField<Type> template class, P-31 WM ARCH

OpenFOAM-3.0.1
P-100 Index

environment variable, U-76 word class, P-24, P-29

WM ARCH OPTION writeCellCentres utility, U-95
environment variable, U-76 writeCompression keyword, U-114
WM COMPILE OPTION writeControl
environment variable, U-76 keyword entry, U-114
WM COMPILER writeControl keyword, U-22, U-62, U-114
environment variable, U-76 writeFormat keyword, U-55, U-114
WM COMPILER BIN writeInterval
environment variable, U-76 keyword entry, U-179
WM COMPILER DIR writeInterval keyword, U-23, U-32, U-114
environment variable, U-76 writeMeshObj utility, U-92
WM COMPILER LIB writeNow
environment variable, U-76 keyword entry, U-113
WM DIR writePrecision keyword, U-114
environment variable, U-76
WM MPLIB X
environment variable, U-76 x
WM OPTIONS keyword entry, U-187
environment variable, U-76 XiFoam solver, U-88
WM PRECISION OPTION xmgr
environment variable, U-76 keyword entry, U-115, U-185
WM PROJECT xyz
keyword entry, U-187
environment variable, U-76
WM PROJECT DIR Y
environment variable, U-76 y
WM PROJECT INST DIR keyword entry, U-187
environment variable, U-76 yPlus utility, U-94
WM PROJECT USER DIR
environment variable, U-76 Z
WM PROJECT VERSION z
environment variable, U-76 keyword entry, U-187
wmake zeroGradient
platforms, U-73 boundary condition, U-138
wmake script/alias, U-71 zipUpMesh utility, U-93

OpenFOAM-3.0.1