Base class representing a magnetic signal. More...

Inheritance diagram for magnetic::magnetic_class:

Public Member Functions
PROCEDURE	get_modeled_signal_last => magnetic_get_modeled_signal

PROCEDURE	get_type => magnetic_get_type

PROCEDURE	get_header => magnetic_get_header

FINAL	magnetic_destruct

class(magnetic_class) function, pointer	magnetic_construct_netcdf (mdsig_iou, use_coil_response, force_coil_reponse, use_3D_only, svd_cut_off)
	Construct a magnetic_class object containing a magnetic_response::magnetic_response_class object. More...

Public Member Functions inherited from signal::signal_class
PROCEDURE	get_modeled_signal_cache => signal_get_modeled_signal_cache

PROCEDURE	get_modeled_signal_last => signal_get_modeled_signal_last

GENERIC	get_modeled_signal => get_modeled_signal_cache, get_modeled_signal_last

PROCEDURE	get_observed_signal => signal_get_observed_signal

PROCEDURE	get_g2 => signal_get_g2

PROCEDURE	get_e => signal_get_e

PROCEDURE	get_sigma2 => signal_get_sigma2

PROCEDURE	get_type => signal_get_type

PROCEDURE	get_header => signal_get_header

PROCEDURE	get_gp_i => signal_get_gp_i

PROCEDURE	get_gp_s => signal_get_gp_s

PROCEDURE	get_gp_x => signal_get_gp_x

GENERIC	get_gp => get_gp_i, get_gp_s, get_gp_x

PROCEDURE	scale_and_offset => signal_scale_and_offset

PROCEDURE	sync_child => signal_sync_child

PROCEDURE	write_header => signal_write_header

PROCEDURE	write => signal_write

PROCEDURE	write_auxiliary => signals_write_auxiliary

PROCEDURE	write_step_data => signal_write_step_data

FINAL	signal_destruct

Public Attributes
integer	control_flags
	Setting to force the computing of the coil constribution.

type(magnetic_response_class), pointer	response => null()
	Magnetic response function object.

Public Attributes inherited from signal::signal_class
character(len=data_short_name_length)	s_name
	Short name of the signal.

character(len=data_name_length)	l_name
	Long name of the signal.

character(len=data_short_name_length)	units
	Physical units the signal measures.

real(rprec)	observed
	Eperimentally measured signal value.

real(rprec)	observed_sigma
	Eperimentally measured signal uncertainty.

real(rprec)	weight
	Weighting parameter of the signal.

real(rprec), dimension(4)	modeled
	Cached value of the modeled signal.

real(rprec), dimension(4)	modeled_sigma
	Cached value of the modeled sigma.

integer	scale_index
	Scale factor index.

integer	offset_index
	Offset factor index.

Detailed Description

Base class representing a magnetic signal.

Interface for the construction of magnetic_class types using magnetic_construct_netcdf.

Definition at line 39 of file magnetic.f.

Member Function/Subroutine Documentation

class (magnetic_class) function, pointer magnetic::magnetic_class::magnetic_construct_netcdf	(	integer, intent(in)	mdsig_iou,
		logical, intent(in)	use_coil_response,
		logical, intent(in)	force_coil_reponse,
		logical, intent(in)	use_3D_only,
		real (rprec), intent(in)	svd_cut_off
	)

Allocates memory and initializes a magnetic_class object.

Parameters

[in]	mdsig_iou	An instance of a the netcdf id of the open mdsig file.
[in]	use_coil_response	Toggle if the total signal contains the induced signal in addition to the plasma only signal.
[in]	force_coil_reponse	Force the coil response to be computed.
[in]	use_3D_only	Subtract of the axisymmtric porition of the signal.
[in]	svd_cut_off	Cutoff value for the number of singular values to retain when compressing the response function arrays.

Definition at line 91 of file magnetic.f.

The documentation for this interface was generated from the following file: