Documentation

TYPHON solution format

GRESSIER Jérémie — 2011-09-11T14:00:00Z

Typhon solution format uses CFDTOOLS XBIN format. As Typhon format, it needs a TYPHON header which defines the number of expected mesh and solution. The mesh should be defined (see mesh definition) or linked to another mesh file. Each following solution is written with a set of XBIN sections:

solution header

number of elements
number of scalars
number of vectors
number of face sections
number of cell marks sections
number of face marks sections

a set of scalar sections

scalar id
scalar array

a set of vector sections

vector id
(3 components) vector array

TYPHON mesh format

GRESSIER Jérémie — 2011-09-11T13:30:00Z

Typhon mesh format uses CFDTOOLS XBIN format. As Typhon format, it needs a TYPHON header which defines the number of expected mesh and solution. For each mesh, a ordered set of XBIN data sections is needed:

mesh header

mesh type (currently only unstructured mesh)
number of cells, faces and nodes
number of cell sections
number of face sections
number of cell marks sections
number of face marks sections

a set of cell sections

size etc

a set of face sections

size etc

node coordinates section

(number of nodes) x (3 coordinates)

a set of cell marks sections

mark name
indirect ordered array of face index in face sections

a set of face marks sections

mark name
indirect ordered array of face index in face sections

TYPHON internal formats

GRESSIER Jérémie — 2011-09-11T13:00:00Z

Typhon internal formats use CFDTOOLS XBIN format. It can be used for mesh and/or solutions. All Typhon formats start with a XBIN section (name is FILE_HEADER) which defines

Typhon format version number
Typhon type of file (mesh, solution, monitor...)
number of meshes
number of solutions

If this file only has meshes, it is considered as a mesh file and is described in this article.

If there are solutions, it must contain meshes too. The structure of such Typhon solution files is detailed in this article.

Versions

version 2: shared mesh

add cell marks in mesh
mesh definition tag in typhon header (full, shared, shared connectivity)

version 3: spectral solutions (rev742)

number of degree of freedom (dof) per cell
solution structure tag

XBIN open format

GRESSIER Jérémie — 2011-09-11T12:00:00Z

A XBIN file starts with a header. It is then followed by an undertermined number of data sections up to the end of file.

Header

In order to check the file format, one must find a header defined as follows:

4 (1-byte) characters 'XBIN'
a big endian 2-byte integer of XBIN version number
a 4-byte integer to check endianness (1234)

Data sections

Data sections are composed by

a data header
data arrays
a 3-byte end of section ('END' string)

Data header

A data header defines the data section. It includes

a data section name
XBIN data type
user defined type
real and integer size
a set of (integer) parameters
dimensions of data arrays (if needed)
external string (if needed)

Data arrays

There can be defined as

no data section
ordered or indirect ordered arrays
with integers or floating point reals

If ordered, only minimum and maximum indexes are given, otherwise, the data section starts with an array of index indirection. It is then followed by the data itself.

Moving Reference Frame

GRESSIER Jérémie — 2011-02-17T21:30:00Z

Since r713, it is possible to define a Moving Reference Frame (MRF) attached to the mesh. Equations are solved with the MRF velocities. External forces are modeled according to the MRF definition.

The MRF definition is done with a specific BLOCK:MRF definition.

The current MRF type are

`ROTATION`

BLOCK:MRF
 NAME = my_rotation ! optional
 TYPE = ROTATION
 CENTER = ( 5., 2., 0.) ! default is ( 0., 0., 0.)
 AXIS = ( 0., 0., 1.) ! default
 OMEGA_RPM = 600. ! 600 round per minute ~ 62.8 rad/s
 ENDBLOCK

`OSCILLATING_ROTATION`

BLOCK:MRF
 NAME = my_rotation ! optional
 TYPE = OSCILLATING_ROTATION
 CENTER = ( 5., 2., 0.) ! default is ( 0., 0., 0.)
 AXIS = ( 0., 0., 1.) ! default
 OMEGA_RPM = 600. ! 600 round per minute ~ 62.8 rad/s (default is 0)
 OSC_ANGLE = 10. ! max angle deviation (degree)
 OSC_PERIOD = .01 ! oscillating period (second)
 ENDBLOCK

Boundary conditions : compressible flow

GRESSIER Jérémie — 2011-02-09T12:00:00Z

Some parameters denoted symbolic function can be defined as symbolic functions which can depend on x, y, z and sometimes t.

Wall conditions

For compressible flows, wall conditions can be applied according to the type

`ADIABATIC_WALL`

wall condition with adiabatic energy condition

`ISOTHERMAL_WALL`

An additional WALL_TEMP= is required as an uniform imposed temperature.

`FLUXSET_WALL`

An additional WALL_FLUX= is required as an uniform imposed flux (W/m2).

For each of them, a WALL_VELOCITY= can be defined.

Inflow conditions

There are currently two types of in-flow boundary conditions

Subsonic inflow

