Code Contents

Introduction for new users

• Installation How to install MPI-AMRVAC.
• Getting Started How to run your first test problem.
• Features An overview of the main features of MPI-AMRVAC.
• Acknowledgments Information on collaboration and financial support.
• FAQ Frequently asked questions.
• Tests An overview of documented test cases.
• MPI-AMRVAC 3.0 Demo simulations
• Contributing to MPI-AMRVAC and its documentation
• Documentation How the documentation works.

General

• Equations The equations and parameters in physics modules.
• User files How to create a new problem, specify initial conditions and customize functionalities.
• Parameters Description of all parameters in "amrvac.par" parameter file.
• Auxiliary variables Description of the intended use for nw, nwflux, nwaux, nwextra, nwauxio parameters.
• Command line Help on command-line parameters.
• Examples Description of various example simulations for which parameter files and user modules have been provided.

Discretization methods and AMR strategy

• Discretization The equation and its discretization, the basic variables, the structure of the grid, boundaries, ghost cells.
• Time Discretization The way the time integration works.
• Methods Properties of the discretization methods like TVDLF, TVDMU, TVD, HLL...
• Slope limiters Slope limiters for reconstruction to suppress spurious numerical oscillations
• AMR aspects Some essential info on global parameters and the data structures for the block-tree AMR.
• Using polar/cylindrical/spherical coordinates Some information on simulations using non-Cartesian grids.
• Small Values Info on positivity fixes for (M)HD runs.

Additional Physics

• Thermal conduction Description of solving thermal conduction.
• Radiative cooling Description of adding radiative cooling.
• Pressure less fluids (dust) Getting started with the dust module.
• Test particles in (M)HD Description of test particle tracing routines.
• Reaction-diffusion equations Getting started with the reaction-diffusion module.
• Advection-Reaction-diffusion equations Using the advection-reaction-diffusion module.
• Two-fluid equations Getting started with the two-fluid module.
• CAK radiation force Getting started with the CAK force for line-driven wind outflows.
• Rotating frame Solve governing equations in a rotating frame of reference.
• Adding a new physics module Description of how to add your own physics module.

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.
• Compilation Info on compilation, debugging and adding libraries.

IO and data analysis

• File format Description of the format of MPI-AMRVAC data file (.dat).
• Visualisation and analysis in Python with yt without data conversion.
• Converting data files for visualization Brief notes on how to convert to Tecplot (.plt), and VTK (.vtu) data files.
• Slices How to output hypersurfaces (slices) for restart or visualization.
• Line of sight views How to output collapsed views for visualisation and analysis (e.g. column densities).
• Analysis routine Using the run-time analysis routine.
• 3D Printing A note on how to generate 3D printed results.
• Yt visualization The recommended yt usage for visualization.