HyperCurvedWave Documentation

Quick run instructions ( for cshrc shell ):

tar -zxf had.tar.gz

cd had

Modify .ENV_local

source .ENV_local

make

cd bin

hcw idcw

Visualize the AMR data in DataVault:

sdftodv -n phi *d4phi.sdf

Explanation:

The HyperCurvedWave example solves the standard wave equation and includes vertex centered parallel AMR capability. It's purpose is to facilitate learning how to use HAD.

All HAD applications are a combination of three source elements:

the F77 AMR driver -- found in directory "had/src/amr"
hyper -- found in directory "had/src/hyper"
the user-defined code.
In this case, the user-defined code is HyperCurvedWave, which is found in directory "had/src/hyperCurvedWave".

The philosophy behind this is that the user supplies boundary conditions, the right hand sides of the equations for solving, the initial data, any analysis to be performed during an evolution, and a refinement criteria ( if not using the shadow hierarchy ); the integration, derivatives, dissipation, and mesh refinement are managed by the AMR driver and HYPER. Below is a table of how the hyperCurvedWave example is set up:

**Routines provided in amr, hyper, and the User-Defined code (UDC)**
File name	Routine Description/Name	Language	amr "the driver"	hyper "the interface"	UDC "the user code"
amr/setup	List of parameters specific to amr	list	X
main.f	Main routine	F77	X
comm_mpi.f	MPI communication and load balancing	F77	X
util.f	Interpolation routines	F77	X
grid.f	SDF output / grid_output_sdf	F77	X
main.f	Checkpointing / readstate	F77	X
level.f	Clustering algorithm	F77	X
comp_amr_error.f	User defined refinement criteria	F77	X		X
grid_ell.f	Multigrid residual calculation	F77	X		X
hyper/setup	List of parameters specific to hyper	list		X
charboundary.f90	Implementation of characteristic boundaries	F90		X
hyperdissipation.f90	dissipation routines	F90		X
hyperfilereader.f90	SDF read routines	F90		X
rk3.f90	RK3 integrator	F90		X
rk3tvd.f90	TVD RK3 integrator for vertex centered variables	F90		X
rk3tvd_fv.f90	TVD RK3 integrator for cell centered variables	F90		X
hyperboundary.f90	Boundary conditions	F90		X	X
hyperauxvars.f90	Defines auxiliary variables	F90		X	X
mask.f90	Excision routines	F90		X
derivs??_.f90	The Strand derivative routines with excision support	F90		X
hyperCurvedWave/setup	List of parameters specific to hyperCurvedWave	list			X
rhs.f90	The right hand side of the wave equation	F90			X
def_initial.f90	The initial data for the hyperCurvedWave	F90			X
boundary.f90	The boundary conditions for hyperCurvedWave	F90		X	X
global_auxvars.f90	Define auxiliary variables	F90		X	X
charvars.f90	The characteristic variables for hyperCurvedWave	F90			X
comp_amr_error.f	User defined refinement criteria	F77	X		X
grid_ell.f	Multigrid residual calculation	F77	X		X
analysis.f90	Analysis to be performed after each iteration	F90			X

An 'X' in multiple columns indicates an overloaded operation.

Files comp_amr_error.f and grid_ell.f are defined in hyperCurvedWave and then copied into "had/scr/amr" at compile time. Files boundary.f90 and global_auxvars.f90 are linked to hyperboundary.f90 and hyperauxvars.f90 in "had/scr/hyper" at runtime.