MPI-AMRVAC 3.2
The MPI - Adaptive Mesh Refinement - Versatile Advection Code (development version)
Loading...
Searching...
No Matches
Data Types | Functions/Subroutines | Variables
mod_magnetic_helicity Module Reference

Finite-volume relative magnetic helicity on a uniform Cartesian mesh. More...

Data Types

type  magnetic_helicity_config
 
type  magnetic_helicity_result
 

Functions/Subroutines

subroutine, public mh_params_read (files)
 
subroutine, public mh_run_task ()
 
subroutine, public compute_magnetic_helicity_fv (config, result)
 

Variables

character(len=mh_name_len), public mh_output_file =''
 
integer, public mh_gauge_axis =3
 
double precision, public mh_mg_tolerance =1.d-4
 
integer, public mh_mg_max_cycles =50
 
double precision, public mh_max_flux_imbalance =1.d-6
 
logical, public mh_write_debug_vti =.false.
 
logical, public mh_write_mg_timing =.false.
 
character(len=mh_name_len), public mh_debug_vti_file =''
 
type(magnetic_helicity_result), save, public mh_last_result
 

Detailed Description

Finite-volume relative magnetic helicity on a uniform Cartesian mesh.

The implementation uses a DeVore gauge and streams one plane at a time. Plane data are reduced to a deterministic owner; consecutive plane owners exchange only the O(N_perp**2) integration state. No magnetic-field-line tracing or replicated three-dimensional field is used.

Function/Subroutine Documentation

◆ compute_magnetic_helicity_fv()

subroutine, public mod_magnetic_helicity::compute_magnetic_helicity_fv ( type(magnetic_helicity_config), intent(in)  config,
type(magnetic_helicity_result), intent(out)  result 
)

Definition at line 210 of file mod_magnetic_helicity.t.

Here is the call graph for this function:

◆ mh_params_read()

subroutine, public mod_magnetic_helicity::mh_params_read ( character(len=*), dimension(:), intent(in)  files)

Definition at line 78 of file mod_magnetic_helicity.t.

◆ mh_run_task()

subroutine, public mod_magnetic_helicity::mh_run_task

Definition at line 103 of file mod_magnetic_helicity.t.

Here is the call graph for this function:

Variable Documentation

◆ mh_debug_vti_file

character(len=mh_name_len), public mod_magnetic_helicity::mh_debug_vti_file =''

Definition at line 71 of file mod_magnetic_helicity.t.

◆ mh_gauge_axis

integer, public mod_magnetic_helicity::mh_gauge_axis =3

Definition at line 65 of file mod_magnetic_helicity.t.

◆ mh_last_result

type(magnetic_helicity_result), save, public mod_magnetic_helicity::mh_last_result

Definition at line 72 of file mod_magnetic_helicity.t.

◆ mh_max_flux_imbalance

double precision, public mod_magnetic_helicity::mh_max_flux_imbalance =1.d-6

Definition at line 68 of file mod_magnetic_helicity.t.

◆ mh_mg_max_cycles

integer, public mod_magnetic_helicity::mh_mg_max_cycles =50

Definition at line 67 of file mod_magnetic_helicity.t.

◆ mh_mg_tolerance

double precision, public mod_magnetic_helicity::mh_mg_tolerance =1.d-4

Definition at line 66 of file mod_magnetic_helicity.t.

◆ mh_output_file

character(len=mh_name_len), public mod_magnetic_helicity::mh_output_file =''

Definition at line 64 of file mod_magnetic_helicity.t.

◆ mh_write_debug_vti

logical, public mod_magnetic_helicity::mh_write_debug_vti =.false.

Definition at line 69 of file mod_magnetic_helicity.t.

◆ mh_write_mg_timing

logical, public mod_magnetic_helicity::mh_write_mg_timing =.false.

Definition at line 70 of file mod_magnetic_helicity.t.