larmor Module Reference

Data Types
type	marker_type

Functions/Subroutines
subroutine, public	initlarmor (step)
	Allocate and initialize larmor point arrays.
subroutine	add_param_index (n_atts, att)
logical function, public	should_enlarge_larmor (isp)
subroutine, public	reallocate_larmor (isp)
subroutine	check_allocation (istat, locatn, varname)
subroutine, public	sort_larmor_points
subroutine, public	assign_larmor_atts (isp, lnaveg, alp, rhog, sigma, chi, phi, wgc, pzomgc, larmor_start)
subroutine, public	advance_atts_offset_disp ()
	Increment larmor atts offset for all species.
subroutine, public	advance_atts_offset (isp)
	Increment larmor atts offset for one species.
subroutine, public	reset_atts_offset_disp ()
	Reset the atts offset for each buffer.
subroutine, public	reset_atts_offset (isp)
	Reset the atts offset for each buffer.
subroutine, public	set_n_larmor_tot (isp, larmor_index, np)
	Set the total number of Larmor points per species.
subroutine, public	set_larmor_max (isp, larmor_index, np)
	Set the maximum number of larmor points per species The maximum number of larmor points is taken to be a certain fraction of the total number of points (typically 20%).

Variables
type(marker_type), dimension(:), allocatable, save, public	larmor_pts
type(sorting_class), dimension(:), allocatable, save, public	sortings
type(sorting_class), dimension(:), allocatable, save	larmor
type(sorting_class), dimension(:), allocatable, save	point
type(sorting_class), dimension(:), allocatable, save	sorting
type(sorting_class), dimension(:), allocatable, save	of
type(sorting_class), dimension(:), allocatable, save	each
type(sorting_class), dimension(:), allocatable, save	species
real(kind=r8), dimension(:,:), allocatable, save	zcos2
real(kind=r8), dimension(:,:), allocatable, save	zsin2
	Cosine/sine of a uniform angle distribution with navg points.
integer, save, public	n_atts
	Number of larmor point attributes.
integer, save, public	sig_att
integer, save, public	chi_att
integer, save, public	phi_att
	Radial, poloidal and toroidal positions.
integer, save, public	sds_att
integer, save, public	sdc_att
integer, save, public	cds_att
integer, save, public	cdc_att
integer, save, public	wgt_att
integer, save, public	wcf_att
integer, save, public	field_att
	Field attribute index (add 1 to access radial gradient, 2 for poloidal gradient, and 3 for toroidal gradient) attribute arrays.
real(kind=r8), save	larmor_size_margin = 1.3_r8
real(kind=r8), save	larmor_size_warning_margin = 1.25_r8

Function/Subroutine Documentation

add_param_index()

subroutine larmor::add_param_index ( integer, intent(inout) n_atts, integer, intent(out) att )

private

Here is the caller graph for this function:

advance_atts_offset()

subroutine, public larmor::advance_atts_offset

(

integer, intent(in)

isp

)

Increment larmor atts offset for one species.

Here is the caller graph for this function:

advance_atts_offset_disp()

subroutine, public larmor::advance_atts_offset_disp

Increment larmor atts offset for all species.

Here is the call graph for this function:

Here is the caller graph for this function:

assign_larmor_atts()

subroutine, public larmor::assign_larmor_atts	(	integer, intent(in)	isp,
		integer, intent(in)	lnaveg,
		real(kind=r8), intent(in)	alp,
		real(kind=r8), intent(in)	rhog,
		real(kind=r8), intent(in)	sigma,
		real(kind=r8), intent(in)	chi,
		real(kind=r8), intent(in)	phi,
		real(kind=r8), intent(in)	wgc,
		real(kind=r8), intent(in)	pzomgc,
		integer, intent(in)	larmor_start )

Parameters

[in]	sigma	Radial position of the GC
[in]	chi	Poloidal position of the GC
[in]	phi	Toroidal position of the GC
[in]	alp	Tilt angle for the gyroaveraging
[in]	rhog	Larmor radius
[in]	isp	Species under consideration
[in]	lnaveg	Number of Larmor points
[in]	wgc	Weight of the GC
[in]	pzomgc	Parallel velocity
[in]	larmor_start	Index of the first larmor point in the larmor array

