Data Types
interface	itm_amns_rx
	get the rates associated with the input args for a particular reaction (generic interface for 1d, 2d & 3d arrays) More...

Public Member Functions
subroutine	itm_amns_setup (handle, version, error_status)
	initialization call for the AMNS package More...

subroutine	itm_amns_setup_table (handle, reaction_type, reactants, handle_rx, error_status)
	initialization call for a particular reaction More...

subroutine	itm_amns_finish (handle, error_status)
	finalization call for the AMNS package More...

subroutine	itm_amns_finish_table (handle_rx, error_status)
	finalization call for a particular reaction More...

subroutine	itm_amns_query (handle, query, answer, error_status)
	query routine for the AMNS package More...

subroutine	itm_amns_query_table (handle_rx, query, answer, error_status)
	query routine for a particular reaction More...

subroutine	itm_amns_set (handle, set, error_status)
	set a parameter for the AMNS package More...

subroutine	itm_amns_set_table (handle_rx, set, error_status)
	set a parameter for a particular reaction More...

subroutine	itm_amns_rx_0 (handle_rx, out, arg1, arg2, arg3, error_status)
	get the rates associated with the input (0d) args for a particular reaction More...

subroutine	itm_amns_rx_1 (handle_rx, out, arg1, arg2, arg3, error_status)
	get the rates associated with the input (1d) args for a particular reaction More...

subroutine	itm_amns_rx_2 (handle_rx, out, arg1, arg2, arg3, error_status)
	get the rates associated with the input (2d) args for a particular reaction More...

subroutine	itm_amns_rx_3 (handle_rx, out, arg1, arg2, arg3, error_status)
	get the rates associated with the input (3d) args for a particular reaction More...

Public Attributes
integer, save	version_no

character(len=256), save	user

character(len=32), save	ds_version ='4.10b'

character(len=32), save	backend ='mdsplus'

character(len=32), save	dataversion_tag =DATAVERSION_TAG

character(len=32), save	local_dataversion_tag =''

type(type_amns), dimension(:), pointer, save	amns00

Detailed Description

Definition at line 11 of file amns_module.F90.

Member Function/Subroutine Documentation

subroutine amns_module::itm_amns_rx_0	(	type(amns_handle_rx_type), intent(inout)	handle_rx,
		real (kind=r8), intent(out)	out,
		real (kind=r8), intent(in)	arg1,
		real (kind=r8), intent(in), optional	arg2,
		real (kind=r8), intent(in), optional	arg3,
		type(amns_error_type), intent(out), optional	error_status
	)

get the rates associated with the input (0d) args for a particular reaction

Parameters

[in]	handle_rx	Opaque handle from call to ITM_AMNS_SETUP_TABLE
[out]	out	Results from the AMNS system (scalar)
[in]	arg1	Output to be evaluated at the points specified by this argument, possibly in combination with arg2 and arg3; (scalar)
[in]	arg2	Output to be evaluated at the points specified by this argument, in combination with arg1 and possibly arg3; (scalar) (optional)
[in]	arg3	Output to be evaluated at the points specified by this argument, in combination with arg1 and arg2; (scalar) (optional)
[out]	error_status	If an error occurs, this will be set (optional)

Definition at line 668 of file amns_module.F90.

Here is the call graph for this function:

subroutine amns_module::itm_amns_rx_1	(	type(amns_handle_rx_type), intent(inout)	handle_rx,
		real (kind=r8), dimension(:), intent(out)	out,
		real (kind=r8), dimension(:), intent(in)	arg1,
		real (kind=r8), dimension(:), intent(in), optional	arg2,
		real (kind=r8), dimension(:), intent(in), optional	arg3,
		type(amns_error_type), intent(out), optional	error_status
	)

get the rates associated with the input (1d) args for a particular reaction

Parameters

