extcurz Module Reference

Represents a signal obtained by integrating around the magnetic field to get the current enclosed in the Z direction using Ampere's Law. Defines the base class of the type extcurz_class. More...

Data Types
interface	extcurz_class
	Base class representing a external Z currents enclosed by an inegration loop. More...

Functions/Subroutines
class(extcurz_class) function, pointer	extcurz_construct (r, theta)
	Construct a extcurz_class object measureing temperature. More...
subroutine	extcurz_destruct (this)
	Deconstruct a extcurz_class object. More...
real(rprec) function, dimension(4)	extcurz_get_modeled_signal (this, a_model, sigma, last_value)
	Calculates the modeled signal. More...
character(len=data_name_length) function	extcurz_get_type (this)
	Gets a discription of the extcurz type. More...

Detailed Description

Represents a signal obtained by integrating around the magnetic field to get the current enclosed in the Z direction using Ampere's Law. Defines the base class of the type extcurz_class.

Super Class:

diagnostic

Function/Subroutine Documentation

extcurz_construct()

class (extcurz_class) function, pointer extcurz::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.

Definition at line 72 of file extcurz.f.

extcurz_destruct()

subroutine extcurz::extcurz_destruct

(

type (extcurz_class), intent(inout)

this

)

Deconstruct a extcurz_class object.

Deallocates memory and uninitializes a extcurz_class object.

Parameters

[in,out]

this

A extcurz_class instance.

Definition at line 105 of file extcurz.f.

extcurz_get_modeled_signal()

real (rprec) function, dimension(4) extcurz::extcurz_get_modeled_signal	(	class (extcurz_class), intent(inout)	this,
		type (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.

Definition at line 135 of file extcurz.f.

extcurz_get_type()

character (len=data_name_length) function extcurz::extcurz_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.

Definition at line 182 of file extcurz.f.