Here is the call graph for this function:

Here is the caller graph for this function:

check_allocation()

subroutine larmor::check_allocation ( integer, intent(in) istat, character(len=*), intent(in) locatn, character(len=*), intent(in) varname )

private

Here is the caller graph for this function:

initlarmor()

subroutine, public larmor::initlarmor

(

integer, intent(in)

step

)

Allocate and initialize larmor point arrays.

Parameters

[in]

step

The initialization is split in 2 to compute particles energy in between

Here is the call graph for this function:

Here is the caller graph for this function:

reallocate_larmor()

subroutine, public larmor::reallocate_larmor

(

integer, intent(in)

isp

)

Here is the call graph for this function:

Here is the caller graph for this function:

reset_atts_offset()

subroutine, public larmor::reset_atts_offset

(

integer, intent(in)

isp

)

Reset the atts offset for each buffer.

Here is the caller graph for this function:

reset_atts_offset_disp()

subroutine, public larmor::reset_atts_offset_disp

Reset the atts offset for each buffer.

Here is the call graph for this function:

Here is the caller graph for this function:

set_larmor_max()

subroutine, public larmor::set_larmor_max	(	integer, intent(in)	isp,
		integer, intent(in)	larmor_index,
		integer, intent(in)	np )

Set the maximum number of larmor points per species The maximum number of larmor points is taken to be a certain fraction of the total number of points (typically 20%).

Here is the caller graph for this function:

set_n_larmor_tot()

subroutine, public larmor::set_n_larmor_tot	(	integer, intent(in)	isp,
		integer, intent(in)	larmor_index,
		integer, intent(in)	np )

Set the total number of Larmor points per species.

Here is the caller graph for this function:

should_enlarge_larmor()

logical function, public larmor::should_enlarge_larmor

(

integer, intent(in)

isp

)

Here is the call graph for this function:

Here is the caller graph for this function:

sort_larmor_points()

subroutine, public larmor::sort_larmor_points

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

cdc_att

integer, save, public larmor::cdc_att

cds_att

integer, save, public larmor::cds_att

chi_att

integer, save, public larmor::chi_att

each

type(sorting_class), dimension(:), allocatable, save larmor::each

private

field_att

integer, save, public larmor::field_att

Field attribute index (add 1 to access radial gradient, 2 for poloidal gradient, and 3 for toroidal gradient) attribute arrays.

larmor

type(sorting_class), dimension(:), allocatable, save larmor::larmor

private

larmor_pts

type(marker_type), dimension(:), allocatable, save, public larmor::larmor_pts

larmor_size_margin

real(kind=r8), save larmor::larmor_size_margin = 1.3_r8

private

larmor_size_warning_margin

real(kind=r8), save larmor::larmor_size_warning_margin = 1.25_r8

private

n_atts

integer, save, public larmor::n_atts

Number of larmor point attributes.

of

type(sorting_class), dimension(:), allocatable, save larmor::of

private

phi_att

integer, save, public larmor::phi_att

Radial, poloidal and toroidal positions.

point

type(sorting_class), dimension(:), allocatable, save larmor::point

private

sdc_att

integer, save, public larmor::sdc_att

sds_att

integer, save, public larmor::sds_att

sig_att

integer, save, public larmor::sig_att

sorting

type(sorting_class), dimension(:), allocatable, save larmor::sorting

private

sortings

type(sorting_class), dimension(:), allocatable, save, public larmor::sortings

species

type(sorting_class), dimension(:), allocatable, save larmor::species

private

wcf_att

integer, save, public larmor::wcf_att

wgt_att

integer, save, public larmor::wgt_att

zcos2

real(kind=r8), dimension(:,:), allocatable, save larmor::zcos2

private

zsin2

real(kind=r8), dimension(:,:), allocatable, save larmor::zsin2

private

Cosine/sine of a uniform angle distribution with navg points.