FronTier Structure

util

The util-directory is basic to the whole code, and contains among many other things:

• Definitions for Make: make.defs, make.master, and makefile.
  Containing among others a simple way to compile FronTier for double precision.
• Basic Definitions: cdecs.h
• FronTier's own debugger: debug.c
• Memory Allocation routines: vmalloc.[hc]
• Clean Up: cleanup.c
• Clock
• Parallel Communications: ppsub.c
• Main header files:
  • cdecs.h: main definitions of macro's used throughout FronTier (TRUE, EXPORT, IMPORT, LOCAL, etc.)
  • vmalloc.h: macros for memory allocation (vector, etc.)
  • uprotos.h: function prototypes

This directory is assumed in the rest of the code.
Note: The util directory has its own makefile and is always compiled seperately from the main physics code

driver

The driver-directory contains the high level routines for running FronTier.

• Initialization: dinit.c
• Printout: dprt.c
• Statistics: dstat.c
• Parallel Communications Driver: dscatter.c
• Main time step routine: dmain.c
• Main Header Files:
  • ddecs.h : structures for driver
  • dprotos.h: function prototypes.

intfc

The intfc-directory contains definitions of the geometry of the interface, INTERFACE, and geometry manipulation routines.

• Main header files:
  • int.h: main definitions of interface structure
  • userint.h: main definition of I_USER_INTERFACE
  • iprotos.h: function prototypes

front

The front-directory defines the FRONT: a geometric interface with states. Important files are:

• fadv.c: which defines how the front be advanced
• fprop*d.c, fnode*.c: which defines generic ways for the propagation of points, and curves, and nodes.
• fredist*d.c: which defines routines for the manipulation of the geometry of the front, generally intended to make the triangulation more evenly sized, though the objects of constant dimension.
• funtan*d.c: which defines routines for making a consistent front out of one with self intersections
• Main header files:
  • fdecs.h: main definitions of FRONT structure
  • fuserint.h: main definition of F_USER_INTERFACE
  • fprotos.h: function prototypes

hyp

The hyp-directory defines generic routines for the solution of hyperbolic equations, and defines the WAVE, which consists of a FRONT, and STATES in the components complimentary to front. Detailed information as to what a state is not available in WAVE, except how one can manipulate them, for certain solvers. The main routines:

• hdriver.c: hyperbolic equation solver driver.
  At the moment the code supports two non trivial kinds of hyperbolic equation solvers: split (used for gas dynamics), unsplit (used for reservoir dynamics)
• hsoln.c: which defines generic ways of using the WAVE structure to define the solution (for instance through interpolation) pointwise.
• hmv.c: which contains routines for making the solvers conservative.
• Main header files:
  • hdecs.h: main definitions of WAVE structure
  • hprotos.h: function prototypes

tri

The tri-directory contains definitions for the TRI_GRID and routines for its construction. The TRI_GRID is used for the storage of states in the components complimentary to the front. Currently we support a number of number of different such constructions. The most recent one is a mix of bilinear elements, rectangular blocks, away from the front, and linear elements (simplices) adjacent to the front. The WAVE structure uses the TRI_GRID structure for its interior states.
As a result tri is of lower level than hyp.

ellip

The ellip-directory consists of elliptic and parabolic equation solvers. It assumes only: util, driver, intfc, and front.

physics

The existing physics directories go by their names:

• gas (g): gas-dynamics
• res (r): oil and groundwater reservoirs
• solid (s): solid mechanics
• hj (hj): Hamilton Jacobi equations

If you look for "main", you will find it in the physics directory:

	FronTier/src/physics/physics-main.c
	

An example gas-main.

Initialization (options, interface, states, etc) is done in the (physics)init directory.
Most of the actual details: problem definition, specific solvers, riemann solvers, and diagnostic options are found in this physics directory.
Important files and subdirectories:

• make-(physics).defs
• make-(physics).libs
• (physics)-main.c
• in : for input files
• out: for output files
• HOSTTYPE (for instance: sun4, mips, i686, i686.mpich,paragon, paragon.nx, paragon.mpi) which contains the executable program, called (physics).
  HOSTTYPE is set in your environment. It is very important to understand that a code compiled for an sgi machine (mips) anything else.
• PHYSdecs: contains most macro's and structures defined in the PHYSICS directory, whose use is not limited to one subdirectory.

pak

In the pak-directory one finds packages from the outside, which are used in various places in the code. These packages go by their standard names, and we do not (or can not) make any changes to them. Since these packages are therefore static nobody actually has them in their own copy of FronTier, but rather links to compiled libraries.

HOSTTYPE

In the directory libs/HOSTTYPE (HOSTTYPE an architecture name, for instance sun4, mips, i686, i686.mpich,paragon, paragon.nx, or paragon.mpi), the compiled libraries wind up, either through the make process, or because you put compiled libraries in there directly or through symbolic links.

Back to Main Page

Copyright 1997 This article may be redistributed to other individuals for noncommercial use, provided that the entire text, all HTML codes, and this copyright notice remains intact and unaltered in any way. This article may not be resold, reprinted, or redistributed in whole or in part for compensation of any kind without prior written permission of the author.