ITM AMNS: User Interface  \$Id: Doxyfile 502 2015-10-15 12:23:45Z dpc $
AMNS Callable C Subroutines

Module implementing the ITM AMNS interface for C codes. More...

Functions/Subroutines

subroutine amns_module_isoc::itm_amns_c_setup (handle, error_status)
 provides ITM_AMNS_C_SETUP by calling ITM_AMNS_SETUP More...
 
subroutine amns_module_isoc::itm_amns_c_setup_version (handle, version, error_status)
 provides ITM_AMNS_C_SETUP by calling ITM_AMNS_SETUP with version argument More...
 
subroutine amns_module_isoc::itm_amns_c_finish (handle, error_status)
 provides ITM_AMNS_C_FINISH by calling ITM_AMNS_FINISH More...
 
subroutine amns_module_isoc::itm_amns_c_finish_table (handle_rx, error_status)
 provides ITM_AMNS_C_FINISH_TABLE by calling ITM_AMNS_FINISH_TABLE More...
 
subroutine amns_module_isoc::itm_amns_c_set (handle, set, error_status)
 provides ITM_AMNS_C_SET by calling ITM_AMNS_SET More...
 
subroutine amns_module_isoc::itm_amns_c_query (handle, query, answer, error_status)
 provides ITM_AMNS_C_QUERY by calling ITM_AMNS_QUERY More...
 
subroutine amns_module_isoc::itm_amns_c_setup_table (handle, reaction_type, reactant, handle_rx, error_status)
 provides ITM_AMNS_C_SETUP_TABLE by calling ITM_AMNS_SETUP_TABLE More...
 
subroutine amns_module_isoc::itm_amns_c_query_table (handle_rx, query, answer, error_status)
 provides ITM_AMNS_C_QUERY_TABLE by calling ITM_AMNS_QUERY_TABLE More...
 
subroutine amns_module_isoc::itm_amns_c_set_table (handle_rx, set, error_status)
 provides ITM_AMNS_C_SET_TABLE by calling ITM_AMNS_SET_TABLE More...
 
subroutine amns_module_isoc::itm_amns_c_rx_0_a (handle_rx, out, arg1, error_status)
 get the rates associated with the input (0d) args for a particular reaction Expanded into three separate subroutine for 1, 2 or 3 arguments. More...
 
subroutine amns_module_isoc::itm_amns_c_rx_0_b (handle_rx, out, arg1, arg2, error_status)
 get the rates associated with the input (0d) args for a particular reaction Expanded into three separate subroutine for 1, 2 or 3 arguments. More...
 
subroutine amns_module_isoc::itm_amns_c_rx_0_c (handle_rx, out, arg1, arg2, arg3, error_status)
 get the rates associated with the input (0d) args for a particular reaction Expanded into three separate subroutine for 1, 2 or 3 arguments. More...
 
subroutine amns_module_isoc::itm_amns_c_rx_1_a (handle_rx, nx, out, arg1, error_status)
 get the rates associated with the input (1d) args for a particular reaction Expanded into three separate subroutine for 1,2 or 3 arguments. More...
 
subroutine amns_module_isoc::itm_amns_c_rx_1_b (handle_rx, nx, out, arg1, arg2, error_status)
 get the rates associated with the input (1d) args for a particular reaction Expanded into three separate subroutine for 1,2 or 3 arguments. More...
 
subroutine amns_module_isoc::itm_amns_c_rx_1_c (handle_rx, nx, out, arg1, arg2, arg3, error_status)
 get the rates associated with the input (1d) args for a particular reaction Expanded into three separate subroutine for 1,2 or 3 arguments. More...
 
subroutine amns_module_isoc::itm_amns_c_rx_2_a (handle_rx, nx, ny, out, arg1, error_status)
 get the rates associated with the input (2d) args for a particular reaction Expanded into three separate subroutine for 1,2 or 3 arguments. More...
 
