CONTENTS OF THE MPI-AMRVAC MANUAL

This table of contents lists all the manual pages.
This page: [Introduction] [General] [Discretization and AMR material] [Parameters] [Source] [Data Files] [Visualization]

Introduction for New Users

Welcome
Basic information on the project.
Acknowledgments
Information on collaboration and financial support.
Features
An overview of the main features of the Message Passing Interface - Adaptive Mesh Refinement - Versatile Advection Code.
Installation
A brief instruction on how to install the Message Passing Interface - Adaptive Mesh Refinement - Versatile Advection Code.

General

Usage
How to make and run amrvac on your (parallel) platform, and how to do convert your data for visualization of results.
Command line
Help on command-line parameters.
Examples
Description of various example simulations for which parameter files and AMRVACUSR modules have been provided.
Equations
The equations and parameters in the existing AMRVACPHYS modules. How to create a new AMRVACPHYS module.
AMRVACUSR Module
How to create new "src/usr/amrvacusr.t.PROBLEM" and "src/usr/amrvacusrpar.t.PROBLEM" files for special initial conditions, boundary types, and source terms, etc.

Discretization and AMR related matter

Discretization
The equation and its discretization, the basic variables, the structure of the grid, boundaries, ghost cells.
Using polar/cylindrical/spherical coordinates
Some information on simulations using non-Cartesian grids, and notes on axial versus translational symmetry.
Methods
Properties of the discretization methods like TVDLF, TVDMU, TVD, HLL, ...
AMR aspects
Some essential info on global parameters and the data structures for the block-tree AMR.

Parameters

Parameters for AMRVAC
Description of the "par/PROBLEM" parameter files for MPI-AMRVAC.
Auxiliary variables for MPI-AMRVAC
Description of the intended use for nw, nwflux, nwaux, nwextra, nwauxio parameters.

Source Code

Source
Description of the dimension independent source language, which is translated to F90 by the VACPP preprocessor.
Variable Names
How variable names are formed in the source files.
VACPP
Making and running the VACPP preprocessor itself.

Data File format

File format
Description of the MPI-AMRVAC data file format *.dat.

Slice output

Slices
How to output hypersurfaces (slices) for restart or visualization.

Visualization

Converting data files for visualization
Brief notes on how to convert to IDL, DX (openDX), Native Tecplot (*.plt), and VTK (*.vtu) data files (the latter for paraview visualization).