Modules List

Here is a list of all modules with brief descriptions:

[detail level 12]

►Mm_octree_mg_1d
Cmg_bc_t
Cmg_box_gsrb	Subroutine that performs Gauss-Seidel relaxation
Cmg_box_op	Subroutine that performs A * cc(..., i_in) = cc(..., i_out)
Cmg_box_prolong	Subroutine that performs prolongation to a single child
Cmg_box_t	Box data structure
Cmg_buf_t	Buffer type (one is used for each pair of communicating processes)
Cmg_comm_t
Cmg_lvl_t	Lists of blocks per refinement level
Cmg_subr_bc	To fill ghost cells near physical boundaries
Cmg_subr_rb	To fill ghost cells near refinement boundaries
Cmg_t
Cmg_timer_t
Cmrgrnk
►Mm_octree_mg_2d
Cmg_bc_t
Cmg_box_gsrb	Subroutine that performs Gauss-Seidel relaxation
Cmg_box_op	Subroutine that performs A * cc(..., i_in) = cc(..., i_out)
Cmg_box_prolong	Subroutine that performs prolongation to a single child
Cmg_box_t	Box data structure
Cmg_buf_t	Buffer type (one is used for each pair of communicating processes)
Cmg_comm_t
Cmg_lvl_t	Lists of blocks per refinement level
Cmg_subr_bc	To fill ghost cells near physical boundaries
Cmg_subr_rb	To fill ghost cells near refinement boundaries
Cmg_t
Cmg_timer_t
Cmrgrnk
►Mm_octree_mg_3d
Cmg_bc_t
Cmg_box_gsrb	Subroutine that performs Gauss-Seidel relaxation
Cmg_box_op	Subroutine that performs A * cc(..., i_in) = cc(..., i_out)
Cmg_box_prolong	Subroutine that performs prolongation to a single child
Cmg_box_t	Box data structure
Cmg_buf_t	Buffer type (one is used for each pair of communicating processes)
Cmg_comm_t
Cmg_lvl_t	Lists of blocks per refinement level
Cmg_subr_bc	To fill ghost cells near physical boundaries
Cmg_subr_rb	To fill ghost cells near refinement boundaries
Cmg_t
Cmg_timer_t
Cmrgrnk
Mmod_advance	Module containing all the time stepping schemes
Mmod_amr_fct
Mmod_amr_grid
Mmod_amr_neighbors
Mmod_amr_solution_node
Mmod_amrvac	This module contains modules that users could want to have in their mod_usr.t code, so that they don't have to include them individually
Mmod_ard	Module activating the advection-reaction-diffusion equation module
Mmod_ard_phys	Module containing the physics routines for advection-reaction-diffusion equations
Mmod_b0
Mmod_basic_types	Module with basic data types used in amrvac
Mmod_bc_data	Module to set boundary conditions from user data
Mmod_boundary_conditions
Mmod_bremsstrahlung
Mmod_cak_force	Module to include CAK radiation line force in (magneto)hydrodynamic models Computes both the force from free electrons and the force from an ensemble of lines (various possibilities for the latter). There is an option to only simulate the pure radial CAK force (with various corrections applied) as well as the full vector CAK force. Depending on the chosen option additional output are the CAK line force component(s) and, when doing a 1-D radial force, the finite disc factor
Mmod_cak_opacity	This module reads in CAK line opacities in the Gayley (1995) notation (alpha, Qbar, Q0, kappae) from corresponding tables. Tabulated values assume LTE conditions and are a function of mass density (D) and temperature (T), which are both given in base 10 logarithm. The construction of the tables is outlined in Poniatowski+ (2021), A&A, 667
Mmod_calculate_xw	Handles computations for coordinates and variables in output
Mmod_coarsen
Mmod_coarsen_refine	Module to coarsen and refine grids for AMR
Mmod_collapse	Collapses D-dimensional output to D-1 view by line-of-sight integration
Mmod_comm_lib
Mmod_con2prim_vars
►Mmod_config	Module that allows working with a configuration file
Ccfg_add	Interface to add variables to the configuration
Ccfg_add_get	Interface to get variables from the configuration
Ccfg_get	Interface to get variables from the configuration
Ccfg_t	The configuration that contains all the variables
Mmod_connectivity	This module contains variables that describe the connectivity of the mesh and also data structures for connectivity-related communication
Mmod_constants	Module for physical and numeric constants
Mmod_constrained_transport
►Mmod_convert
Cconvert_vars_method
Csub_convert_vars
Mmod_convert_files
Mmod_datacube
Mmod_dipole	Sets up a magnetic dipole in a 3D cartesian box
Mmod_dt
Mmod_dust	Module for including dust species, which interact with the gas through a drag force
Mmod_errest
Mmod_ffhd
Mmod_ffhd_phys	Frozen-field hydrodynamics module
Mmod_finite_difference	Module with finite difference methods for fluxes
Mmod_finite_volume	Module with finite volume methods for fluxes
Mmod_fix_conserve	Module for flux conservation near refinement boundaries
Mmod_fld	Module for flux limited diffusion (FLD)-approximation in Radiation-(Magneto)hydrodynamics simulations
►Mmod_forest	Module with basic grid data structures
Ctree_node	The data structure that contains information about a tree node/grid block
Ctree_node_ptr	Pointer to a tree_node
Mmod_functions_bfield
Mmod_functions_connectivity
Mmod_functions_forest
Mmod_geometry	Module with geometry-related routines (e.g., divergence, curl)
►Mmod_ghostcells_update	Update ghost cells of all blocks including physical boundaries
Cwbuffer
Mmod_global_parameters	This module contains definitions of global parameters and variables and some generic functions/subroutines used in AMRVAC
Mmod_gravity	Module for including gravity in (magneto)hydrodynamics simulations
Mmod_hd	Module containing all hydrodynamics
Mmod_hd_hllc	Hydrodynamics HLLC module
Mmod_hd_phys	Hydrodynamics physics module
Mmod_hd_roe	Module with Roe-type Riemann solver for hydrodynamics
Mmod_hyperdiffusivity	Subroutines for Roe-type Riemann solver for HD
Mmod_init_datafromfile	Module to set (or derive) initial conditions from user data We read in a vtk file that provides values on grid
Mmod_initialize	This module handles the initialization of various components of amrvac
Mmod_initialize_amr
Mmod_input_output	Module for reading input and writing output
Mmod_input_output_helper
Mmod_interpolation
Mmod_ionization_degree	Module ionization degree - get ionization degree for given temperature
Mmod_kdv	Module for including kdv source term in simulations adds \(-\delta^2*\sum_i \partial_{iii} \rho \) over dimensions i
Mmod_lfff	Program to extrapolate linear force-free fields in 3D Cartesian coordinates, based on exact Green function method (Chiu & Hilton 1977 ApJ 212,873)
Mmod_limiter	Module with slope/flux limiters
Mmod_load_balance
►Mmod_lookup_table	A Fortran 90 module for creating 1D and 2D lookup tables. These tables can be used to efficiently interpolate one or more values
Clt2_loc_t	Type to indicate a location in a 2D lookup table
Clt2_t	The 2D lookup table type
Clt3_loc_t	Type to indicate a location in a 3D lookup table
Clt3_t	The 3D lookup table type
Clt_loc_t	Type to indicate a location in the lookup table, which can be used to speed up multiple lookups of different columns
Clt_t	The lookup table type. There can be one or more columns, for which values can be looked up for a given 'x-coordinate'
Mmod_lu
Mmod_magnetofriction	Module mod_magnetofriction.t Purpose: use magnetofrictional method to relax 3D magnetic field to force-free field 01.04.2016 developed by Chun Xia and Yang Guo 04.10.2017 modulized by Chun Xia Usage: in amrvac.par: &methodlist time_stepper='onestep' ! time marching scheme, or 'twostep','threestep' flux_method=13*'cd4' ! or 'tvdlf', 'fd' limiter= 13*'koren' ! or 'vanleer','cada3','mp5' so on / &meshlist ditregrid=20 ! set iteration interval for adjusting AMR / &mhd_list mhd_magnetofriction=.true. / &mf_list mf_it_max=60000 ! set the maximum iteration number mf_ditsave=20000 ! set iteration interval for data output mf_cc=0.3 ! stability coefficient controls numerical stability mf_cy=0.2 ! frictional velocity coefficient mf_cdivb=0.01 ! divb cleaning coefficient controls diffusion speed of divb /
Mmod_mf
Mmod_mf_phys	Magnetofriction module
Mmod_mhd
Mmod_mhd_hllc
Mmod_mhd_phys	Magneto-hydrodynamics module
Mmod_mhd_roe	Subroutines for Roe-type Riemann solver for MHD
Mmod_mp5	Module containing the MP5 (fifth order) flux scheme
►Mmod_multigrid_coupling	Module to couple the octree-mg library to AMRVAC. This file uses the VACPP preprocessor, but its use is kept to a minimum
Cafter_new_tree
Mmod_nonlinear	Module activating the nonlinear scalar equation module allowing to solve Burgers, nonconvex, and KdV equations
Mmod_nonlinear_phys	Module containing the physics routines for scalar nonlinear equation
Mmod_nonlinear_roe	Module containing Roe solver for scalar nonlinear equation
Mmod_odeint	This module packages odeint from numerical recipes
Mmod_oneblock
Mmod_opal_opacity	This module reads in Rosseland-mean opacities from OPAL tables. Table opacity values are given in base 10 logarithm and are a function of mass density (R) and temperature (T), which are also both given in base 10 logarithm
Mmod_particle_advect	Tracer for advected particles moving with fluid flows By Jannis Teunissen, Bart Ripperda, Oliver Porth, and Fabio Bacchini (2017-2020)
►Mmod_particle_base	Module with shared functionality for all the particle movers
Cfun_destroy
Cparticle_ptr
Cparticle_t
Csub_define_additional_gridvars
Csub_fill_additional_gridvars
Csub_fill_gridvars
Csub_integrate
Mmod_particle_gca	Particle mover with Newtonian/relativistic Guiding Center Approximation (GCA) By Jannis Teunissen, Bart Ripperda, Oliver Porth, and Fabio Bacchini (2016-2020)
Mmod_particle_lorentz	Particle mover with Newtonian/relativistic Boris scheme for Lorentz dynamics By Jannis Teunissen, Bart Ripperda, Oliver Porth, and Fabio Bacchini (2016-2020)
Mmod_particle_sample	Scattered sampling based on fixed- or moving-particle interpolation By Fabio Bacchini (2020)
Mmod_particles	Module containing all the particle routines
Mmod_pfss	Module mod_pfss.t – potential field source surface model PURPOSE : to extrapolate global potential magnetic field of the sun from synoptic magnetograms 2013.11.04 Developed by S. Moschou and C. Xia 2014.04.01 Allow to change source surface (C. Xia) PRECONDITIONS:
►Mmod_physicaldata
Cct_velocity	Velocities store for constrained transport
Cgrid_field
Cstate
Cstate_sub
►Mmod_physics	This module defines the procedures of a physics module. It contains function pointers for the various supported routines. An actual physics module has to set these pointers to its implementation of these routines
Csub_add_source
Csub_add_source_geom
Csub_boundary_adjust
Csub_check_params
Csub_check_w
Csub_clean_divb	Clean initial divb
Csub_convert
Csub_evaluate_implicit
Csub_face_to_center
Csub_get_auxiliary
Csub_get_auxiliary_prim
Csub_get_cbounds
Csub_get_cmax
Csub_get_csrad2
Csub_get_ct_velocity
Csub_get_dt
Csub_get_flux
Csub_get_h_speed
Csub_get_pthermal
Csub_get_rfactor
Csub_get_rho
Csub_get_tcutoff
Csub_get_tgas
Csub_get_v
Csub_global_source	Add global source terms on complete domain (potentially implicit)
Csub_implicit_update
Csub_modify_wlr
Csub_set_equi_vars	Set equilibrium variables other than b0 (e.g. p0 and rho0)
Csub_set_mg_bounds
Csub_small_values
Csub_special_advance	Add special advance in each advect step
Csub_trac_after_setdt
Csub_update_faces
Csub_update_temperature
Csub_write_info
►Mmod_physics_hllc
Csub_diffuse_hllcd
Csub_get_lcd
Csub_get_wcd
Csub_hllc_init_species
►Mmod_physics_roe
Csub_average
Csub_get_eigenjump
Csub_rtimes
Mmod_point_searching
Mmod_ppm
►Mmod_radiative_cooling	Module radiative cooling – add optically thin radiative cooling
Cget_subr1
Crc_fluid
Mmod_radloss_tables	Module containing all optically thin radiative cooling tables
►Mmod_random	Module for pseudo random number generation. The internal pseudo random generator is the xoroshiro128plus method
Cprng_t	Parallel random number generator type
Crng_t	Random number generator type, which contains the state
Mmod_random_heating
Mmod_random_heating_3d
Mmod_rbsl	To get a RBSL magnetic flux rope in 3D (Titov 2018 ApJL 852, L21)
Mmod_rd	Module containing all routines for reaction-diffusion
Mmod_rd_phys	Reaction-diffusion module (physics routines)
Mmod_refine
Mmod_rho	Module containing all routines for scalar advection
Mmod_rho_phys	Module containing the physics routines for scalar advection
Mmod_rho_roe	Module containing Roe solver for scalar advection
Mmod_rotating_frame	Module for including rotating frame in (magneto)hydrodynamics simulations The rotation vector is assumed to be along z direction (both in cylindrical and spherical)
Mmod_selectgrids
Mmod_slice	Writes D-1 slice, can do so in various formats, depending on slice_type
Mmod_small_values	Module for handling problematic values in simulations, such as negative pressures
Mmod_solar_atmosphere	User can use subroutine get_atm_para to generate 1D solar stmosphere. User should provide heights (h), number density at h=0, number of points (nh), and the gravity (grav) at each point. User can select temperature profile. This subroutine will return density and pressure at each point
Mmod_source	Module for handling split source terms (split from the fluxes)
Mmod_space_filling_curve
Mmod_spline
Mmod_srhd	Module containing all special relativistic hydrodynamics (with EOS)
Mmod_srhd_phys	Special Relativistic Hydrodynamics (with EOS) physics module
Mmod_supertimestepping	Generic supertimestepping method which can be used for multiple source terms in the governing equations where each term introduces a sts_term type and all sts terms are stored in a pointer list
Mmod_tdfluxrope
►Mmod_thermal_conduction	Thermal conduction for HD and MHD or RHD and RMHD or twofl (plasma-neutral) module Adaptation of mod_thermal_conduction for the mod_supertimestepping
Cget_var_subr
Ctc_fluid
►Mmod_thermal_emission
Cget_subr1
Cte_fluid
Mmod_timing
Mmod_trac
Mmod_trace_field
Mmod_tvd	Subroutines for TVD-MUSCL schemes
Mmod_twofl
Mmod_twofl_hllc
Mmod_twofl_phys	Magneto-hydrodynamics module
Mmod_twofl_roe	Subroutines for Roe-type Riemann solver for HD
Mmod_usr	This is a template for a new user problem of mhd
►Mmod_usr_methods	Module with all the methods that users can customize in AMRVAC
Ca_refine_threshold	Use different threshold in special regions for AMR to reduce/increase resolution there where nothing/something interesting happens
Cadd_aux_names	Add names for the auxiliary variables
Cafter_refine
Caux_output	This subroutine can be used in convert, to add auxiliary variables to the converted output file, for further analysis using tecplot, paraview, .... these auxiliary values need to be stored in the nw+1:nw+nwauxio slots
Ccheck_particle	Check arbitrary particle conditions or modifications
Ccreate_particles	Create particles
Cflag_grid	Flag=-1 : Treat all cells active, omit deactivation (onentry, default) flag=0 : Treat as normal domain flag=1 : Treat as passive, but reduce by safety belt flag=2 : Always treat as passive
Cget_dt	Limit "dt" further if necessary, e.g. due to the special source terms. The getdt_courant (CFL condition) and the getdt subroutine in the AMRVACPHYS module have already been called
Chd_pthermal	Calculation anormal pressure for hd & energy=.False
Cinit_one_grid	Initialize one grid
Cinit_vector_potential	Initialize vector potential on cell edges for magnetic field
Cinternal_bc	Internal boundary, user defined This subroutine can be used to artificially overwrite ALL conservative variables in a user-selected region of the mesh, and thereby act as an internal boundary region. It is called just before external (ghost cell) boundary regions will be set by the BC selection. Here, you could e.g. want to introduce an extra variable (nwextra, to be distinguished from nwaux) which can be used to identify the internal boundary region location. Its effect should always be local as it acts on the mesh
Cp_no_args
Cparticle_analytic
Cparticle_fields	Associate fields to particle
Cparticle_position	User-defined particle movement
Cphys_dust_get_3d_dragforce	Calculate the 3d drag force of gas onto dust
Cphys_dust_get_dt	Calculate the time step associated with the usr drag force
Cphys_gravity	Calculate gravitational acceleration in each dimension
Cprocess_adv_global	For processing after the advance (PIC-MHD, e.g.)
Cprocess_adv_grid	For processing after the advance (PIC-MHD, e.g.)
Cprocess_global	This subroutine is called at the beginning of each time step by each processor. No communication is specified, so the user has to implement MPI routines if information has to be shared
Cprocess_grid	This subroutine is ONLY to be used for computing auxiliary variables which happen to be non-local (like div v), and are in no way used for flux computations. As auxiliaries, they are also not advanced
Crefine_grid	Enforce additional refinement or coarsening One can use the coordinate info in x and/or time qt=t_n and w(t_n) values w. you must set consistent values for integers refine/coarsen: refine = -1 enforce to not refine refine = 0 doesn't enforce anything refine = 1 enforce refinement coarsen = -1 enforce to not coarsen coarsen = 0 doesn't enforce anything coarsen = 1 enforce coarsen e.g. refine for negative first coordinate x < 0 as if (any(x(ix^S,1) < zero)) refine=1
Crfactor	Calculation R factor for ideal gas law with partial ionization
Cset_adiab	Set adiabatic index
Cset_b0	Here one can add a steady (time-independent) potential background field
Cset_electric_field
Cset_equi_vars	Here one can add a steady (time-independent) equi vars
Cset_field
Cset_field_w
Cset_j0	Here one can add a time-independent background current density
Cset_surface
Cset_viscosity	Calculation anormal viscosity depending on space
Cset_wlr	Allow user to specify 'variables' left and right state at physical boundaries to control flux through the boundary surface
Csource	Calculate w(iw)=w(iw)+qdt*SOURCE[wCT,qtC,x] within ixO for all indices iw=iwmin...iwmax. wCT is at time qCT
Cspecial_bc	Special boundary types, users must assign conservative variables in boundaries
Cspecial_convert	Allow user to use their own data-postprocessing procedures
Cspecial_diffcoef	Set user defined FLD diffusion coefficient
Cspecial_fluxlimiter	Set user defined FLD flux limiter, lambda
Cspecial_mg_bc	Special boundary type for radiation hydrodynamics module, only used to set the boundary conditions for the radiation energy
Cspecial_opacity	Set user defined opacity for use in diffusion coeff, heating and cooling, and radiation force
Cspecial_resistivity	Set the "eta" array for resistive MHD based on w or the "current" variable which has components between idirmin and 3
Csub_modify_io	If defined, this routine is called before writing output, and it can set/modify the variables in the w array
Ctransform_w	Adjust w when restart from dat file with different w variables
Cupdate_payload	Update payload of particles
Cvar_for_errest	This is the place to compute a local auxiliary variable to be used as refinement criterion for the Lohner error estimator only -->it is then requiring and iflag>nw note that ixO=ixI=ixG, hence the term local (gradients need special attention!)
Mmod_variables
Mmod_venk
Mmod_viscosity	The module add viscous source terms and check time step
Mmod_weno