subroutine amns_module_isoc::itm_amns_c_rx_2_b (handle_rx, nx, ny, out, arg1, arg2, error_status)
 get the rates associated with the input (2d) args for a particular reaction Expanded into three separate subroutine for 1,2 or 3 arguments. More...
 
subroutine amns_module_isoc::itm_amns_c_rx_2_c (handle_rx, nx, ny, out, arg1, arg2, arg3, error_status)
 get the rates associated with the input (2d) args for a particular reaction Expanded into three separate subroutine for 1,2 or 3 arguments. More...
 
subroutine amns_module_isoc::itm_amns_c_rx_3_a (handle_rx, nx, ny, nz, out, arg1, error_status)
 get the rates associated with the input (3d) args for a particular reaction Expanded into three separate subroutine for 1,2 or 3 arguments. More...
 
subroutine amns_module_isoc::itm_amns_c_rx_3_b (handle_rx, nx, ny, nz, out, arg1, arg2, error_status)
 get the rates associated with the input (3d) args for a particular reaction Expanded into three separate subroutine for 1,2 or 3 arguments. More...
 
subroutine amns_module_isoc::itm_amns_c_rx_3_c (handle_rx, nx, ny, nz, out, arg1, arg2, arg3, error_status)
 get the rates associated with the input (3d) args for a particular reaction Expanded into three separate subroutine for 1,2 or 3 arguments. More...
 
subroutine amns_module_isoc::itm_amns_c_setup_reactants (reactants_handle, string, index, n_reactants)
 Additional helper routines not contained in amns_module, but required for using the type amns_reactants_type from C. More...
 
subroutine amns_module_isoc::itm_amns_c_set_reactant (reactants_handle, reactant_index, reactant)
 Additional helper routines not contained in amns_module, but required for using the type amns_reactants_type from C. More...
 
subroutine amns_module_isoc::itm_amns_c_get_reactant (reactants_handle, reactant_index, reactant)
 Additional helper routines not contained in amns_module, but required for using the type amns_reactants_type from C. More...
 
subroutine amns_module_isoc::itm_amns_c_finish_reactants (reactants_handle)
 Additional helper routines not contained in amns_module, but required for using the type amns_reactants_type from C. More...
 

Detailed Description

Module implementing the ITM AMNS interface for C codes.

Author
Hajo Klingshirn
Version
"$Id: amns_module_isoc.F90 502 2015-10-15 12:23:45Z dpc $"

Function/Subroutine Documentation

subroutine amns_module_isoc::itm_amns_c_finish ( type(c_ptr), intent(inout)  handle,
type(amns_error_type), intent(out)  error_status 
)

provides ITM_AMNS_C_FINISH by calling ITM_AMNS_FINISH

Definition at line 61 of file amns_module_isoc.F90.

Here is the call graph for this function:

subroutine amns_module_isoc::itm_amns_c_finish_reactants ( type(c_ptr), intent(inout)  reactants_handle)

Additional helper routines not contained in amns_module, but required for using the type amns_reactants_type from C.

Definition at line 480 of file amns_module_isoc.F90.

subroutine amns_module_isoc::itm_amns_c_finish_table ( type(c_ptr), intent(inout)  handle_rx,
type(amns_error_type), intent(out)  error_status 
)

provides ITM_AMNS_C_FINISH_TABLE by calling ITM_AMNS_FINISH_TABLE

Definition at line 78 of file amns_module_isoc.F90.

Here is the call graph for this function:

subroutine amns_module_isoc::itm_amns_c_get_reactant ( type(c_ptr), intent(in)  reactants_handle,
integer(c_int), intent(in)  reactant_index,
type(amns_reactant_type), intent(out)  reactant 
)

Additional helper routines not contained in amns_module, but required for using the type amns_reactants_type from C.

Definition at line 462 of file amns_module_isoc.F90.

subroutine amns_module_isoc::itm_amns_c_query ( type(c_ptr), intent(in)  handle,
type(amns_query_type), intent(in)  query,
type(amns_answer_type), intent(out)  answer,
type(amns_error_type), intent(out)  error_status 
)

