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_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...

Detailed Description

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

Parameters

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

Definition at line 27 of file amns_module.F90.

Member Function/Subroutine Documentation

subroutine amns_module::itm_amns_rx::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 caller graph for this function:

subroutine amns_module::itm_amns_rx::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 caller graph for this function:

subroutine amns_module::itm_amns_rx::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 caller graph for this function:

subroutine amns_module::itm_amns_rx::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 caller graph for this function:

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