[in]	handle_rx	Opaque handle from call to ITM_AMNS_SETUP_TABLE
[out]	out	Results from the AMNS system (1d array)
[in]	arg1	Output to be evaluated at the points specified by this argument, possibly in combination with arg2 and arg3; (1d array) of the same size as out
[in]	arg2	Output to be evaluated at the points specified by this argument, in combination with arg1 and possibly arg3; (1d array) of the same size as out (optional)
[in]	arg3	Output to be evaluated at the points specified by this argument, in combination with arg1 and arg2; (1d array) of the same size as out (optional)
[out]	error_status	If an error occurs, this will be set (optional)

Definition at line 781 of file amns_module.F90.

Here is the call graph for this function:

subroutine amns_module::itm_amns_rx_2	(	type(amns_handle_rx_type), intent(inout)	handle_rx,
		real (kind=r8), dimension(:,:), intent(out)	out,
		real (kind=r8), dimension(:,:), intent(in)	arg1,
		real (kind=r8), dimension(:,:), intent(in), optional	arg2,
		real (kind=r8), dimension(:,:), intent(in), optional	arg3,
		type(amns_error_type), intent(out), optional	error_status
	)

get the rates associated with the input (2d) args for a particular reaction

Parameters

[in]	handle_rx	Opaque handle from call to ITM_AMNS_SETUP_TABLE
[out]	out	Results from the AMNS system (2d array)
[in]	arg1	Output to be evaluated at the points specified by this argument, possibly in combination with arg2 and arg3; (2d array) of the same size as out
[in]	arg2	Output to be evaluated at the points specified by this argument, in combination with arg1 and possibly arg3; (2d array) of the same size as out (optional)
[in]	arg3	Output to be evaluated at the points specified by this argument, in combination with arg1 and arg2; (2d array) of the same size as out (optional)
[out]	error_status	If an error occurs, this will be set (optional)

Definition at line 889 of file amns_module.F90.

Here is the call graph for this function:

subroutine amns_module::itm_amns_rx_3	(	type(amns_handle_rx_type), intent(inout)	handle_rx,
		real (kind=r8), dimension(:,:,:), intent(out)	out,
		real (kind=r8), dimension(:,:,:), intent(in)	arg1,
		real (kind=r8), dimension(:,:,:), intent(in), optional	arg2,
		real (kind=r8), dimension(:,:,:), intent(in), optional	arg3,
		type(amns_error_type), intent(out), optional	error_status
	)

get the rates associated with the input (3d) args for a particular reaction

Parameters

[in]	handle_rx	Opaque handle from call to ITM_AMNS_SETUP_TABLE
[out]	out	Results from the AMNS system (3d array)
[in]	arg1	Output to be evaluated at the points specified by this argument, possibly in combination with arg2 and arg3; (3d array) of the same size as out
[in]	arg2	Output to be evaluated at the points specified by this argument, in combination with arg1 and possibly arg3; (3d array) of the same size as out (optional)
[in]	arg3	Output to be evaluated at the points specified by this argument, in combination with arg1 and arg2; (3d array) of the same size as out (optional)
[out]	error_status	If an error occurs, this will be set (optional)

Definition at line 1002 of file amns_module.F90.

Here is the call graph for this function:

Member Data Documentation

type (type_amns), dimension(:), pointer, save amns_module::amns00

Definition at line 37 of file amns_module.F90.

character (len=32), save amns_module::backend ='mdsplus'

Definition at line 35 of file amns_module.F90.

character (len=32), save amns_module::dataversion_tag =DATAVERSION_TAG

Definition at line 35 of file amns_module.F90.

character (len=32), save amns_module::ds_version ='4.10b'

Definition at line 35 of file amns_module.F90.

character (len=32), save amns_module::local_dataversion_tag =''

Definition at line 35 of file amns_module.F90.

character (len=256), save amns_module::user

Definition at line 34 of file amns_module.F90.

integer, save amns_module::version_no

Definition at line 33 of file amns_module.F90.

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

src/amns_module.F90

Data Types

Public Member Functions

Public Attributes

Detailed Description

Member Function/Subroutine Documentation

Member Data Documentation