Defines the base class of the type magnetic_response_class. More...

Data Types
type	magnetic_response_class
	Base class representing a magnetic signal response function. More...

interface	magnetic_response_construct
	Interface for the construction of magnetic_response_class types using magnetic_response_construct_new, & magnetic_response_construct_point or & magnetic_response_construct_netcdf. More...

Functions/Subroutines
type(magnetic_response_class) function, pointer	magnetic_response_construct_new (name, date, coil_id, inductance, current_scale, num_t, num_t_shell, rmin, rmax, zmin, zmax, n_field_periods, stell_sym, a_r, a_f, a_z, a_s_r, a_s_f, a_s_z, svd_cut_off)
	Construct a magnetic_response_class object.

type(magnetic_response_class) function, pointer	magnetic_response_construct_point (name, date, coil_id, position, direction, vacuum, current_scale)
	Construct a magnetic_response_class object.

type(magnetic_response_class) function, pointer	magnetic_response_construct_netcdf (mdsig_iou, svd_cut_off)
	Construct a magnetic_response_class object.

subroutine	magnetic_response_destruct (this)
	Deconstruct a magnetic_response_class object.

logical function	magnetic_response_is_stell_sym (this)
	Checks if the stellarator symmetric flag is set.

logical function	magnetic_response_use_plasma (this)
	Checks if the plasma flag is set.

logical function	magnetic_response_use_shell (this)
	Checks if the conducting shell flag is set.

logical function	magnetic_response_use_coil (this)
	Checks if the coil response flag is set.

subroutine	magnetic_response_clr_use_coil (this)
	Clears the coil response bit.

logical function	magnetic_response_is_point (this)
	Checks if the coil response flag is set.

subroutine	magnetic_response_define (this, mdsig_iou)
	Defines the variables for the NETCDF file.

subroutine	magnetic_response_write (this, mdsig_iou)
	Write variables to the NETCDF file.

Variables
character(len= *), parameter	magnetic_response_current = 'MRC 2015-04-27'
	Version for the MDSIG files. This version adds the point diagnostics.

character(len= *), parameter	magnetic_response_20140928 = 'MRC 2014-09-28'
	Version for the MDSIG files. This version adds the conducting shell.

integer, parameter	magnetic_response_len = 80
	Length for strings.

integer, parameter	magnetic_response_use_coil_flag = 1
	Bit position for the use coil response flag.

integer, parameter	magnetic_response_use_plasma_flag = 2
	Bit position for the force coil response flag.

integer, parameter	magnetic_response_stell_sym_flag = 3
	Bit position for the stellerator symmetry flag.

integer, parameter	magnetic_response_use_shell_flag = 4
	Bit position for the use conducting shell flag.

integer, parameter	magnetic_response_is_point_flag = 5
	Bit position for the use conducting shell flag.

character(len= *), parameter	nc_flags = 'mddc_mrf_flags'
	NETCDF configureation flags.

character(len= *), parameter	nc_name = 'mddc_mrf_code_name'
	NETCDF code name variable.

character(len= *), parameter	nc_version = 'mddc_mrf_code_version'
	NETCDF version variable.

character(len= *), parameter	nc_date = 'mddc_mrf_date_run'
	NETCDF date run variable.

character(len= *), parameter	nc_coil_id = 'mddc_mrf_field_coils_id'
	NETCDF coil identifier variable.

character(len= *), parameter	nc_n_field_cg = 'mddc_mrf_n_field_cg'
	NETCDF number of field coils variable.

character(len= *), parameter	nc_inductance = 'mddc_mrf_rdiag_coilg_1'
	NETCDF mutual inductance variable.

character(len= *), parameter	nc_current_scale = 'mddc_mrf_extcur_mg'
	NETCDF current scale variable.

character(len= *), parameter	nc_num_t = 'mddc_mrf_kp'
	NETCDF number torodial planes variable.

character(len= *), parameter	nc_num_r = 'mddc_mrf_ir'
	NETCDF number radial grid points variable.

character(len= *), parameter	nc_num_z = 'mddc_mrf_jz'
	NETCDF number vertical grid points variable.

character(len= *), parameter	nc_rmin = 'mddc_mrf_rmin'
	NETCDF minimum radial grid variable.

character(len= *), parameter	nc_rmax = 'mddc_mrf_rmax'
	NETCDF maximum radial grid variable.

character(len= *), parameter	nc_zmin = 'mddc_mrf_zmin'
	NETCDF minimum vertical grid variable.

character(len= *), parameter	nc_zmax = 'mddc_mrf_zmax'
	NETCDF maximum vertical grid variable.

character(len= *), parameter	nc_n_field_periods = 'mddc_mrf_n_field_periods'
	NETCDF number of field periods variable.

character(len= *), parameter	nc_stell_sym = 'mddc_mrf_lstell_sym'
	NETCDF stell symmetric variable.

