extcurz::extcurz_class Interface Reference

Base class representing a external Z currents enclosed by an inegration loop. More...

Inheritance diagram for extcurz::extcurz_class:

Public Member Functions
procedure	get_modeled_signal_last (this, a_model, sigma, last_value)
	Calculates the modeled signal.
procedure	get_type (this)
	Gets a discription of the extcurz type.
FINAL	extcurz_destruct (this)
	Deconstruct a extcurz_class object.
class(extcurz_class) function, pointer	extcurz_construct (r, theta)
	Construct a extcurz_class object measureing temperature.
Public Member Functions inherited from signal::signal_class
procedure	get_modeled_signal_cache (this, a_model, sigma, use_cache, last_value)
	Calculates the modeled signal.
procedure	get_modeled_signal_last (this, a_model, sigma, last_value)
	Calculates the modeled signal.
GENERIC	get_modeled_signal get_modeled_signal_cache, get_modeled_signal_last
procedure	get_observed_signal (this, a_model)
	Calculates the observed signal.
procedure	get_g2 (this, a_model, use_cache, last_value)
	Calculates the g^2 contribution of a signal.
procedure	get_e (this, a_model, use_cache, last_value)
	Calculates the e contribution of a signal.
procedure	get_sigma2 (this)
	Calculates the total sigma^2 of a signal.
procedure	get_type (this)
	Gets a discription of the signal type.
procedure	get_header (this, header)
	Gets a discription of the model and model sigma array indices.
procedure	get_gp_i (this, a_model, i, flags)
	Gets the guassian process kernel for a signal and a position.
procedure	get_gp_s (this, a_model, signal, flags)
	Gets the guassian process kernel for a signal and a signal.
procedure	get_gp_x (this, a_model, x_cart, flags)
	Gets the guassian process kernel for a signal and cartesian position.
GENERIC	get_gp get_gp_i, get_gp_s, get_gp_x
procedure	scale_and_offset (this, a_model, value)
	Apply scale and offset to the value.
procedure	sync_child (this, index, recon_comm)
	Syncronize a child signal state to the parent.
procedure	write_header (this, iou)
	Write out the signal header information to an output file.
procedure	write (this, iou, index, a_model)
	Write out the signal information to an output file.
procedure	write_auxiliary (this, iou, index, a_model)
	Write out any auxiliary signal information to an output file.
procedure	write_step_data (this, a_model, result_ncid, current_step, index, signal_model_value_id, signal_sigma_value_id)
	Write out the signal data for a step to the result netcdf file.
FINAL	signal_destruct (this)
	Deconstruct a signal_class object.

Public Attributes
real(rprec)	r
	Radial surface to compute external current from.
real(rprec)	theta
	Poloidal angle to compute current from.
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 external Z currents enclosed by an inegration loop.

Interface for the construction of extcurz_class types using extcurz_construct.

Super Class:

diagnostic

Member Function/Subroutine Documentation

extcurz_construct()

class (extcurz_class) function, pointer extcurz::extcurz_class::extcurz_construct	(	real(rprec), intent(in)	r,
		real(rprec), intent(in)	theta
	)

Construct a extcurz_class object measureing temperature.

Allocates memory and initializes a extcurz_class object.

Parameters

[in]	r	The radial position to integrate at.
[in]	theta	The poloidal angle to integrate at.

Returns

A pointer to a constructed extcurz_class object.

extcurz_destruct()

FINAL extcurz::extcurz_class::extcurz_destruct ( type (extcurz_class), intent(inout)  this )

final

Deconstruct a extcurz_class object.

Deallocates memory and uninitializes a extcurz_class object.

Parameters

[in,out]

this

A extcurz_class instance.

get_modeled_signal_last()

procedure extcurz::extcurz_class::get_modeled_signal_last	(	class (extcurz_class), intent(inout)	this,
		class (model_class), pointer	a_model,
		real (rprec), dimension(4), intent(out)	sigma,
		real (rprec), dimension(4), intent(in)	last_value
	)

Calculates the modeled signal.

Calculates the inclused Z current from Ampere's Law from an loop integration of the magnetic field. The loop integrated magnetic field is provided by equilibrium::equilibrium_get_Int_B_dphi

Parameters

[in,out]	this	A extcurz_class instance.
[in]	a_model	A model instance.
[out]	sigma	The modeled sigma.
[in]	last_value	Last good value in case the signal did not change.

Returns

The model value.

get_type()

procedure extcurz::extcurz_class::get_type

(

class (extcurz_class), intent(in)

this

)

Gets a discription of the extcurz type.

Returns a description of the extcurz type for use when writting output files.

Parameters

[in]

this

A extcurz_class instance.

Returns

A string describing the extcurz type.

---

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

• V3FIT/Sources/extcurz.f