provides ITM_AMNS_C_QUERY by calling ITM_AMNS_QUERY

Definition at line 112 of file amns_module_isoc.F90.

Here is the call graph for this function:

subroutine amns_module_isoc::itm_amns_c_query_table ( type(c_ptr), intent(in)  handle_rx,
type(amns_query_type), intent(in)  query,
type(amns_answer_type), intent(out)  answer,
type(amns_error_type), intent(out)  error_status 
)

provides ITM_AMNS_C_QUERY_TABLE by calling ITM_AMNS_QUERY_TABLE

Definition at line 155 of file amns_module_isoc.F90.

Here is the call graph for this function:

subroutine amns_module_isoc::itm_amns_c_rx_0_a ( type(c_ptr), intent(in)  handle_rx,
real (kind=r8), intent(out)  out,
real (kind=r8), intent(in)  arg1,
type(amns_error_type), intent(out)  error_status 
)

get the rates associated with the input (0d) args for a particular reaction Expanded into three separate subroutine for 1, 2 or 3 arguments.

Definition at line 190 of file amns_module_isoc.F90.

Here is the call graph for this function:

subroutine amns_module_isoc::itm_amns_c_rx_0_b ( type(c_ptr), intent(in)  handle_rx,
real (kind=r8), intent(out)  out,
real (kind=r8), intent(in)  arg1,
real (kind=r8), intent(in)  arg2,
type(amns_error_type), intent(out)  error_status 
)

get the rates associated with the input (0d) args for a particular reaction Expanded into three separate subroutine for 1, 2 or 3 arguments.

Definition at line 207 of file amns_module_isoc.F90.

Here is the call graph for this function:

subroutine amns_module_isoc::itm_amns_c_rx_0_c ( type(c_ptr), intent(in)  handle_rx,
real (kind=r8), intent(out)  out,
real (kind=r8), intent(in)  arg1,
real (kind=r8), intent(in)  arg2,
real (kind=r8), intent(in)  arg3,
type(amns_error_type), intent(out)  error_status 
)

get the rates associated with the input (0d) args for a particular reaction Expanded into three separate subroutine for 1, 2 or 3 arguments.

Definition at line 224 of file amns_module_isoc.F90.

Here is the call graph for this function:

subroutine amns_module_isoc::itm_amns_c_rx_1_a ( type(c_ptr), intent(in)  handle_rx,
integer(c_int), intent(in)  nx,
real (c_double), dimension(0:nx-1), intent(out)  out,
real (c_double), dimension(0:nx-1), intent(in)  arg1,
type(amns_error_type), intent(out)  error_status 
)

get the rates associated with the input (1d) args for a particular reaction Expanded into three separate subroutine for 1,2 or 3 arguments.

Definition at line 242 of file amns_module_isoc.F90.

Here is the call graph for this function:

subroutine amns_module_isoc::itm_amns_c_rx_1_b ( type(c_ptr), intent(in)  handle_rx,
integer(c_int), intent(in)  nx,
real (c_double), dimension(0:nx-1), intent(out)  out,
real (c_double), dimension(0:nx-1), intent(in)  arg1,
real (c_double), dimension(0:nx-1), intent(in)  arg2,
type(amns_error_type), intent(out)  error_status 
)

get the rates associated with the input (1d) args for a particular reaction Expanded into three separate subroutine for 1,2 or 3 arguments.

Definition at line 261 of file amns_module_isoc.F90.

Here is the call graph for this function:

subroutine amns_module_isoc::itm_amns_c_rx_1_c ( type(c_ptr), intent(in)  handle_rx,
integer(c_int), intent(in)  nx,
real (c_double), dimension(0:nx-1), intent(out)  out,
real (c_double), dimension(0:nx-1), intent(in)  arg1,
real (c_double), dimension(0:nx-1), intent(in)  arg2,
real (c_double), dimension(0:nx-1), intent(in)  arg3,
type(amns_error_type), intent(out)  error_status 
)