character(len= *), parameter	nc_a_r = 'mddc_mrf_a_r'
	NETCDF radial response grid variable.

character(len= *), parameter	nc_a_f = 'mddc_mrf_a_f'
	NETCDF toroidal response grid variable.

character(len= *), parameter	nc_a_z = 'mddc_mrf_a_z'
	NETCDF vertical response grid variable.

character(len= *), parameter	nc_use_shell = 'mddc_mrf_use_con_shell'
	NETCDF use conducting shell variable.

character(len= *), parameter	nc_num_t_shell = 'mddc_mrf_kp_shell'
	NETCDF number torodial shell grid points variable.

character(len= *), parameter	nc_a_s_r = 'mddc_mrf_a_s_r'
	NETCDF radial response shell grid variable.

character(len= *), parameter	nc_a_s_f = 'mddc_mrf_a_s_f'
	NETCDF toroidal response shell grid variable.

character(len= *), parameter	nc_a_s_z = 'mddc_mrf_a_s_z'
	NETCDF vertical response shell grid variable.

character(len= *), parameter	nc_position = 'mddc_mrf_position'
	NETCDF use conducting shell variable.

character(len= *), parameter	nc_direction = 'mddc_mrf_direction'
	NETCDF number torodial shell grid points variable.

Detailed Description

Defines the base class of the type magnetic_response_class.

Function/Subroutine Documentation

◆ magnetic_response_clr_use_coil()

subroutine magnetic_response::magnetic_response_clr_use_coil ( type (magnetic_response_class), intent(inout) this )

Clears the coil response bit.

This is a convenience method so that outside callers do not need to clear bits directly.

Parameters

[in] this A magnetic_response_class instance.

Returns: True if the flag is set.

◆ magnetic_response_construct_netcdf()

type (magnetic_response_class) function, pointer magnetic_response::magnetic_response_construct_netcdf	(	integer, intent(in)	mdsig_iou,
		real (rprec), intent(in)	svd_cut_off
	)

Construct a magnetic_response_class object.

Allocates memory and initializes a magnetic_response_class object from a mdsig file.

Parameters

[in]	mdsig_iou	An instance of a the netcdf id of the open mdsig file.
[in]	svd_cut_off	Cutoff on singular values for data compression.

Returns: A pointer to a constructed magnetic_response_class object.

◆ magnetic_response_construct_new()

type (magnetic_response_class) function, pointer magnetic_response::magnetic_response_construct_new	(	character (len=*), intent(in)	name,
		character (len=*), intent(in)	date,
		character (len=*), intent(in)	coil_id,
		real (rprec), dimension(:), pointer	inductance,
		real (rprec), dimension(:), pointer	current_scale,
		integer, intent(in)	num_t,
		integer, intent(in)	num_t_shell,
		real (rprec), intent(in)	rmin,
		real (rprec), intent(in)	rmax,
		real (rprec), intent(in)	zmin,
		real (rprec), intent(in)	zmax,
		integer, intent(in)	n_field_periods,
		logical, intent(in)	stell_sym,
		real (rprec), dimension(:,:,:), pointer	a_r,
		real (rprec), dimension(:,:,:), pointer	a_f,
		real (rprec), dimension(:,:,:), pointer	a_z,
		real (rprec), dimension(:,:), pointer	a_s_r,
		real (rprec), dimension(:,:), pointer	a_s_f,
		real (rprec), dimension(:,:), pointer	a_s_z,
		real (rprec), intent(in)	svd_cut_off
	)

Construct a magnetic_response_class object.

Allocates memory and initializes a magnetic_response_class object.

Parameters

[in]	name	Name of the code which computed the responses.
[in]	date	Data and time the code was run.
[in]	coil_id	Idenifier of field-coils.
[in]	inductance	Array of diagnostic field-coil-group responses.
[in]	current_scale	Array of external current scales.
[in]	num_t	Number of phi planes per field period in plasma grid.
[in]	num_t_shell	Number of phi planes per field period in the conducting shell grid.
[in]	rmin	Minimum R for plasma grid.
[in]	rmax	Maximum R for plasma grid.
[in]	zmin	Minimum z for plasma grid.
[in]	zmax	Maximum z for plasma grid.
[in]	n_field_periods	Number of field periods.
[in]	stell_sym	Use stellarator symmetry.
[in]	a_r	R component of plasma response function.
[in]	a_f	Phi component of plasma response function.
[in]	a_z	Z component of plasma response function.
[in]	a_s_r	R component of the conducting shell response function.
[in]	a_s_f	Phi component of the conducting shell response function.
[in]	a_s_z	Z component of the conducting shell response function.
[in]	svd_cut_off	Cutoff on singular values for data compression.

Returns: A pointer to a constructed magnetic_response_class object.

◆ magnetic_response_construct_point()

