AMROC Main     Blockstructured Adaptive Mesh Refinement in object-oriented C++

Main Page   Class Hierarchy   Compound List   File List  

ClpFunctions2.h File Reference

Interface-header to Clawpack functions and AMR routines in Fortran. More...

Go to the source code of this file.

Defines

#define f_initial   FORTRAN_NAME(ic_, IC, ic)
 Problem-dependent: Implements initial-conditions. More...

#define f_init_common   FORTRAN_NAME(combl_, COMBL, combl)
 Problem-dependent: Initialize user-defined common blocks. More...

#define f_boundary   FORTRAN_NAME(physbd_, PHYSBD, physbd)
 Problem-dependent: Implements boundary-conditions. More...

#define SOURCE_PARAMETER_LIST
#define f_source   FORTRAN_NAME(src_, SRC, src)
 Problem-dependent: Implements source term for a fractional-step method. More...

#define SETAUX_PARAMETER_LIST
#define f_setaux   FORTRAN_NAME(setaux_, SETAUX, setaux)
 Problem-dependent: Set values in auxiliary array. More...

#define NORMAL_FUNC_PARAMETER_LIST
#define TRANSVERSE_FUNC_PARAMETER_LIST
#define CHECK_FUNC_PARAMETER_LIST
#define f_step   FORTRAN_NAME(step2_, STEP2, step2)
 The main solution routine. More...

#define f_init_rcommon   FORTRAN_NAME(rcombl_, RCOMBL, rcombl)
#define f_restrict_amr   FORTRAN_NAME(restrict2_, RESTRICT2, restrict2)
#define f_prolong_amr   FORTRAN_NAME(prolong2_, PROLONG2, prolong2)
#define f_init_opcommon   FORTRAN_NAME(opcombl_, OPCOMBL, opcombl)
#define f_rcflx   FORTRAN_NAME(rcflx_, RCFLX, rcflx)

Typedefs

typedef void(* source_func_type )(const INTEGER &maxmx, const INTEGER &maxmy, const INTEGER &meqn, const INTEGER &mbc, const INTEGER &ibx, const INTEGER &iby, const INTEGER &mx, const INTEGER &my, Vector_type q[], const DOUBLE aux[], const INTEGER &maux, const DOUBLE &t, const DOUBLE &dt, const INTEGER &ibnd)
typedef void(* setaux_func_type )(const INTEGER &maxmx, const INTEGER &maxmy, const INTEGER &meqn, const INTEGER &mbc, const INTEGER &ibx, const INTEGER &iby, const INTEGER &mx, const INTEGER &my, Vector_type q[], DOUBLE aux[], const INTEGER &maux, const DOUBLE &cornx, const DOUBLE &corny, const DOUBLE &dx, const DOUBLE &dy, const DOUBLE &t, const DOUBLE &dt)
typedef void(* normal_func_type )(const INTEGER &ixyz, const INTEGER &maxm, const INTEGER &meqn, const INTEGER &mwaves, const INTEGER &mbc, const INTEGER &mx, const DOUBLE ql[], const DOUBLE qr[], const INTEGER &maux, const DOUBLE auxl[], const DOUBLE auxr[], DOUBLE wave[], DOUBLE s[], DOUBLE amdq[], DOUBLE apdq[])
typedef void(* transverse_func_type )(const INTEGER &ixyz, const INTEGER &maxm, const INTEGER &meqn, const INTEGER &mwaves, const INTEGER &mbc, const INTEGER &mx, const DOUBLE ql[], const DOUBLE qr[], const INTEGER &maux, const DOUBLE aux1[], const DOUBLE aux2[], const DOUBLE aux3[], const INTEGER &imp, DOUBLE asdq[], DOUBLE amdq[], DOUBLE apdq[])

Functions