get the rates associated with the input (1d) args for a particular reaction Expanded into three separate subroutine for 1,2 or 3 arguments.

Definition at line 280 of file amns_module_isoc.F90.

Here is the call graph for this function:

subroutine amns_module_isoc::itm_amns_c_rx_2_a ( type(c_ptr), intent(in)  handle_rx,
integer(c_int), intent(in)  nx,
integer(c_int), intent(in)  ny,
real (c_double), dimension(0:nx-1,0:ny-1), intent(out)  out,
real (c_double), dimension(0:nx-1,0:ny-1), intent(in)  arg1,
type(amns_error_type), intent(out)  error_status 
)

get the rates associated with the input (2d) args for a particular reaction Expanded into three separate subroutine for 1,2 or 3 arguments.

Definition at line 300 of file amns_module_isoc.F90.

Here is the call graph for this function:

subroutine amns_module_isoc::itm_amns_c_rx_2_b ( type(c_ptr), intent(in)  handle_rx,
integer(c_int), intent(in)  nx,
integer(c_int), intent(in)  ny,
real (c_double), dimension(0:nx-1,0:ny-1), intent(out)  out,
real (c_double), dimension(0:nx-1,0:ny-1), intent(in)  arg1,
real (c_double), dimension(0:nx-1,0:ny-1), intent(in)  arg2,
type(amns_error_type), intent(out)  error_status 
)

get the rates associated with the input (2d) args for a particular reaction Expanded into three separate subroutine for 1,2 or 3 arguments.

Definition at line 319 of file amns_module_isoc.F90.

Here is the call graph for this function:

subroutine amns_module_isoc::itm_amns_c_rx_2_c ( type(c_ptr), intent(in)  handle_rx,
integer(c_int), intent(in)  nx,
integer(c_int), intent(in)  ny,
real (c_double), dimension(0:nx-1,0:ny-1), intent(out)  out,
real (c_double), dimension(0:nx-1,0:ny-1), intent(in)  arg1,
real (c_double), dimension(0:nx-1,0:ny-1), intent(in)  arg2,
real (c_double), dimension(0:nx-1,0:ny-1), intent(in)  arg3,
type(amns_error_type), intent(out)  error_status 
)

get the rates associated with the input (2d) args for a particular reaction Expanded into three separate subroutine for 1,2 or 3 arguments.

Definition at line 338 of file amns_module_isoc.F90.

Here is the call graph for this function:

subroutine amns_module_isoc::itm_amns_c_rx_3_a ( type(c_ptr), intent(in)  handle_rx,
integer(c_int), intent(in)  nx,
integer(c_int), intent(in)  ny,
integer(c_int), intent(in)  nz,
real (c_double), dimension(0:nx-1,0:ny-1,0:nz-1), intent(out)  out,
real (c_double), dimension(0:nx-1,0:ny-1,0:nz-1), intent(in)  arg1,
type(amns_error_type), intent(out)  error_status 
)

get the rates associated with the input (3d) args for a particular reaction Expanded into three separate subroutine for 1,2 or 3 arguments.

Definition at line 358 of file amns_module_isoc.F90.

Here is the call graph for this function:

subroutine amns_module_isoc::itm_amns_c_rx_3_b ( type(c_ptr), intent(in)  handle_rx,
integer(c_int), intent(in)  nx,
integer(c_int), intent(in)  ny,
integer(c_int), intent(in)  nz,
real (c_double), dimension(0:nx-1,0:ny-1,0:nz-1), intent(out)  out,
real (c_double), dimension(0:nx-1,0:ny-1,0:nz-1), intent(in)  arg1,
real (c_double), dimension(0:nx-1,0:ny-1,0:nz-1), intent(in)  arg2,
type(amns_error_type), intent(out)  error_status 
)

get the rates associated with the input (3d) args for a particular reaction Expanded into three separate subroutine for 1,2 or 3 arguments.