BLOCK:BOCO
 FAMILY = my_mesh_tag
 TYPE = SUBSONIC_INLET
 PI = 
 TI =  or S = 
 DIR_X= 
 DIR_Y= 
 DIR_Z= 
 ENDBLOCK

Supersonic inflow

BLOCK:BOCO
 FAMILY = my_mesh_tag
 TYPE = SUPERSONIC_INLET
 PI =  ! (total or stagnation pressure)
 TI =  ! (total or stagnation temperature)
 MACH= 
 DIR_X= 
 DIR_Y= 
 DIR_Z= 
 ENDBLOCK

Entropy S is defined by PS/RHO^gamma

Direction of velocity can also be defined directly with

DIRECTION = (nx, ny, nz) ! 3 components

but only as constant components instead of DIR_* symbolic functions.

Outflow conditions

Like inflow conditions, there are currently two types of out-flow boundary conditions

Subsonic outflow

BLOCK:BOCO
 FAMILY = my_mesh_tag
 TYPE = SUBSONIC_OUTLET
 P =  ! (static pressure)
 ENDBLOCK

Supersonic outflow

Although no user parameter is applied, the following definition must be specified.

BLOCK:BOCO
 FAMILY = my_mesh_tag
 TYPE = SUPERSONIC_OUTLET
 ENDBLOCK

Mesh import

GRESSIER Jérémie — 2010-05-28T15:00:00Z

Typhon can import

CGNS files (legacy mesh import, see CGNS import for further details).
TYPHON internal format from a mesh file (.tym) or a solution (.tys)

In main.rpm parameter file, one can specify

BLOCK:MESH
 FORMAT = CGNS or TYPHON
 FILE = "my_mesh.cgns"

ENDBLOCK

One can specify some options :

SCALE = in order to scale all coordinates of the mesh
coordinates can be modified through a set a symbolic function (see mesh deformation)
MORPH_X =
MORPH_Y =
MORPH_Z =
SPLIT = ISO-TRI | SVM* for isotropic refinement of triangles or SVM-like splitting (see SVM article). For ISO-TRI, one can apply the refinement recursively with NSPLIT = (default : 1)

Initialization : compressible flow

GRESSIER Jérémie — 2009-09-03T20:30:00Z

Initial conditions for compressible flow solver is defined in BLOCK:INIT section. One can use

the solution is the CGNS mesh file with TYPE=CGNS
the solution is TYPHON internal format with TYPE=TYPHON or TYPE=TYS
or user-defined fields (default) with TYPE=DEFINITION where symbolic functions of X,Y,Z can be used.

Example (Lamb vortex definition) :

BLOCK:INIT
 P = 1.E5 - 1.161*900/2*exp(1-(X*X+Y*Y)/4)
 TI = 300
 VX = 20-30*Y/2*exp(0.5*(1-(X*X+Y*Y)/4))
 VY = 30*X/2*exp(0.5*(1-(X*X+Y*Y)/4))
 VZ = 0.
 ENDBLOCK

Combinations of quantities could be

static or stagnation pressure P, PI
density, static or stagnation temperature DENSITY, T, TI
velocity as
- components VX, VY, VZ
- Velocity magnitude and direction VELOCITY, DIRECTION
- Mach magnitude and direction MACH, DIRECTION

Download

GRESSIER Jérémie, GRONDIN Gilles — 2009-08-29T15:00:00Z

There are several ways to obtain Typhon sources:

you can use subversion to get an up-to-date updatable development release:
svn checkout http://svn.code.sf.net/p/typhon/code/trunk typhon-code /path/to/my/typhon
you can use subversion to get an up-to-date development release:
svn export http://svn.code.sf.net/p/typhon/code/trunk typhon-code/path/to/my/typhon

Release versions of Typhon sources are also available, but may be older versions:

some Typhon releases are available as .tar.gz packages on the sourceforge download page
you can obtain more releases with some test-cases using subversion:
svn export https://typhon.svn.sourceforge.net/svnroot/typhon/tags/rel-n0-n1-n2 /path/to/my/typhon
where n0-n1-n2 is the release number (available on this release list page)

According to the version you want to install and use, you will need third-party libraries (e.g. mpi if needed, cgns, metis).

You will then have to configure and build Typhon.

Probes

GRESSIER Jérémie — 2009-06-19T09:00:00Z

Probes definitions are used to compute a scalar value from the solution. It only currently can compute a user-defined quantity from internal cells at each end of cycle.

Probes are defined in main.rpm with the following syntax [1] :

BLOCK:PROBE
 NAME = m_probe_name
 TYPE = VOL_MIN | VOL_MAX | VOL_AVERAGE
 QUANTITY = 
 ENDBLOCK

In the symbolic function, allowed variables are

X, Y, Z
RHO, PS, V (magnitude), V_X, V_Y, V_Z for Navier-Stokes solver
TS (temperature) for Heat transfer solver

Each output is written in m_probe_name.tmon file.

[1] available in r664