void FORTRAN_NAME (ic_, IC, ic)(const INTEGER &maxmx, const INTEGER &maxmy, const INTEGER &meqn, const INTEGER &mbc, const INTEGER &mx, const INTEGER &my, const DOUBLE x[], const DOUBLE y[], const DOUBLE &dx, const DOUBLE &dy, Vector_type q[])
void FORTRAN_NAME (combl_, COMBL, combl)()
void FORTRAN_NAME (physbd_, PHYSBD, physbd)(FI(2, Vector_type), BI, const DOUBLE *, const DOUBLE *, const INTEGER *, const DOUBLE *, const INTEGER *, const DOUBLE *, char *, const INTEGER *)
void FORTRAN_NAME (src_, SRC, src)(const INTEGER &maxmx, const INTEGER &maxmy, const INTEGER &meqn, const INTEGER &mbc, const INTEGER &ibx, const INTEGER &iby, const INTEGER &mx, const INTEGER &my, Vector_type q[], const DOUBLE aux[], const INTEGER &maux, const DOUBLE &t, const DOUBLE &dt, const INTEGER &ibnd)
void FORTRAN_NAME (rcombl_, RCOMBL, rcombl)(const DOUBLE &t, const DOUBLE &dt, const DOUBLE &dx, const DOUBLE &dy, const INTEGER &mpass)
void FORTRAN_NAME (restrict2_, RESTRICT2, restrict2)(FI(2, Vector_type), FI(2, Vector_type), BI, char *, INTEGER *)
void FORTRAN_NAME (prolong2_, PROLONG2, prolong2)(FI(2, Vector_type), FI(2, Vector_type), BI, char *, INTEGER *)
void FORTRAN_NAME (opcombl_, OPCOMBL, opcombl)(const INTEGER &gc)

Detailed Description

Interface-header to Clawpack functions and AMR routines in Fortran.

Author:
Ralf Deiterding
Version:
1.0
Date:
Jan-2002

Definition in file ClpFunctions2.h.

Define Documentation

#define CHECK_FUNC_PARAMETER_LIST
 

Value:

( \
   FI(2,Vector_type), BI, const INTEGER& meqn, INTEGER& result )

Definition at line 147 of file ClpFunctions2.h.

#define f_boundary   FORTRAN_NAME(physbd_, PHYSBD, physbd)
 

Problem-dependent: Implements boundary-conditions.

Parameters:
u.  Array of VectorType. The data.
mx, my  integer. Size of data array.
lb  integer[2]. Lower bound of data in index coordinates.
ub  integer[2]. Upper bound of data in index coordinates.
lbbnd  integer[2]. Lower bound of boundary region in index coordinates.
ubbnd  integer[2]. Upper bound of boundary region in index coordinates.
shapebnd  integer[2]. Shape of boundary region.
xc  double[2]. Geometric information of lower left corner of data.
dx  double[2]. Cell size.
dir  integer. Side of data grid of actual boundary.
bnd  double array. Geometric information of mb boundary regions.
mb  integer[mb][2][2]. Number of boundary regions. The first one is the geometry of the global grid. mb-1 internal boundary regions follow.
time  double. Actual time.
args  char[]. Auxiliary array for passing additional information. Used for number of components.
argc  integer. Number of entries in auxiliary array args.

Definition at line 60 of file ClpFunctions2.h.

#define f_init_common   FORTRAN_NAME(combl_, COMBL, combl)
 

Problem-dependent: Initialize user-defined common blocks.

Returns:
void.

Definition at line 36 of file ClpFunctions2.h.

#define f_initial   FORTRAN_NAME(ic_, IC, ic)
 

Problem-dependent: Implements initial-conditions.

Parameters:
maxmx, maxmy  integer. Size of data array.
meqn  integer. Number of components in VectorType.
mbc  integer. Ghost cell width.
mx, my  integer. Size of data array used for computation.
x, y  double array.
dx, dy  double.
q.  Array of VectorType.
Returns:
void.

Definition at line 22 of file ClpFunctions2.h.

#define f_setaux   FORTRAN_NAME(setaux_, SETAUX, setaux)
 

Problem-dependent: Set values in auxiliary array.

Parameters:
maxmx, maxmy  integer. Size of data array.
meqn  integer. Number of components in VectorType.
mbc  integer. Ghost cell width.
ibx, iby  integer. Consider ghost cells (0/1) when dimensioning the data array.
mx, my  integer.
q.  Array of VectorType.
aux  double array. Auxiliary data.
maux  integer. Number of components in aux array.
cornx, corny  double. Geometric coordinates of lower left corner.
dx, dy  double. Cell size.
t  double. Actual time.
dt  double. Actual time-step.
Returns:
void.

Definition at line 124 of file ClpFunctions2.h.

#define f_source   FORTRAN_NAME(src_, SRC, src)
 

Problem-dependent: Implements source term for a fractional-step method.