type (magnetic_response_class) function, pointer magnetic_response::magnetic_response_construct_point	(	character (len=*), intent(in)	name,
		character (len=*), intent(in)	date,
		character (len=*), intent(in)	coil_id,
		real (rprec), dimension(3)	position,
		real (rprec), dimension(3)	direction,
		real (rprec), dimension(:), pointer	vacuum,
		real (rprec), dimension(:), pointer	current_scale
	)

Construct a magnetic_response_class object.

Allocates memory and initializes a magnetic_response_class object.

Parameters

[in]	name	Name of the code which computed the responses.
[in]	date	Data and time the code was run.
[in]	coil_id	Idenifier of field-coils.
[in]	position	Position of the point measurement.
[in]	direction	Direction of the point measurement.
[in]	vacuum	Array of diagnostic vacuum responses.
[in]	current_scale	Array of external current scales.

Returns: A pointer to a constructed magnetic_response_class object.

◆ magnetic_response_define()

subroutine magnetic_response::magnetic_response_define	(	type (magnetic_response_class), intent(in)	this,
		integer, intent(in)	mdsig_iou
	)

Defines the variables for the NETCDF file.

Write out the magnetic response to an mdsig file.

Parameters

[in]	this	A magnetic_response_class instance.
[in]	mdsig_iou	An instance of a the netcdf id of the open mdsig file.

◆ magnetic_response_destruct()

subroutine magnetic_response::magnetic_response_destruct ( type (magnetic_response_class), pointer this )

Deconstruct a magnetic_response_class object.

Deallocates memory and uninitializes a magnetic_response_class object.

Parameters

[in,out] this A magnetic_response_class instance.

◆ magnetic_response_is_point()

logical function magnetic_response::magnetic_response_is_point ( type (magnetic_response_class), intent(in) this )

Checks if the coil response flag is set.

This is a convenience method so that outside callers do not need to test bits directly.

Parameters

[in] this A magnetic_response_class instance.

Returns: True if the flag is set.

◆ magnetic_response_is_stell_sym()

logical function magnetic_response::magnetic_response_is_stell_sym ( type (magnetic_response_class), intent(in) this )

Checks if the stellarator symmetric flag is set.

This is a convenience method so that outside callers do not need to test bits directly.

Parameters

[in] this A magnetic_response_class instance.

Returns: True if the flag is set.

◆ magnetic_response_use_coil()

logical function magnetic_response::magnetic_response_use_coil ( type (magnetic_response_class), intent(in) this )

Checks if the coil response flag is set.

This is a convenience method so that outside callers do not need to test bits directly.

Parameters

[in] this A magnetic_response_class instance.

Returns: True if the flag is set.

◆ magnetic_response_use_plasma()

logical function magnetic_response::magnetic_response_use_plasma ( type (magnetic_response_class), intent(in) this )

Checks if the plasma flag is set.

This is a convenience method so that outside callers do not need to test bits directly.

Parameters

[in] this A magnetic_response_class instance.

Returns: True if the flag is set.

◆ magnetic_response_use_shell()

logical function magnetic_response::magnetic_response_use_shell ( type (magnetic_response_class), intent(in) this )

Checks if the conducting shell flag is set.

This is a convenience method so that outside callers do not need to test bits directly.

Parameters

[in] this A magnetic_response_class instance.

Returns: True if the flag is set.

◆ magnetic_response_write()

subroutine magnetic_response::magnetic_response_write	(	type (magnetic_response_class), intent(in)	this,
		integer, intent(in)	mdsig_iou
	)

Write variables to the NETCDF file.

Write out the magnetic response to an mdsig file.

Parameters

[in]	this	A magnetic_response_class instance.
[in]	mdsig_iou	An instance of a the netcdf id of the open mdsig file.

Variable Documentation

◆ magnetic_response_20140928

character (len=*), parameter magnetic_response::magnetic_response_20140928 = 'MRC 2014-09-28'

Version for the MDSIG files. This version adds the conducting shell.

Deprecated:

◆ nc_stell_sym

character (len=*), parameter magnetic_response::nc_stell_sym = 'mddc_mrf_lstell_sym'

NETCDF stell symmetric variable.

Deprecated:

◆ nc_use_shell

character (len=*), parameter magnetic_response::nc_use_shell = 'mddc_mrf_use_con_shell'

NETCDF use conducting shell variable.

Deprecated:

Data Types

Functions/Subroutines

Variables

Detailed Description

Function/Subroutine Documentation

◆ magnetic_response_clr_use_coil()

◆ magnetic_response_construct_netcdf()

◆ magnetic_response_construct_new()

◆ magnetic_response_construct_point()

◆ magnetic_response_define()

◆ magnetic_response_destruct()

◆ magnetic_response_is_point()

◆ magnetic_response_is_stell_sym()

◆ magnetic_response_use_coil()

◆ magnetic_response_use_plasma()

◆ magnetic_response_use_shell()

◆ magnetic_response_write()

Variable Documentation

◆ magnetic_response_20140928

◆ nc_stell_sym

◆ nc_use_shell