limiter Module Reference

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

Data Types
type	limiter_class
	Base class representing a limiter signal. More...

Functions/Subroutines
subroutine	limiter_destruct (this)
	Deconstruct a limiter_class object. More...
real(rprec) function, dimension(4)	limiter_get_modeled_signal (this, a_model, sigma, last_value)
	Calculates the modeled signal. More...
character(len=data_name_length) function	limiter_get_type (this)
	Gets a discription of the limiter type. More...
subroutine	limiter_get_header (this, header)
	Gets a discription of the model and model sigma array indices. More...
real(rprec) function	limiter_get_max_fval (this, num_theta, phi_index, r, z, rphiz_at_max)
	Calculates the maximum value of the limiter function. More...

Detailed Description

Defines the base class of the type limiter_class.

Super Class:

geometric

See also

limiter_iso_T

Function/Subroutine Documentation

limiter_destruct()

subroutine limiter::limiter_destruct

(

class (limiter_class), intent(inout)

this

)

Deconstruct a limiter_class object.

Deallocates memory and uninitializes a limiter_class object.

Parameters

[in,out]

this

A limiter_class instance.

Definition at line 69 of file limiter.f.

limiter_get_header()

subroutine limiter::limiter_get_header	(	class (limiter_class), intent(in)	this,
		character (len=data_name_length), dimension(7), intent(inout)	header
	)

Gets a discription of the model and model sigma array indices.

Returns a description of the array indices for use when writting output files.

Parameters

[in]	this	A limiter_class instance.
[in,out]	header	Buffer arrays to write header strings to.

Definition at line 216 of file limiter.f.

limiter_get_max_fval()

real (rprec) function limiter::limiter_get_max_fval	(	class (limiter_class), intent(in)	this,
		integer, intent(in)	num_theta,
		integer, intent(in)	phi_index,
		real (rprec), dimension(:), intent(in)	r,
		real (rprec), dimension(:), intent(in)	z,
		real (rprec), dimension(3), intent(out)	rphiz_at_max
	)

Calculates the maximum value of the limiter function.

This should be overwritten by a subclass method.

Parameters

[in]	this	A limiter_class instance.
[in]	num_theta	Number of points in the theta direction.
[in]	phi_index	Current phi index.
[in]	r	R positions of the last closed flux surface.
[in]	z	Z positions of the last closed flux surface.
[out]	rphiz_at_max	R, Phi, Z position of the maximum function.

Returns

The maximum value of the iso function.

Definition at line 258 of file limiter.f.

limiter_get_modeled_signal()

real (rprec) function, dimension(4) limiter::limiter_get_modeled_signal	(	class (limiter_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.

If the limiter is defined by an iso function returns the value of limiter_get_modeled_iso_signal. Otherwise returns zero.

Parameters

[in,out]	this	A limiter_class instance.
[in]	a_model	A model instance.
[out]	sigma	If the limiter type is defined by an iso function, sigma value of limiter_get_modeled_iso_signal.
[in]	last_value	Last good value in case the signal did not change.

Returns

If the limiter type is defined by an iso function, return the value of limiter_get_modeled_iso_signal. Otherwise returns zero.

Note

Polygon limiters have not be implemented yet.

Definition at line 105 of file limiter.f.

limiter_get_type()

character (len=data_name_length) function limiter::limiter_get_type

(

class (limiter_class), intent(in)

this

)

Gets a discription of the limiter type.

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

Parameters

[in]

this

A limiter_class instance.

Returns

A string describing the limiter type.

Definition at line 186 of file limiter.f.