Parameters:
maxmx, maxmy  integer. Size of data array.
meqn  integer. Number of components in VectorType.
mbc  integer. Ghost cell width.
ibx, iby  integer. Consider ghost cells (0/1) for dimensioning the data array.
mx, my  integer.
q.  Array of VectorType.
aux  double array. Auxiliary data.
maux  integer. Number of components in aux array.
t  double. Actual time.
dt  double. Actual time-step.
ibnd  integer[2]. Skip the update of ghost cells (0/1).
Returns:
void.

Definition at line 92 of file ClpFunctions2.h.

#define f_step   FORTRAN_NAME(step2_, STEP2, step2)
 

The main solution routine.

Parameters:
maxm.  max(maxmx, maxmy)
maxmx, maxmy  integer. Size of data array.
mvar  integer. Number of components really used in Riemann solver.
meqn  integer. Number of components in VectorType.
maux  integer. Number of auxiliary components.
mwaves  integer. Number of waves used in Riemann solver.
mbc  integer. Ghost cell width.
mx, my  integer. Size of data array used for computation.
qold  array of VectorType. On input: The data of the old time-step. On Output: The updated data.
aux  double array. The auxiliary data.
dx, dy  double. Size of cell.
dt  Size of time-step.
method  integer[7] array. Defines the numerical method.
mthlim  integer[mwaves] array. Choice of limiters.
cfl  double. Returns the CFL-number.
fm, fp, gm, gp  arrays of VectorType. Returns the fluctuations or fluxes.
q1d, dtdx1d, dtdy1d, aux1, aux2, aux3, work  double arrays passed to solution routine and Riemann solver.
mwork  integer. Size of work.
rpn  function of normal_func_type. Riemann solver in normal direction.
rpt  function of transverse_func_type. Riemann solver in transverse direction.
Returns:
void.

Definition at line 174 of file ClpFunctions2.h.

#define NORMAL_FUNC_PARAMETER_LIST
 

Value:

( \
   const INTEGER& ixyz, const INTEGER& maxm, const INTEGER& meqn, \
   const INTEGER& mwaves, const INTEGER& mbc, const INTEGER& mx, \
   const DOUBLE ql[], const DOUBLE qr[], \
   const INTEGER& maux, const DOUBLE auxl[], const DOUBLE auxr[], \
   DOUBLE wave[], DOUBLE s[], \
   DOUBLE amdq[], DOUBLE apdq[] )

Definition at line 129 of file ClpFunctions2.h.

#define SETAUX_PARAMETER_LIST
 

Value:

( \
   const INTEGER& maxmx, const INTEGER& maxmy, \
   const INTEGER& meqn, const INTEGER& mbc, \
   const INTEGER& ibx, const INTEGER& iby, \
   const INTEGER& mx, const INTEGER& my, Vector_type q[], \
   DOUBLE aux[], const INTEGER& maux, \
   const DOUBLE& cornx, const DOUBLE& corny, \
   const DOUBLE& dx, const DOUBLE& dy, \
   const DOUBLE& t, const DOUBLE& dt)

Definition at line 97 of file ClpFunctions2.h.

#define SOURCE_PARAMETER_LIST
 

Value:

( \
   const INTEGER& maxmx, const INTEGER& maxmy, \
   const INTEGER& meqn, const INTEGER& mbc, \
   const INTEGER& ibx, const INTEGER& iby, \
   const INTEGER& mx, const INTEGER& my, Vector_type q[], \
   const DOUBLE aux[], const INTEGER& maux, \
   const DOUBLE& t, const DOUBLE& dt, const INTEGER& ibnd)

Definition at line 68 of file ClpFunctions2.h.

#define TRANSVERSE_FUNC_PARAMETER_LIST
 

Value:

( \
   const INTEGER& ixyz, const INTEGER& maxm, const INTEGER& meqn, \
   const INTEGER& mwaves, const INTEGER& mbc, const INTEGER& mx, \
   const DOUBLE ql[], const DOUBLE qr[], \
   const INTEGER& maux, const DOUBLE aux1[], const DOUBLE aux2[], \
   const DOUBLE aux3[], const INTEGER& imp, \
   DOUBLE asdq[], DOUBLE amdq[], DOUBLE apdq[] )

Definition at line 138 of file ClpFunctions2.h.

Quickstart     Users Guide     Programmers Reference     Installation      Examples     Download


AMROC Main      Home      Contact
last update: 06/01/04