limiter_grid Module Reference

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

Data Types
interface	limiter_grid_class
	Base class representing a limiter signal. More...

Functions/Subroutines
class(limiter_grid_class) function, pointer	limiter_grid_construct (lgrid_file, on_edge)
	Construct a limiter_grid_class. More...
subroutine	limiter_grid_destruct (this)
	Deconstruct a limiter_grid_class object. More...
real(rprec) function	limiter_grid_get_max_fval (this, num_theta, phi_index, r, z, rphiz_at_max)
	Calculates the maximum value of the grid function. More...
character(len=data_name_length) function	limiter_grid_get_type (this)
	Gets a discription of the limiter grid type. More...

Variables
character(len= *), parameter	nc_r0 = 'r0'
	NETCDF r grid start.
character(len= *), parameter	nc_dr = 'dr'
	NETCDF r grid spacing.
character(len= *), parameter	nc_z0 = 'z0'
	NETCDF z grid start.
character(len= *), parameter	nc_dz = 'dz'
	NETCDF z grid spacing.
character(len= *), parameter	nc_phi_angles = 'phi_angles'
	NETCDF grid phi angles.
character(len= *), parameter	nc_iso_grids = 'iso_grids'
	NETCDF grid iso surfaces.

Detailed Description

Defines the base class of the type limiter_grid_class.

Super Class:

geometric

Function/Subroutine Documentation

limiter_grid_construct()

class (limiter_grid_class) function, pointer limiter_grid::limiter_grid_construct	(	character (len=*), intent(in)	lgrid_file,
		logical, intent(in)	on_edge
	)

Construct a limiter_grid_class.

Allocates memory and initializes a limiter_grid_class object from a netcdf file.

Parameters

[in]	lgrid_file	Filename for the limiter grid netcdf file.
[in]	on_edge	Specifies if the edge should touch the limiter or not. If true, the reconstruction tries to have the limiter touch the limiter. If false, the edge will only just fall inside the limiter.

Returns

A pointer to a constructed limiter_grid_class object.

Definition at line 89 of file limiter_grid.f.

limiter_grid_destruct()

subroutine limiter_grid::limiter_grid_destruct

(

type (limiter_grid_class), pointer

this

)

Deconstruct a limiter_grid_class object.

Deallocates memory and uninitializes a limiter_grid_class object.

Parameters

[in,out]

this

A limiter_grid_class instance.

Definition at line 162 of file limiter_grid.f.

limiter_grid_get_max_fval()

real (rprec) function limiter_grid::limiter_grid_get_max_fval	(	class (limiter_grid_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 grid function.

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 205 of file limiter_grid.f.

limiter_grid_get_type()

character (len=data_name_length) function limiter_grid::limiter_grid_get_type

(

class (limiter_grid_class), intent(in)

this

)

Gets a discription of the limiter grid type.

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

Parameters

[in]

this

A limiter_grid_class instance.

Returns

A string describing the limiter type.

Definition at line 261 of file limiter_grid.f.