mod_magnetic_reference_fv Module Reference

Finite-volume potential reference field for magnetic diagnostics. More...

Data Types
type	magnetic_reference_block
type	magnetic_reference_config
type	magnetic_reference_field
type	magnetic_reference_result

Functions/Subroutines
subroutine, public	solve_magnetic_reference_fv (config, bp, result)
subroutine, public	free_magnetic_reference_field (bp)
subroutine, public	magnetic_reference_bc (box, nc, iv, nb, bc_type, bc)
	Supply d(phi)/dx_i = B_i on a physical multigrid boundary.

Detailed Description

Finite-volume potential reference field for magnetic diagnostics.

The reference field Bp = grad(phi) is obtained from a Laplace solve with the normal component of the total magnetic field prescribed on all six physical faces. The multigrid solution is scratch storage only: callers receive an independently allocated, distributed cell-centred Bp field.

Function/Subroutine Documentation

free_magnetic_reference_field()

subroutine, public mod_magnetic_reference_fv::free_magnetic_reference_field

(

type(magnetic_reference_field), intent(inout)

bp

)

Definition at line 142 of file mod_magnetic_reference_fv.t.

Here is the call graph for this function:

magnetic_reference_bc()

subroutine, public mod_magnetic_reference_fv::magnetic_reference_bc	(	type(mg_box_t), intent(in)	box,
		integer, intent(in)	nc,
		integer, intent(in)	iv,
		integer, intent(in)	nb,
		integer, intent(out)	bc_type,
		double precision, dimension(nc,nc), intent(out)	bc
	)

Supply d(phi)/dx_i = B_i on a physical multigrid boundary.

Definition at line 325 of file mod_magnetic_reference_fv.t.

solve_magnetic_reference_fv()

subroutine, public mod_magnetic_reference_fv::solve_magnetic_reference_fv	(	type(magnetic_reference_config), intent(in)	config,
		type(magnetic_reference_field), intent(inout)	bp,
		type(magnetic_reference_result), intent(out)	result
	)

Definition at line 44 of file mod_magnetic_reference_fv.t.

Here is the call graph for this function: