unprimed_grid Module Reference

Defines the base class of the type unprimed_grid_class. This contains the state variables to define the currents and positions of the volumn integral. More...

Data Types
interface	unprimed_grid_class
	Base class representing a unprimed grid. This is grid the volume integral will be summed over. More...

Functions/Subroutines
class(unprimed_grid_class) function, pointer	unprimed_grid_construct_m (mgrid, pgrid, p_start, p_end, parallel, io_unit)
	Construct a unprimed_grid_class object. More...
class(unprimed_grid_class) function, pointer	unprimed_grid_construct_a (mgrid, pgrid, r_grid, z_grid, dphi, parallel, io_unit)
	Construct a unprimed_grid_class object at specfied points. More...
class(unprimed_grid_class) function, pointer	unprimed_grid_construct_c (mgrid, pgrid, pgrid_vac, p_start, p_end, parallel, io_unit)
	Construct a unprimed_grid_class object. More...
subroutine	unprimed_grid_destruct (this)
	Deconstruct a unprimed_grid_class object. More...

Detailed Description

Defines the base class of the type unprimed_grid_class. This contains the state variables to define the currents and positions of the volumn integral.

Function/Subroutine Documentation

unprimed_grid_construct_a()

class (unprimed_grid_class) function, pointer unprimed_grid::unprimed_grid_construct_a	(	class (m_grid_class), intent(in)	mgrid,
		class (primed_grid_class), intent(in)	pgrid,
		real (rprec), dimension(:,:,:), intent(in)	r_grid,
		real (rprec), dimension(:,:,:), intent(in)	z_grid,
		real (rprec), intent(in)	dphi,
		class (bmw_parallel_context_class), intent(in)	parallel,
		integer, intent(in)	io_unit
	)

Construct a unprimed_grid_class object at specfied points.

Allocates memory and initializes a unprimed_grid_class object. This computes the vector potential, magnetic field and positions on the unprimed grid. The primed grid is supplied as arbitrary r and z positions with a uniformly spaced phi grid. Since the primed grid is arbitrary, this function does not compute the magnetic field components. The middle index represents phi positions.

Parameters

[in]	mgrid	A m_grid::m_grid_class object.
[in]	pgrid	A primed_grid::primed_grid_class object.
[in]	r_grid	3D Array of r positions.
[in]	z_grid	3D Array of z positions.
[in]	dphi	Phi grid spacing.
[in]	parallel	bmw_parallel_context::bmw_parallel_context_class object instance.
[in]	io_unit	Unit number to write messages to.

Returns

A pointer to a constructed unprimed_grid_class object.

unprimed_grid_construct_c()

class (unprimed_grid_class) function, pointer unprimed_grid::unprimed_grid_construct_c	(	class (m_grid_class), intent(in)	mgrid,
		class (primed_grid_class), intent(in)	pgrid,
		class (primed_grid_class), intent(in)	pgrid_vac,
		integer, intent(in)	p_start,
		integer, intent(in)	p_end,
		class (bmw_parallel_context_class), intent(in)	parallel,
		integer, intent(in)	io_unit
	)

Construct a unprimed_grid_class object.

Allocates memory and initializes a unprimed_grid_class object. This computes the vector potential, magnetic field and positions on the unprimed grid. Magnetic field components are provided on a truncated grid. Due to the central differencing, field componetents cannot be provided for first and last points on the r and z grids.

This version removes vacuum current contribuitons.

Parameters

[in]	mgrid	A m_grid::m_grid_class object.
[in]	pgrid	A primed_grid::primed_grid_class object.
[in]	pgrid_vac	A primed_grid::primed_grid_class object for the vacuum correction.
[in]	p_start	Starting phi index to compute fields to.
[in]	p_end	Ending phi index to compute fields to.
[in]	parallel	bmw_parallel_context::bmw_parallel_context_class object instance.
[in]	io_unit	Unit number to write messages to.

Returns

A pointer to a constructed unprimed_grid_class object.

unprimed_grid_construct_m()

class (unprimed_grid_class) function, pointer unprimed_grid::unprimed_grid_construct_m	(	class (m_grid_class), intent(in)	mgrid,
		class (primed_grid_class), intent(in)	pgrid,
		integer, intent(in)	p_start,
		integer, intent(in)	p_end,
		class (bmw_parallel_context_class), intent(in)	parallel,
		integer, intent(in)	io_unit
	)

Construct a unprimed_grid_class object.

Allocates memory and initializes a unprimed_grid_class object. This computes the vector potential, magnetic field and positions on the unprimed grid. Magnetic field components are provided on a truncated grid. Due to the central differencing, field componetents cannot be provided for first and last points on the r and z grids.

Parameters

[in]	mgrid	A m_grid::m_grid_class object.
[in]	pgrid	A primed_grid::primed_grid_class object.
[in]	p_start	Starting phi index to compute fields to.
[in]	p_end	Ending phi index to compute fields to.
[in]	parallel	bmw_parallel_context::bmw_parallel_context_class object instance.
[in]	io_unit	Unit number to write messages to.

Returns

A pointer to a constructed unprimed_grid_class object.

unprimed_grid_destruct()

subroutine unprimed_grid::unprimed_grid_destruct

(

type (unprimed_grid_class), intent(inout)

this

)

Deconstruct a unprimed_grid_class object.

Deallocates memory and uninitializes a unprimed_grid_class object.

Parameters

[in,out]

this

A unprimed_grid_class instance.