Definition at line 377 of file amns_module_isoc.F90.

Here is the call graph for this function:

subroutine amns_module_isoc::itm_amns_c_rx_3_c ( type(c_ptr), intent(in)  handle_rx,
integer(c_int), intent(in)  nx,
integer(c_int), intent(in)  ny,
integer(c_int), intent(in)  nz,
real (c_double), dimension(0:nx-1,0:ny-1,0:nz-1), intent(out)  out,
real (c_double), dimension(0:nx-1,0:ny-1,0:nz-1), intent(in)  arg1,
real (c_double), dimension(0:nx-1,0:ny-1,0:nz-1), intent(in)  arg2,
real (c_double), dimension(0:nx-1,0:ny-1,0:nz-1), intent(in)  arg3,
type(amns_error_type), intent(out)  error_status 
)

get the rates associated with the input (3d) args for a particular reaction Expanded into three separate subroutine for 1,2 or 3 arguments.

Definition at line 396 of file amns_module_isoc.F90.

Here is the call graph for this function:

subroutine amns_module_isoc::itm_amns_c_set ( type(c_ptr), intent(in)  handle,
type(amns_set_type), intent(in)  set,
type(amns_error_type), intent(out)  error_status 
)

provides ITM_AMNS_C_SET by calling ITM_AMNS_SET

Definition at line 95 of file amns_module_isoc.F90.

Here is the call graph for this function:

subroutine amns_module_isoc::itm_amns_c_set_reactant ( type(c_ptr), intent(in)  reactants_handle,
integer(c_int), intent(in)  reactant_index,
type(amns_reactant_type), intent(in)  reactant 
)

Additional helper routines not contained in amns_module, but required for using the type amns_reactants_type from C.

Definition at line 445 of file amns_module_isoc.F90.

subroutine amns_module_isoc::itm_amns_c_set_table ( type(c_ptr), intent(in)  handle_rx,
type(amns_set_type), intent(in)  set,
type(amns_error_type), intent(out)  error_status 
)

provides ITM_AMNS_C_SET_TABLE by calling ITM_AMNS_SET_TABLE

Definition at line 172 of file amns_module_isoc.F90.

Here is the call graph for this function:

subroutine amns_module_isoc::itm_amns_c_setup ( type(c_ptr), intent(out)  handle,
type(amns_error_type), intent(out)  error_status 
)

provides ITM_AMNS_C_SETUP by calling ITM_AMNS_SETUP

Definition at line 24 of file amns_module_isoc.F90.

Here is the call graph for this function:

subroutine amns_module_isoc::itm_amns_c_setup_reactants ( type(c_ptr), intent(out)  reactants_handle,
character(kind=c_char), dimension(*), intent(in)  string,
integer(c_int), intent(in)  index,
integer(c_int), intent(in)  n_reactants 
)

Additional helper routines not contained in amns_module, but required for using the type amns_reactants_type from C.

Definition at line 416 of file amns_module_isoc.F90.

Here is the call graph for this function:

subroutine amns_module_isoc::itm_amns_c_setup_table ( type(c_ptr), intent(in)  handle,
type(amns_reaction_type), intent(in)  reaction_type,
type(c_ptr), intent(in)  reactant,
type(c_ptr), intent(out)  handle_rx,
type(amns_error_type), intent(out)  error_status 
)

provides ITM_AMNS_C_SETUP_TABLE by calling ITM_AMNS_SETUP_TABLE

Definition at line 132 of file amns_module_isoc.F90.

Here is the call graph for this function:

subroutine amns_module_isoc::itm_amns_c_setup_version ( type(c_ptr), intent(out)  handle,
type(amns_version_type), intent(in)  version,
type(amns_error_type), intent(out)  error_status 
)

provides ITM_AMNS_C_SETUP by calling ITM_AMNS_SETUP with version argument

Definition at line 42 of file amns_module_isoc.F90.

Here is the call graph for this function: