AMNS Callable Fortran Subroutines

Module implementing the ITM AMNS interface. More...

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

Functions/Subroutines
subroutine	amns_module::itm_amns_setup (handle, version, error_status)
	initialization call for the AMNS package More...
subroutine	amns_module::itm_amns_setup_table (handle, reaction_type, reactants, handle_rx, error_status)
	initialization call for a particular reaction More...
subroutine	amns_module::itm_amns_finish (handle, error_status)
	finalization call for the AMNS package More...
subroutine	amns_module::itm_amns_finish_table (handle_rx, error_status)
	finalization call for a particular reaction More...
subroutine	amns_module::itm_amns_query (handle, query, answer, error_status)
	query routine for the AMNS package More...
subroutine	amns_module::itm_amns_query_table (handle_rx, query, answer, error_status)
	query routine for a particular reaction More...
subroutine	amns_module::itm_amns_set (handle, set, error_status)
	set a parameter for the AMNS package More...
subroutine	amns_module::itm_amns_set_table (handle_rx, set, error_status)
	set a parameter for a particular reaction More...

Detailed Description

Module implementing the ITM AMNS interface.

Author

David Coster, updated David Tskhakaya (small updates in: ITM_AMNS_SET_TABLE, ITM_AMNS_FINISH)

Version

"$Id: amns_module.F90 569 2017-05-24 08:47:42Z dpc $"

Function/Subroutine Documentation

subroutine amns_module::itm_amns_finish	(	type(amns_handle_type), intent(inout)	handle,
		type(amns_error_type), intent(out), optional	error_status
	)

finalization call for the AMNS package

Parameters

[in]	handle	Opaque handle from call to ITM_AMNS_SETUP
[out]	error_status	If an error occurs, this will be set (optional)

Definition at line 349 of file amns_module.F90.

Here is the call graph for this function:

Here is the caller graph for this function:

subroutine amns_module::itm_amns_finish_table	(	type(amns_handle_rx_type), intent(inout)	handle_rx,
		type(amns_error_type), intent(out), optional	error_status
	)

finalization call for a particular reaction

Parameters

[in]	handle_rx	Opaque handle from call to ITM_AMNS_SETUP_TABLE
[out]	error_status	If an error occurs, this will be set (optional)

Definition at line 385 of file amns_module.F90.

Here is the call graph for this function:

Here is the caller graph for this function:

subroutine amns_module::itm_amns_query	(	type(amns_handle_type), intent(in)	handle,
		type(amns_query_type), intent(in)	query,
		type(amns_answer_type), intent(out)	answer,
		type(amns_error_type), intent(out), optional	error_status
	)

query routine for the AMNS package

Parameters

[in]	handle	Opaque handle from call to ITM_AMNS_SETUP
[in]	query	Specifies the query
[out]	answer	Returns the answer
[out]	error_status	If an error occurs, this will be set (optional)

Remarks

Possible queries are:

• version : information about the version

Definition at line 428 of file amns_module.F90.

Here is the caller graph for this function:

subroutine amns_module::itm_amns_query_table	(	type(amns_handle_rx_type), intent(in)	handle_rx,
		type(amns_query_type), intent(in)	query,
		type(amns_answer_type), intent(out)	answer,
		type(amns_error_type), intent(out), optional	error_status
	)

query routine for a particular reaction

Parameters

[in]	handle_rx	Opaque handle from call to ITM_AMNS_SETUP_TABLE
[in]	query	Specifies the query
[out]	answer	Returns the answer
[out]	error_status	If an error occurs, this will be set (optional)

Remarks

Possible queries are:

• source : information about the data source
• no_of_reactants : number of reactants and products
• index :
• filled : whether AMNS data exists
• reaction_type : type of the reaction (value originally passed to ITM_AMNS_SETUP_TABLE in reaction_typestring)
• reactants : information about the reactants and products
• version : information about the version
• state_label : label of the charge state
• result_unit : units of the result
• result_label : label of the result
• ndim : dimensionality of the requested data
• interp_fun : number of the interpolating function

Definition at line 480 of file amns_module.F90.

Here is the caller graph for this function:

subroutine amns_module::itm_amns_set	(	type(amns_handle_type), intent(inout)	handle,
		type(amns_set_type), intent(in)	set,
		type(amns_error_type), intent(out), optional	error_status
	)

set a parameter for the AMNS package

Parameters

[in]	handle	Opaque handle from call to ITM_AMNS_SETUP
[in]	set	Specifies the setting to be applied
[out]	error_status	If an error occurs, this will be set (optional)

Remarks

Possible settings are:

• debug : enable debugging
• nodebug : disable debugging
• backend=mdsplus : use the MDSplus backend
• backend=hdf5 : use the HDF5 backend
• backend=ascii : use the ASCII backend

Definition at line 567 of file amns_module.F90.

Here is the caller graph for this function:

subroutine amns_module::itm_amns_set_table	(	type(amns_handle_rx_type), intent(inout)	handle_rx,
		type(amns_set_type), intent(in)	set,
		type(amns_error_type), intent(out), optional	error_status
	)

set a parameter for a particular reaction

Parameters

[in]	handle_rx	Opaque handle from call to ITM_AMNS_SETUP_TABLE
[in]	set	Specifies the setting to be applied
[out]	error_status	If an error occurs, this will be set (optional)

Remarks

Possible settings are:

• warn : request warning messages
• nowarn : disable warnings
• debug : enable debuggibg
• nodebug : disable debugging

Definition at line 616 of file amns_module.F90.

Here is the call graph for this function:

Here is the caller graph for this function:

subroutine amns_module::itm_amns_setup	(	type(amns_handle_type), intent(out)	handle,
		type(amns_version_type), intent(in), optional	version,
		type(amns_error_type), intent(out), optional	error_status
	)

initialization call for the AMNS package

Parameters

[out]	handle	Opaque handle to be used for further calls
[in]	version	Requested version (optional)
[out]	error_status	If an error occurs, this will be set (optional)

Definition at line 47 of file amns_module.F90.

Here is the caller graph for this function:

subroutine amns_module::itm_amns_setup_table	(	type(amns_handle_type), intent(in)	handle,
		type(amns_reaction_type), intent(in)	reaction_type,
		type(amns_reactants_type), intent(in)	reactants,
		type(amns_handle_rx_type), intent(out)	handle_rx,
		type(amns_error_type), intent(out), optional	error_status
	)

initialization call for a particular reaction

Parameters

[in]	handle	Opaque handle from call to ITM_AMNS_SETUP
[in]	reaction_type	Specifier for the reaction
[in]	reactants	Specifier for the reactants and products
[out]	handle_rx	Opaque handle to be passed to table routine calls
[out]	error_status	If an error occurs, this will be set (optional)

Definition at line 217 of file amns_module.F90.

Here is the call graph for this function:

Here is the caller graph for this function: