v3rfun_context Module Reference

Defines a v3rfun_context_class object to contain all the memory for running v3rfun. More...

Data Types
type	v3rfun_context_class
	Base class representing a v3rfun context. This contains all memory needed to operate v3rfun. More...

Functions/Subroutines
type(v3rfun_context_class) function, pointer	v3rfun_context_construct (filename)
	Construct a v3rfun_context_class object. More...
subroutine	v3rfun_context_construct_field_coils (this)
	Construct and initialize the field coil objects. More...
subroutine	v3rfun_context_construct_responce_grids (this)
	Allocate and initialize the response function arrays. More...
subroutine	v3rfun_context_destruct (this)
	Deconstruct a v3rfun_context_class object. More...
subroutine	v3rfun_context_write_mrf (this, d_coil, id_num)
	Write out a magnetic coil response function. More...
subroutine	v3rfun_context_write_point (this, d_coil, id_num)
	Write out a point probe response. More...
real(rprec) function, dimension(3), private	cart2cyl_v (vcart, phi)
	Converts a vector from Cartesian coordinates to cylindrical coordinates. More...

Variables
character(len= *), parameter	code_name = 'V3RFUN'
	Name of this code.

Detailed Description

Defines a v3rfun_context_class object to contain all the memory for running v3rfun.

Function/Subroutine Documentation

cart2cyl_v()

real (rprec) function, dimension(3), private v3rfun_context::cart2cyl_v ( real (rprec), dimension(3), intent(in)  vcart, real (rprec), intent(in)  phi  )

private

Converts a vector from Cartesian coordinates to cylindrical coordinates.

[vr ] [ Cos(phi) Sin(phi) 0] [vx] [vPhi] = [-Sin(phi) Cos(phi) 0] * [vy] [vZ ] [ 0 0 1] [vz]

Parameters

[in]	vcart	The vector to convert.
[in]	phi	The toroidal angle to perform the conversion at.

Returns

The converted vector.

Definition at line 902 of file v3rfun_context.f.

v3rfun_context_construct()

type (v3rfun_context_class) function, pointer v3rfun_context::v3rfun_context_construct

(

character (len=*), intent(in)

filename

)

Construct a v3rfun_context_class object.

Allocates memory and initializes a v3rfun_context_class object.

Returns

A pointer to a constructed v3rfun_context_class object.

Definition at line 99 of file v3rfun_context.f.

v3rfun_context_construct_field_coils()

subroutine v3rfun_context::v3rfun_context_construct_field_coils

(

type (v3rfun_context_class), pointer

this

)

Construct and initialize the field coil objects.

Allocates memory and the field coil objects then apply the rotations and shits as defined in the namelist inout file.

@params[in] this An instance of a v3rfun_context_class.

Definition at line 244 of file v3rfun_context.f.

v3rfun_context_construct_responce_grids()

subroutine v3rfun_context::v3rfun_context_construct_responce_grids

(

type (v3rfun_context_class), pointer

this

)

Allocate and initialize the response function arrays.

Allocates memory and for the plasma and conducting shell response function arrays. This does not compute the actual response yet.

@params[in] this An instance of a v3rfun_context_class.

Definition at line 344 of file v3rfun_context.f.

v3rfun_context_destruct()

subroutine v3rfun_context::v3rfun_context_destruct

(

type (v3rfun_context_class), pointer

this

)

Deconstruct a v3rfun_context_class object.

Deallocates memory and uninitializes a v3rfun_context_class object. This all the v3rfun constructed objects are destroyed here.

Parameters

[in,out]

this

A v3rfun_context_class instance.

Definition at line 455 of file v3rfun_context.f.

v3rfun_context_write_mrf()

subroutine v3rfun_context::v3rfun_context_write_mrf	(	type (v3rfun_context_class), intent(inout)	this,
		type (diagnostic_dot_coil), intent(in)	d_coil,
		integer, intent(in)	id_num
	)

Write out a magnetic coil response function.

Computes the magnetic response function for each a coil and writes the results to an mdsig file.

Parameters

[in,out]	this	A v3rfun_context_class instance.
[in]	d_coil	A diagnostic_dot::diagnostic_dot_coil instance.
[in]	id_num	Diagnostic coil number.

Definition at line 533 of file v3rfun_context.f.

v3rfun_context_write_point()

subroutine v3rfun_context::v3rfun_context_write_point	(	type (v3rfun_context_class), intent(inout)	this,
		type (diagnostic_dot_coil), intent(in)	d_coil,
		integer, intent(in)	id_num
	)

Write out a point probe response.

Computes the response function for the vacuum field at the point measurement. Point probes are assumed to be outside of the plasma.

Parameters

[in,out]	this	A v3rfun_context_class instance.
[in]	d_coil	A diagnostic_dot::diagnostic_dot_coil instance.
[in]	id_num	Diagnostic coil number.

Definition at line 803 of file v3rfun_context.f.