=================================================================
StaRMAP
=================================================================
A second order staggered grid finite difference solver for linear
hyperbolic moment approximations to the equations of radiative
transfer in a 2D geometry.

Version 1.9
Copyright (c) 03/13/2014 Benjamin Seibold and Martin Frank
http://www.math.temple.edu/~seibold
http://www.mathcces.rwth-aachen.de/5people/frank/start
Contributers: Edgar Olbrant (v1.0), Kerstin Kuepper (v1.5)

StaRMAP project website:
http://math.temple.edu/~seibold/research/starmap/


=================================================================
Files
=================================================================
starmap_closure_pn.m        Creates P_N moment matrices
starmap_closure_spn.m       Creates SP_N moment matrices
starmap_create_beam.m       Creates file starmap_ex_beam_auto.m
 -> starmap_ex_beam_auto.m  Example file: beam in void and medium
starmap_create_hemisphere_filter_convergence.m
                            Creates file starmap_ex_hemisphere_
                            filter_convergence_auto.m
 -> starmap_ex_hemisphere_filter_convergence_auto.m
                            Example file: FPN convergence for
                            hemisphere test
starmap_create_mms.m        Creates file starmap_ex_mms_auto.m
 -> starmap_ex_mms_auto.m   Example file: manufactured solution
starmap_ex_boxes.m          Example file: boxes test case
starmap_ex_controlrod.m     Example file: control rod test
starmap_ex_gauss_filter_convergence.m
                            Example file: FPN convergence for
                            Gauss test
starmap_ex_lattice.m        Example file: lattice/checkerboard
                            test
starmap_ex_lattice_filter.m Example file: lattice/checkerboard
                            test with filtering
starmap_ex_lattice_filter_convergence.m
                            Example file: FPN convergence for
                            lattice/checkerboard test
starmap_ex_linesource.m     Example file: line source test
starmap_ex_linesource_filter.m
                            Example file: line source test with
                            filtering
starmap_ex_linesource_filter_reconstruction.m
                            Example file: line source test with
                            angular reconstruction in a point
starmap_ex_l2norm.m         Example file: l2norm of solution
starmap_solver.m            The computational code
ChangeLog.txt               Changes from previous versions
README.txt                  This file

=================================================================
Operation
=================================================================
To run a simulation with StaRMAP, the file starmap_solver.m
must be called with a struct par, in which the problem parameters
are defined. The meaning of most parameters can be seen in the
"Parameter Defaults" part in starmap_solver.m, in the provided
example files starmap_ex_*.m, and in the paper
http://arxiv.org/abs/1211.2205 .
Below explained is the syntax for the parameter functions that
define the problem. General philosophy: do not prescribe
parameters when not needed; for special cases (e.g.,
time-independence, isotropy) the code will run faster.
=================================================================

=================================================================
Syntax for functions (which parameters need to be provided)
=================================================================
Initial conditions: par.ic: (x,y) or (x,y,k)
 - If (x,y), then initial conditions are only nonzero for k=1
   (i.e., zeroth moment)

Absorption coefficient: sigma_a: (x,y) or (x,y,t)
 - If (x,y), the function is only evaluated once
   (in the first time step).

Isotropic scattering coefficient: par.sigma_s0: (x,y) or (x,y,t)
 - Zeroth moment of scattering kernel (i.e., isotropic part).
 - If (x,y), the function is only evaluated once.

Anisotropic scattering: par.sigma_sm: (x,y,m) or (x,y,m,t)
 - Higher moments of scattering kernel.
 - Evaluated for m>=1, where m = par.mom_order(k) moment order
   and k = system component.
 - Vector par.mom_order must exist if this function is specified.
 - If (x,y,m), the function is only evaluated once
   (in the first time step).

Source: par.source: (x,y,t) or (x,y,t,k)
 - If (x,y,t), then source only active for k=1
   (i.e., zeroth moment)
 - Via the vector par.source_ind one can prescribe in which
   moments the source term is active (only those will be
   evaluated).

Filter: par.filterfunction: (par,dt,k,x,y) or (par,dt,k,x,y,t)

- Multiplication factor for decay coefficients.

- Vector par.mom_order must exist if this function is specified.
- If (par,dt,k,x,y), the function is only evaluated once
  (in the first time step).
- Via par.f_position one can define if the filter is applied
  after each 'substep' or 'full' time-step ('' turns off the
  filer).
=================================================================