api_interface Module Reference

Functions/Subroutines
subroutine	run_partel (CODE, NAMEINP, NAMECLI, NPARTS, PMETHOD, FFORMAT, NAMESEC, NAMEZFI, NAMESEU, IERR)
subroutine	run_parres (CODE, NAMEGEO, NAMEINP, NPARTS, GEOFORMAT, INPFORMAT, IERR)
subroutine	run_gretel (CODE, GEO, GEOFORMAT, BND, RES, RESFORMAT, NPROC, NPLAN_RES, METHOD)
subroutine	check_instance (ID, TAG, IERR)
subroutine	get_double_array (ID, TAG, VARNAME, VALEUR, DIM1, IERR, BLOCK_INDEX)
subroutine	set_double_array (ID, TAG, VARNAME, VALEUR, DIM1, IERR, BLOCK_INDEX)
subroutine	get_integer_array (ID, TAG, VARNAME, VALEUR, DIM1, IERR)
subroutine	set_integer_array (ID, TAG, VARNAME, VALEUR, DIM1, IERR)
subroutine	get_double (ID, TAG, VARNAME, VALEUR, INDEX1, INDEX2, INDEX3, IERR)
subroutine	set_double (ID, TAG, VARNAME, VALEUR, INDEX1, INDEX2, INDEX3, IERR)
subroutine	get_integer (ID, TAG, VARNAME, VALEUR, INDEX1, INDEX2, INDEX3, IERR)
subroutine	set_integer (ID, TAG, VARNAME, VALEUR, INDEX1, INDEX2, INDEX3, IERR)
subroutine	get_string (ID, TAG, VARNAME, VALEUR, VALUELEN, INDEX1, INDEX2, IERR)
subroutine	set_string (ID, TAG, VARNAME, VALEUR, VALUELEN, INDEX1, INDEX2, IERR)
subroutine	get_boolean (ID, TAG, VARNAME, VALEUR, INDEX1, INDEX2, INDEX3, IERR)
subroutine	set_boolean (ID, TAG, VARNAME, VALEUR, INDEX1, INDEX2, INDEX3, IERR)
subroutine	get_var_type (TAG, VARNAME, VARTYPE, READONLY, NDIM, IENT, JENT, KENT, GETPOS, SETPOS, IERR)
subroutine	get_var_size (ID, TAG, VARNAME, DIM1, DIM2, DIM3, IERR)
subroutine	get_var_list (TAG, VARNAME, VARINFO, IERR)
subroutine	get_error_message (ID, TAG, IERR, MESS)
subroutine	run_set_config_t2d (ID, LU, LNG, COMM, IERR)
subroutine	cpl_init (ID, IERR)
subroutine	run_read_case_t2d (ID, CAS_FILE, DICO_FILE, INIT, IERR, GAIA_CAS, GAIA_DICO)
subroutine	run_allocation_t2d (ID, IERR)
subroutine	run_init_t2d (ID, IERR)
subroutine	run_timestep_t2d (ID, IERR)
subroutine	run_timestep_compute_t2d (ID, IERR)
subroutine	run_timestep_res_t2d (ID, IERR)
subroutine	run_finalize_t2d (ID, IERR)
subroutine	run_set_config_t3d (ID, LU, LNG, COMM, IERR)
subroutine	run_read_case_t3d (ID, CAS_FILE, DICO_FILE, INIT, IERR, WAQ_CAS_FILE, WAQ_DICO_FILE, GAIA_CAS_FILE, GAIA_DICO_FILE)
subroutine	run_allocation_t3d (ID, IERR)
subroutine	run_init_t3d (ID, IERR)
subroutine	run_timestep_t3d (ID, IERR)
subroutine	run_finalize_t3d (ID, IERR)
subroutine	run_set_config_sis (ID, LU, LNG, COMM, IERR)
subroutine	run_read_case_sis (ID, CODE, CAS_FILE, DICO_FILE, INIT, IERR)
subroutine	run_allocation_sis (ID, IERR)
subroutine	run_init_sis (ID, IERR)
subroutine	run_timestep_sis (ID, IERR)
subroutine	run_finalize_sis (ID, IERR)
subroutine	save_charr_susp (ID_T2D, ID_SIS, IERR)
subroutine	charr_or_susp (ID_T2D, ID_SIS, CHARR_SUSP, IERR)
subroutine	set_var_sis (ID_T2D, ID_SIS, CALL_TYPE, IERR)
subroutine	set_var_t2d (ID_T2D, ID_SIS, IERR)
subroutine	run_set_config_art (ID, LU, LNG, COMM, IERR)
subroutine	run_read_case_art (ID, CAS_FILE, DICO_FILE, INIT, IERR)
subroutine	run_allocation_art (ID, IERR)
subroutine	run_init_art (ID, IERR)
subroutine	run_timestep_art (ID, IERR)
subroutine	run_finalize_art (ID, IERR)
subroutine	run_set_config_wac (ID, LU, LNG, COMM, IERR)
subroutine	run_read_case_wac (ID, CAS_FILE, DICO_FILE, INIT, IERR)
subroutine	run_allocation_wac (ID, IERR)
subroutine	run_init_wac (ID, IERR)
subroutine	run_timestep_wac (ID, IERR)
subroutine	run_finalize_wac (ID, IERR)
subroutine	run_timestep_sis_cpl (ID_T2D, ID_SIS, IERR)
subroutine	identify_liq_bnd (IKLES, DIM_MESH, NPTFR, NPOIN, NELEM2, LIUBOR, LIHBOR, NBOR, COORD, NELBOR, IFABOR, KP1BOR, NUMLIQ, LISTIN)

Variables
integer, external	global_to_local_point
integer, parameter	str_len = 250

Detailed Description

Brief:

USER API FUNCTIONS

Function/Subroutine Documentation

charr_or_susp()

subroutine api_interface::charr_or_susp	(	integer, intent(in)	ID_T2D,
		integer, intent(in)	ID_SIS,
		integer, intent(out)	CHARR_SUSP,
		integer, intent(out)	IERR
	)

Brief:

Deals with cases : BEDLOAD OF SUSPENSION

Parameters

[in]	ID_T2D	Id of the telemac2d instance
[in]	ID_SIS	Id of the sisyphe instance
[out]	CHARR_SUSP	Defines which sisyphe call = 1 Means Bedload = 2 Means Suspension = 3 Means Both
[out]	IERR	0 if subroutine successfull, error id otherwise

Definition at line 1795 of file api_interface.f.

Here is the call graph for this function:

Here is the caller graph for this function:

check_instance()

subroutine api_interface::check_instance	(	integer, intent(in)	ID,
		character(len=3), intent(in)	TAG,
		integer, intent(out)	IERR
	)

Brief:

Check that the instance exist

Parameters

[in]	ID	Id of the instance
[in]	TAG	Short of the module to use (t2d,sis...)
[out]	IERR	0 if subroutine successfull, error id otherwise

Definition at line 197 of file api_interface.f.

Here is the call graph for this function:

Here is the caller graph for this function:

cpl_init()

subroutine api_interface::cpl_init	(	integer, intent(in)	ID,
		integer, intent(out)	IERR
	)

Brief:

Initializes variables for TELEMAC2D in case of coupling

Parameters

[in]	ID	Id of the telemac2d instance
[out]	IERR	0 if subroutine successfull, error id otherwise

Definition at line 1149 of file api_interface.f.

Here is the call graph for this function:

Here is the caller graph for this function:

get_boolean()

subroutine api_interface::get_boolean	(	integer, intent(in)	ID,
		character(len=3), intent(in)	TAG,
		character(len=t2d_var_len), intent(in)	VARNAME,
		integer, intent(out)	VALEUR,
		integer, intent(in)	INDEX1,
		integer, intent(in)	INDEX2,
		integer, intent(in)	INDEX3,
		integer, intent(out)	IERR
	)

Brief:

Get a boolean variable

Parameters

[in]	ID	Id of the instance
[in]	TAG	Short of the module to use (t2d,sis...)
[in]	VARNAME	Name of the variable to read
[out]	VALEUR	Containis the read value
[in]	INDEX1	Index on the first dimension
[in]	INDEX2	Index on the second dimension
[in]	INDEX3	Index on the third dimension
[out]	IERR	0 if subroutine successfull, error id otherwise

Definition at line 814 of file api_interface.f.

Here is the call graph for this function:

get_double()

subroutine api_interface::get_double	(	integer, intent(in)	ID,
		character(len=3), intent(in)	TAG,
		character(len=t2d_var_len), intent(in)	VARNAME,
		double precision, intent(out)	VALEUR,
		integer, intent(inout)	INDEX1,
		integer, intent(inout)	INDEX2,
		integer, intent(inout)	INDEX3,
		integer, intent(out)	IERR
	)

Brief:

Get a double variable

Parameters

[in]	ID	Id of the instance
[in]	TAG	Short of the module to use (t2d,sis...)
[in]	VARNAME	Name of the variable to read
[out]	VALEUR	Containis the read value
[in]	INDEX1	Index on the first dimension
[in]	INDEX2	Index on the second dimension
[in]	INDEX3	Index on the third dimension
[out]	IERR	0 if subroutine successfull, error id otherwise

Definition at line 503 of file api_interface.f.

Here is the call graph for this function:

get_double_array()

subroutine api_interface::get_double_array	(	integer, intent(in)	ID,
		character(len=3), intent(in)	TAG,
		character(len=t2d_var_len), intent(in)	VARNAME,
		double precision, dimension(dim1), intent(inout)	VALEUR,
		integer, intent(in)	DIM1,
		integer, intent(out)	IERR,
		integer, intent(in), optional	BLOCK_INDEX
	)

Brief:

Get a double array

Parameters

[in]	ID	Id of the instance
[in]	TAG	Short of the module to use (t2d,sis...)
[in]	VARNAME	Name of the variable to read
[in,out]	VALEUR	Contaings the read value
[in]	DIM1	Dimension of the array
[out]	IERR	0 if subroutine successfull, error id otherwise
[in]	BLOCK_INDEX	Used for bief bloc represent index of the array in the bloc to extract

Definition at line 236 of file api_interface.f.

Here is the call graph for this function:

get_error_message()

subroutine api_interface::get_error_message	(	integer, intent(in)	ID,
		character(len=3), intent(in)	TAG,
		integer, intent(in)	IERR,
		character(len=error_mess_len), intent(out)	MESS
	)

Brief:

Returns the error message of the instance

Parameters

[in]	ID	Id of the instance
[in]	TAG	Short of the module to use (t2d,sis...)
[in]	IERR	Error code
[out]	MESS	The error message

Definition at line 1065 of file api_interface.f.

Here is the call graph for this function:

Here is the caller graph for this function:

get_integer()

subroutine api_interface::get_integer	(	integer, intent(in)	ID,
		character(len=3), intent(in)	TAG,
		character(len=t2d_var_len), intent(in)	VARNAME,
		integer, intent(out)	VALEUR,
		integer, intent(in)	INDEX1,
		integer, intent(in)	INDEX2,
		integer, intent(in)	INDEX3,
		integer, intent(out)	IERR
	)

Brief:

Get an integer variable

Parameters

[in]	ID	Id of the instance
[in]	TAG	Short of the module to use (t2d,sis...)
[in]	VARNAME	Name of the variable to read
[out]	VALEUR	Containis the read value
[in]	INDEX1	Index on the first dimension
[in]	INDEX2	Index on the second dimension
[in]	INDEX3	Index on the third dimension
[out]	IERR	0 if subroutine successfull, error id otherwise

Definition at line 604 of file api_interface.f.

Here is the call graph for this function:

Here is the caller graph for this function:

get_integer_array()

subroutine api_interface::get_integer_array	(	integer, intent(in)	ID,
		character(len=3), intent(in)	TAG,
		character(len=t2d_var_len), intent(in)	VARNAME,
		integer, dimension(dim1), intent(inout)	VALEUR,
		integer, intent(in)	DIM1,
		integer, intent(out)	IERR
	)

Brief:

Get a integer array

Parameters

[in]	ID	Id of the instance
[in]	TAG	Short of the module to use (t2d,sis...)
[in]	VARNAME	Name of the variable to read
[in,out]	VALEUR	Containis the read value
[in]	DIM1	Dimension of the array
[out]	IERR	0 if subroutine successfull, error id otherwise

Definition at line 401 of file api_interface.f.

Here is the call graph for this function:

get_string()

subroutine api_interface::get_string	(	integer, intent(in)	ID,
		character(len=3), intent(in)	TAG,
		character(len=t2d_var_len), intent(in)	VARNAME,
		character(len=250), intent(out)	VALEUR,
		integer, intent(in)	VALUELEN,
		integer, intent(in)	INDEX1,
		integer, intent(in)	INDEX2,
		integer, intent(out)	IERR
	)

Brief:

Get a string variable

Parameters

[in]	ID	Id of the instance
[in]	TAG	Short of the module to use (t2d,sis...)
[in]	VARNAME	Name of the variable to read
[out]	VALEUR	Containis the read value
[in]	VALUELEN	Length of the string
[in]	INDEX1	Index on the first dimension
[in]	INDEX2	Index on the second dimension
[out]	IERR	0 if subroutine successfull, error id otherwise

Definition at line 704 of file api_interface.f.

Here is the call graph for this function:

Here is the caller graph for this function:

get_var_list()

subroutine api_interface::get_var_list	(	character(len=3), intent(in)	TAG,
		character(len=t2d_var_len), dimension(*), intent(inout)	VARNAME,
		character(len=t2d_info_len), dimension(*), intent(inout)	VARINFO,
		integer, intent(out)	IERR
	)

Brief:

Get a description of each variable

Parameters

[in]	TAG	Short of the module to use (t2d,sis...)
[out]	VARNAME	List of all the variables
[out]	VARINFO	List of all the descriptions
[out]	IERR	0 if subroutine successfull, error id otherwise

Definition at line 1015 of file api_interface.f.

get_var_size()

subroutine api_interface::get_var_size	(	integer, intent(in)	ID,
		character(len=3), intent(in)	TAG,
		character(len=t2d_var_len), intent(in)	VARNAME,
		integer, intent(out)	DIM1,
		integer, intent(out)	DIM2,
		integer, intent(out)	DIM3,
		integer, intent(out)	IERR
	)

Brief:

Get the size of each dimension of a varaible

Parameters

[in]	ID	Id of the instance
[in]	TAG	Short of the module to use (t2d,sis...)
[in]	VARNAME	Name of the varaible
[out]	DIM1	Size of the first dimension
[out]	DIM2	Size of the second dimension
[out]	DIM3	Size of the third dimension
[out]	IERR	0 if subroutine successfull, error id otherwise

Definition at line 972 of file api_interface.f.

Here is the call graph for this function:

Here is the caller graph for this function:

get_var_type()

subroutine api_interface::get_var_type	(	character(len=3), intent(in)	TAG,
		character(len=t2d_var_len), intent(in)	VARNAME,
		character(len=t2d_type_len), intent(out)	VARTYPE,
		logical, intent(out)	READONLY,
		integer, intent(out)	NDIM,
		integer, intent(out)	IENT,
		integer, intent(out)	JENT,
		integer, intent(out)	KENT,
		integer, intent(out)	GETPOS,
		integer, intent(out)	SETPOS,
		integer, intent(out)	IERR
	)

Brief:

Get informations on a variable

Parameters

[in]	TAG	Short of the module to use (t2d,sis...)
[in]	VARNAME	Name of the variable
[out]	VARTYPE	Type of the variable (INTEGER, DOUBLE, STRING, BOOLEAN)
[out]	READONLY	0 if the variable is read only 1 IF IT IS WRITTABLE
[out]	NDIM	Number of dimension (0 IF IT IS NOT AN ARRAY)
[out]	IENT	1 if the numbering is on point
[out]	JENT	1 if the numbering is on point
[out]	KENT	1 if the numbering is on point
[out]	GETPOS	1 if the numbering is on point
[out]	SETPOS	1 if the numbering is on point
[out]	IERR	0 if subroutine successfull, error id otherwise

Definition at line 921 of file api_interface.f.

Here is the call graph for this function:

identify_liq_bnd()

subroutine api_interface::identify_liq_bnd	(	integer, dimension(nelem2*3), intent(in)	IKLES,
		integer, intent(in)	DIM_MESH,
		integer, intent(in)	NPTFR,
		integer, intent(in)	NPOIN,
		integer, intent(in)	NELEM2,
		integer, dimension(nptfr), intent(in)	LIUBOR,
		integer, dimension(nptfr), intent(in)	LIHBOR,
		integer, dimension(nptfr), intent(inout)	NBOR,
		double precision, dimension(npoin*2), intent(in)	COORD,
		integer, dimension(nptfr), intent(out)	NELBOR,
		integer, dimension(nelem2,3), intent(out)	IFABOR,
		integer, dimension(nptfr,2), intent(out)	KP1BOR,
		integer, dimension(nptfr), intent(out)	NUMLIQ,
		logical, intent(in)	LISTIN
	)

Brief:

Identify the liquid boundaries

Parameters

[in]	IKLES	Connectivity array 1d form
[in]	DIM_MESH	Dimension of the mesh
[in]	NPTFR	Number of boundary points
[in]	NPOIN	Number of points
[in,out]	NELEM2	Number of 2d elements
[in]	LIUBOR	Boundary value for velocity
[in]	LIHBOR	Boundary value for height
[in,out]	NBOR	Boundary numbering array
[in]	COORD	Coordinates
[out]	NELBOR	Number of boundary elements
[out]	IFABOR	Array for boundaries
[out]	KP1BOR	Neigbouring boundary nodes array
[out]	NUMLIQ	Array for liquid boundaries
[in]	LISTIN	If true display boundaries info

Definition at line 2324 of file api_interface.f.

Here is the call graph for this function:

run_allocation_art()

subroutine api_interface::run_allocation_art	(	integer, intent(in)	ID,
		integer, intent(out)	IERR
	)

Brief:

Allocate all of artemis variables

Parameters

[in]	ID	Id of the instance
[out]	IERR	0 if subroutine successfull, error id otherwise

Definition at line 1957 of file api_interface.f.

Here is the call graph for this function:

Here is the caller graph for this function:

run_allocation_sis()

subroutine api_interface::run_allocation_sis	(	integer, intent(in)	ID,
		integer, intent(out)	IERR
	)

Brief:

Allocate all of sisyphe variables

Parameters

[in]	ID	Id of the instance
[out]	IERR	0 if subroutine successfull, error id otherwise

Definition at line 1648 of file api_interface.f.

Here is the call graph for this function:

Here is the caller graph for this function:

run_allocation_t2d()

subroutine api_interface::run_allocation_t2d	(	integer, intent(in)	ID,
		integer, intent(out)	IERR
	)

Brief:

Allocate all of telemac2d variables

Parameters

[in]	ID	Id of the instance
[out]	IERR	0 if subroutine successfull, error id otherwise

Definition at line 1211 of file api_interface.f.

Here is the call graph for this function:

Here is the caller graph for this function:

run_allocation_t3d()

subroutine api_interface::run_allocation_t3d	(	integer, intent(in)	ID,
		integer, intent(out)	IERR
	)

Brief:

Allocate all of telemac3d variables

Parameters

[in]	ID	Id of the instance
[out]	IERR	0 if subroutine successfull, error id otherwise

Definition at line 1456 of file api_interface.f.

Here is the call graph for this function:

Here is the caller graph for this function:

run_allocation_wac()

subroutine api_interface::run_allocation_wac	(	integer, intent(in)	ID,
		integer, intent(out)	IERR
	)

Brief:

Allocate all of tomawac variables

Parameters

[in]	ID	Id of the instance
[out]	IERR	0 if subroutine successfull, error id otherwise

Definition at line 2148 of file api_interface.f.

Here is the call graph for this function:

Here is the caller graph for this function:

run_finalize_art()

subroutine api_interface::run_finalize_art	(	integer, intent(in)	ID,
		integer, intent(out)	IERR
	)

Brief:

Finalize a artemis run

Parameters

[in]	ID	Id of the instance
[out]	IERR	0 if subroutine successfull, error id otherwise

Definition at line 2038 of file api_interface.f.

Here is the call graph for this function:

Here is the caller graph for this function:

run_finalize_sis()

subroutine api_interface::run_finalize_sis	(	integer, intent(in)	ID,
		integer, intent(out)	IERR
	)

Brief:

Finalize a sisyphe run

Parameters

[in]	ID	Id of the instance
[out]	IERR	0 if subroutine successfull, error id otherwise

Definition at line 1729 of file api_interface.f.

Here is the call graph for this function:

Here is the caller graph for this function:

run_finalize_t2d()

subroutine api_interface::run_finalize_t2d	(	integer, intent(in)	ID,
		integer, intent(out)	IERR
	)

Brief:

Finalize a telemac2d run

Parameters

[in]	ID	Id of the instance
[out]	IERR	0 if subroutine successfull, error id otherwise

Definition at line 1334 of file api_interface.f.

Here is the call graph for this function:

Here is the caller graph for this function:

run_finalize_t3d()

subroutine api_interface::run_finalize_t3d	(	integer, intent(in)	ID,
		integer, intent(out)	IERR
	)

Brief:

Finalize a telemac3d run

Parameters

[in]	ID	Id of the instance
[out]	IERR	0 if subroutine successfull, error id otherwise

Definition at line 1537 of file api_interface.f.

Here is the call graph for this function:

Here is the caller graph for this function:

run_finalize_wac()

subroutine api_interface::run_finalize_wac	(	integer, intent(in)	ID,
		integer, intent(out)	IERR
	)

Brief:

Finalize a tomawac run

Parameters

[in]	ID	Id of the instance
[out]	IERR	0 if subroutine successfull, error id otherwise

Definition at line 2229 of file api_interface.f.

Here is the call graph for this function:

Here is the caller graph for this function:

run_gretel()

subroutine api_interface::run_gretel	(	character(len=3), intent(in)	CODE,
		character(len=250), intent(in)	GEO,
		character(len=8), intent(inout)	GEOFORMAT,
		character(len=250), intent(in)	BND,
		character(len=250), intent(in)	RES,
		character(len=8), intent(inout)	RESFORMAT,
		integer, intent(in)	NPROC,
		integer, intent(inout)	NPLAN_RES,
		integer, intent(in)	METHOD
	)

Brief:

Running gretel

Parameters

[in]	CODE	Short name of code for wich running partel (T2D, T3D...)
[in]	GEO	Name of the geometry file
[in,out]	GEOFORMAT	Format of the geometry file
[in]	BND	Name of the boudnary file
[in]	RES	Name of the result file
[in,out]	RESFORMAT	Format of the result file
[in]	NPROC	Number of processors
[in]	NPLAN_RES	Number of planes for the result file
[in]	METHOD	Method to merge data information

Definition at line 160 of file api_interface.f.

Here is the call graph for this function:

run_init_art()

subroutine api_interface::run_init_art	(	integer, intent(in)	ID,
		integer, intent(out)	IERR
	)

Brief:

Initialise the artemis variables

Parameters

[in]	ID	Id of the instance
[out]	IERR	0 if subroutine successfull, error id otherwise

Definition at line 1985 of file api_interface.f.

Here is the call graph for this function:

Here is the caller graph for this function:

run_init_sis()

subroutine api_interface::run_init_sis	(	integer, intent(in)	ID,
		integer, intent(out)	IERR
	)

Brief:

Initialise the sisyphe variables

Parameters

[in]	ID	Id of the instance
[out]	IERR	0 if subroutine successfull, error id otherwise

Definition at line 1676 of file api_interface.f.

Here is the call graph for this function:

Here is the caller graph for this function:

run_init_t2d()

subroutine api_interface::run_init_t2d	(	integer, intent(in)	ID,
		integer, intent(out)	IERR
	)

Brief:

Initialise the telemac2d variables

Parameters

[in]	ID	Id of the instance
[out]	IERR	0 if subroutine successfull, error id otherwise

Definition at line 1239 of file api_interface.f.

Here is the call graph for this function:

Here is the caller graph for this function:

run_init_t3d()

subroutine api_interface::run_init_t3d	(	integer, intent(in)	ID,
		integer, intent(out)	IERR
	)

Brief:

Initialise the telemac3d variables

Parameters

[in]	ID	Id of the instance
[out]	IERR	0 if subroutine successfull, error id otherwise

Definition at line 1484 of file api_interface.f.

Here is the call graph for this function:

Here is the caller graph for this function:

run_init_wac()

subroutine api_interface::run_init_wac	(	integer, intent(in)	ID,
		integer, intent(out)	IERR
	)

Brief:

Initialise the tomawac variables

Parameters

[in]	ID	Id of the instance
[out]	IERR	0 if subroutine successfull, error id otherwise

Definition at line 2176 of file api_interface.f.

Here is the call graph for this function:

Here is the caller graph for this function:

run_parres()

subroutine api_interface::run_parres	(	character(len=3), intent(in)	CODE,
		character(len=250), intent(in)	NAMEGEO,
		character(len=250), intent(in)	NAMEINP,
		integer, intent(in)	NPARTS,
		character(len=8), intent(inout)	GEOFORMAT,
		character(len=8), intent(inout)	INPFORMAT,
		integer, intent(out)	IERR
	)

Brief:

Run parres

Parameters

[in]	CODE	Short name of code for wich running partel (T2D, T3D...)
[in]	NAMEGEO	Name of the geometry file
[in]	NAMEINP	Name of the file to be partitionned
[in]	NPARTS	Number of partitions
[in]	GEOFORMAT	Format of the geometry file
[in]	INPFORMAT	Format of the file to be partitioned
[out]	ierr	0 if subroutine successfull, error id otherwise

Definition at line 114 of file api_interface.f.

Here is the call graph for this function:

run_partel()

subroutine api_interface::run_partel	(	character(len=3), intent(in)	CODE,
		character(len=250), intent(in)	NAMEINP,
		character(len=250), intent(in)	NAMECLI,
		integer, intent(in)	NPARTS,
		integer, intent(in)	PMETHOD,
		character(len=8), intent(inout)	FFORMAT,
		character(len=250), intent(in)	NAMESEC,
		character(len=250), intent(in)	NAMEZFI,
		character(len=250), intent(in)	NAMESEU,
		integer, intent(out)	IERR
	)

Brief:

Run partel

Parameters

[in]	CODE	Short name of code for wich running partel (T2D, T3D...)
[in]	NAMEINP	Name of the geometry file
[in]	NAMECLI	Name of the boundary conditions file
[in]	NPARTS	Number of partitions
[in]	PMETHOD	1: for metis 2: for scotch
[in]	FFORMAT	Format of the geometry file
[in]	NAMESEC	Name of the section file ' ' if there are none
[in]	NAMEZFI	Name of the friction zone file ' ' if there are none
[in]	NAMESEU	Name of the weir file ' ' if there are none
[out]	ierr	0 if subroutine successfull, error id otherwise

Definition at line 56 of file api_interface.f.

Here is the call graph for this function:

run_read_case_art()

subroutine api_interface::run_read_case_art	(	integer, intent(in)	ID,
		character(len=250), intent(in)	CAS_FILE,
		character(len=250), intent(in)	DICO_FILE,
		logical, intent(in)	INIT,
		integer, intent(out)	IERR
	)

Brief:

Reads the case file

Parameters

[in]	ID	Id of the instance
[in]	CAS_FILE	Path to the case file
[in]	DICO_FILE	Path to the dictionary file
[in]	INIT	If true p_init is called
[out]	IERR	0 if subroutine successfull, error id otherwise

Definition at line 1924 of file api_interface.f.

Here is the call graph for this function:

Here is the caller graph for this function:

run_read_case_sis()

subroutine api_interface::run_read_case_sis	(	integer, intent(in)	ID,
		character(len=24), intent(in)	CODE,
		character(len=250), intent(in)	CAS_FILE,
		character(len=250), intent(in)	DICO_FILE,
		logical, intent(in)	INIT,
		integer, intent(out)	IERR
	)

Brief:

Reads the case file

Parameters

[in]	ID	Id of the instance
[in]	CODE	Code for coupled call
[in]	CAS_FILE	Path to the case file
[in]	DICO_FILE	Path to the dictionary file
[in]	INIT	If true p_init is called
[out]	IERR	0 if subroutine successfull, error id otherwise

Definition at line 1614 of file api_interface.f.

Here is the call graph for this function:

Here is the caller graph for this function:

run_read_case_t2d()

subroutine api_interface::run_read_case_t2d	(	integer, intent(in)	ID,
		character(len=250), intent(in)	CAS_FILE,
		character(len=250), intent(in)	DICO_FILE,
		logical, intent(in)	INIT,
		integer, intent(out)	IERR,
		character(len=250), intent(in)	GAIA_CAS,
		character(len=250), intent(in)	GAIA_DICO
	)

Brief:

Reads the case file

Parameters

[in]	ID	Id of the instance
[in]	CAS_FILE	Path to the case file
[in]	DICO_FILE	Path to the dictionary file
[in]	INIT	If true p_init is called
[out]	IERR	0 if subroutine successfull, error id otherwise
[in]	GAIA_CAS	Path to the gaia case file
[in]	GAIA_DICO	Path to the gaia dictionary file

Definition at line 1174 of file api_interface.f.

Here is the call graph for this function:

Here is the caller graph for this function:

run_read_case_t3d()

subroutine api_interface::run_read_case_t3d	(	integer, intent(in)	ID,
		character(len=250), intent(in)	CAS_FILE,
		character(len=250), intent(in)	DICO_FILE,
		logical, intent(in)	INIT,
		integer, intent(out)	IERR,
		character(len=250), intent(in)	WAQ_CAS_FILE,
		character(len=250), intent(in)	WAQ_DICO_FILE,
		character(len=250), intent(in)	GAIA_CAS_FILE,
		character(len=250), intent(in)	GAIA_DICO_FILE
	)

Brief:

Reads the case file

Parameters

[in]	ID	Id of the instance
[in]	CAS_FILE	Path to the case file
[in]	DICO_FILE	Path to the dictionary file
[in]	INIT	If true p_init is called
[out]	IERR	0 if subroutine successfull, error id otherwise
[in]	WAQ_CAS_FILE	Path to the gaia case file
[in]	WAQ_DICO_FILE	Path to the gaia dictionary file
[in]	GAIA_CAS_FILE	Path to the gaia case file
[in]	GAIA_DICO_FILE	Path to the gaia dictionary file

Definition at line 1417 of file api_interface.f.

Here is the call graph for this function:

Here is the caller graph for this function:

run_read_case_wac()

subroutine api_interface::run_read_case_wac	(	integer, intent(in)	ID,
		character(len=250), intent(in)	CAS_FILE,
		character(len=250), intent(in)	DICO_FILE,
		logical, intent(in)	INIT,
		integer, intent(out)	IERR
	)

Brief:

Reads the case file

Parameters

[in]	ID	Id of the instance
[in]	CAS_FILE	Path to the case file
[in]	DICO_FILE	Path to the dictionary file
[in]	INIT	If true p_init is called
[out]	IERR	0 if subroutine successfull, error id otherwise

Definition at line 2115 of file api_interface.f.

Here is the call graph for this function:

Here is the caller graph for this function:

run_set_config_art()

subroutine api_interface::run_set_config_art	(	integer, intent(out)	ID,
		integer, intent(in)	LU,
		integer, intent(in)	LNG,
		integer, intent(in)	COMM,
		integer, intent(out)	IERR
	)

Brief:

Initialise the instance and set the output

Parameters

[out]	ID	Id of the instance
[in]	LU	Output stream id
[in]	LNG	Output language 2 english 1 french
[in]	COMM	Mpi communicator
[out]	IERR	0 if subroutine successfull, error id otherwise

Definition at line 1888 of file api_interface.f.

Here is the call graph for this function:

Here is the caller graph for this function:

run_set_config_sis()

subroutine api_interface::run_set_config_sis	(	integer, intent(out)	ID,
		integer, intent(in)	LU,
		integer, intent(in)	LNG,
		integer, intent(in)	COMM,
		integer, intent(out)	IERR
	)

Brief:

Initialise the instance and set the output

Parameters

[out]	ID	Id of the instance
[in]	LU	Output stream id
[in]	LNG	Output language 2 english 1 french
[in]	COMM	Mpi communicator
[out]	IERR	0 if subroutine successfull, error id otherwise

Definition at line 1577 of file api_interface.f.

Here is the call graph for this function:

Here is the caller graph for this function:

run_set_config_t2d()

subroutine api_interface::run_set_config_t2d	(	integer, intent(out)	ID,
		integer, intent(in)	LU,
		integer, intent(in)	LNG,
		integer, intent(in)	COMM,
		integer, intent(out)	IERR
	)

Brief:

Initialise the instance and set the output

Parameters

[out]	ID	Id of the instance
[in]	LU	Output stream id
[in]	LNG	Output language 2 english 1 french
[in]	COMM	Mpi communicator
[out]	IERR	0 if subroutine successfull, error id otherwise

Definition at line 1116 of file api_interface.f.

Here is the call graph for this function:

Here is the caller graph for this function:

run_set_config_t3d()

subroutine api_interface::run_set_config_t3d	(	integer, intent(out)	ID,
		integer, intent(in)	LU,
		integer, intent(in)	LNG,
		integer, intent(in)	COMM,
		integer, intent(out)	IERR
	)

Brief:

Initialise the instance and set the output

Parameters

[out]	ID	Id of the instance
[in]	LU	Output stream id
[in]	LNG	Output language 2 english 1 french
[in]	COMM	Mpi communicator
[out]	IERR	0 if subroutine successfull, error id otherwise

Definition at line 1375 of file api_interface.f.

Here is the call graph for this function:

Here is the caller graph for this function:

run_set_config_wac()

subroutine api_interface::run_set_config_wac	(	integer, intent(out)	ID,
		integer, intent(in)	LU,
		integer, intent(in)	LNG,
		integer, intent(in)	COMM,
		integer, intent(out)	IERR
	)

Brief:

Initialise the instance and set the output

Parameters

[out]	ID	Id of the instance
[in]	LU	Output stream id
[in]	LNG	Output language 2 english 1 french
[in]	COMM	Mpi communicator
[out]	IERR	0 if subroutine successfull, error id otherwise

Definition at line 2079 of file api_interface.f.

Here is the call graph for this function:

Here is the caller graph for this function:

run_timestep_art()

subroutine api_interface::run_timestep_art	(	integer, intent(in)	ID,
		integer, intent(out)	IERR
	)

Brief:

RUN A TIMESTEP IN ARTEMIS

Parameters

[in]	ID	Id of the instance
[out]	IERR	0 if subroutine successfull, error id otherwise

Definition at line 2011 of file api_interface.f.

Here is the call graph for this function:

Here is the caller graph for this function:

run_timestep_compute_t2d()

subroutine api_interface::run_timestep_compute_t2d	(	integer, intent(in)	ID,
		integer, intent(out)	IERR
	)

Brief:

Run a timestep in telemac2d without writing results

Parameters

[in]	ID	Id of the instance
[out]	IERR	0 if subroutine successfull, error id otherwise

Definition at line 1282 of file api_interface.f.

Here is the call graph for this function:

Here is the caller graph for this function:

run_timestep_res_t2d()

subroutine api_interface::run_timestep_res_t2d	(	integer, intent(in)	ID,
		integer, intent(out)	IERR
	)

Brief:

Run a timestep in telemac2d only writing results

Parameters

[in]	ID	Id of the instance
[out]	IERR	0 if subroutine successfull, error id otherwise

Definition at line 1308 of file api_interface.f.

Here is the call graph for this function:

Here is the caller graph for this function:

run_timestep_sis()

subroutine api_interface::run_timestep_sis	(	integer, intent(in)	ID,
		integer, intent(out)	IERR
	)

Brief:

Run a timestep in sisyphe

Parameters

[in]	ID	Id of the instance
[out]	IERR	0 if subroutine successfull, error id otherwise

Definition at line 1702 of file api_interface.f.

Here is the call graph for this function:

Here is the caller graph for this function:

run_timestep_sis_cpl()

subroutine api_interface::run_timestep_sis_cpl	(	integer, intent(in)	ID_T2D,
		integer, intent(in)	ID_SIS,
		integer, intent(out)	IERR
	)

Brief:

Run sisyphe in case of coupling : bedload vs suspension

Parameters

[in]	ID_T2D	The instance
[in]	ID_SIS	The instance
[out]	IERR	0 if subroutine successfull, error id otherwise

Definition at line 2265 of file api_interface.f.

Here is the call graph for this function:

Here is the caller graph for this function:

run_timestep_t2d()

subroutine api_interface::run_timestep_t2d	(	integer, intent(in)	ID,
		integer, intent(out)	IERR
	)

Brief:

Run a timestep in telemac2d

Parameters

[in]	ID	Id of the instance
[out]	IERR	0 if subroutine successfull, error id otherwise

Definition at line 1265 of file api_interface.f.

Here is the call graph for this function:

Here is the caller graph for this function:

run_timestep_t3d()

subroutine api_interface::run_timestep_t3d	(	integer, intent(in)	ID,
		integer, intent(out)	IERR
	)

Brief:

Run a timestep in telemac3d

Parameters

[in]	ID	Id of the instance
[out]	IERR	0 if subroutine successfull, error id otherwise

Definition at line 1510 of file api_interface.f.

Here is the call graph for this function:

Here is the caller graph for this function:

run_timestep_wac()

subroutine api_interface::run_timestep_wac	(	integer, intent(in)	ID,
		integer, intent(out)	IERR
	)

Brief:

Run a timestep in tomawac

Parameters

[in]	ID	Id of the instance
[out]	IERR	0 if subroutine successfull, error id otherwise

Definition at line 2202 of file api_interface.f.

Here is the call graph for this function:

Here is the caller graph for this function:

save_charr_susp()

subroutine api_interface::save_charr_susp	(	integer, intent(in)	ID_T2D,
		integer, intent(in)	ID_SIS,
		integer, intent(out)	IERR
	)

Brief:

Saves original charr and susp values after first sisyphe call

Parameters

[in]	ID_T2D	Id of the telemac2d instance
[in]	ID_SIS	Id of the sisyphe instance
[out]	IERR	0 if subroutine successfull, error id otherwise

Definition at line 1764 of file api_interface.f.

Here is the call graph for this function:

Here is the caller graph for this function:

set_boolean()

subroutine api_interface::set_boolean	(	integer, intent(in)	ID,
		character(len=3), intent(in)	TAG,
		character(len=t2d_var_len), intent(in)	VARNAME,
		integer, intent(in)	VALEUR,
		integer, intent(in)	INDEX1,
		integer, intent(in)	INDEX2,
		integer, intent(in)	INDEX3,
		integer, intent(out)	IERR
	)

Brief:

Defines the value of a boolean variable

Parameters

[in]	ID	Id of the instance
[in]	TAG	Short of the module to use (t2d,sis...)
[in]	VARNAME	Name of the variable to write
[in]	VALEUR	The value to write in the variable
[in]	INDEX1	Index on the first dimension
[in]	INDEX2	Index on the second dimension
[in]	INDEX3	Index on the third dimension
[out]	IERR	0 if subroutine successfull, error id otherwise

Definition at line 864 of file api_interface.f.

Here is the call graph for this function:

set_double()

subroutine api_interface::set_double	(	integer, intent(in)	ID,
		character(len=3), intent(in)	TAG,
		character(len=t2d_var_len), intent(in)	VARNAME,
		double precision, intent(in)	VALEUR,
		integer, intent(in)	INDEX1,
		integer, intent(in)	INDEX2,
		integer, intent(in)	INDEX3,
		integer, intent(out)	IERR
	)

Brief:

Defines the value of a double variable

Parameters

[in]	ID	Id of the instance
[in]	TAG	Short of the module to use (t2d,sis...)
[in]	VARNAME	Name of the variable to write
[in]	VALEUR	The value to write in the variable
[in]	INDEX1	Index on the first dimension
[in]	INDEX2	Index on the second dimension
[in]	INDEX3	Index on the third dimension
[out]	IERR	0 if subroutine successfull, error id otherwise

Definition at line 554 of file api_interface.f.

Here is the call graph for this function:

set_double_array()

subroutine api_interface::set_double_array	(	integer, intent(in)	ID,
		character(len=3), intent(in)	TAG,
		character(len=t2d_var_len), intent(in)	VARNAME,
		double precision, dimension(dim1), intent(in)	VALEUR,
		integer, intent(in)	DIM1,
		integer, intent(out)	IERR,
		integer, intent(in), optional	BLOCK_INDEX
	)

Brief:

Set a double array

Parameters

[in]	ID	Id of the instance
[in]	TAG	Short of the module to use (t2d,sis...)
[in]	VARNAME	Name of the variable to read
[in,out]	VALEUR	Containis the read value
[in]	DIM1	Dimension of the array
[out]	IERR	0 if subroutine successfull, error id otherwise
[in]	BLOCK_INDEX	Used for bief bloc represent index of the array in the bloc to extract

Definition at line 320 of file api_interface.f.

Here is the call graph for this function:

set_integer()

subroutine api_interface::set_integer	(	integer, intent(in)	ID,
		character(len=3), intent(in)	TAG,
		character(len=t2d_var_len), intent(in)	VARNAME,
		integer, intent(in)	VALEUR,
		integer, intent(in)	INDEX1,
		integer, intent(in)	INDEX2,
		integer, intent(in)	INDEX3,
		integer, intent(out)	IERR
	)

Brief:

Defines the value of an integer variable

Parameters

[in]	ID	Id of the instance
[in]	TAG	Short of the module to use (t2d,sis...)
[in]	VARNAME	Name of the variable to write
[in]	VALEUR	The value to write in the variable
[in]	INDEX1	Index on the first dimension
[in]	INDEX2	Index on the second dimension
[in]	INDEX3	Index on the third dimension
[out]	IERR	0 if subroutine successfull, error id otherwise

Definition at line 654 of file api_interface.f.

Here is the call graph for this function:

Here is the caller graph for this function:

set_integer_array()

subroutine api_interface::set_integer_array	(	integer, intent(in)	ID,
		character(len=3), intent(in)	TAG,
		character(len=t2d_var_len), intent(in)	VARNAME,
		integer, dimension(dim1), intent(in)	VALEUR,
		integer, intent(in)	DIM1,
		integer, intent(out)	IERR
	)

Brief:

Set a integer array

Parameters

[in]	ID	Id of the instance
[in]	TAG	Short of the module to use (t2d,sis...)
[in]	VARNAME	Name of the variable to read
[in,out]	VALEUR	Containis the read value
[in]	DIM1	Dimension of the array
[out]	IERR	0 if subroutine successfull, error id otherwise

Definition at line 451 of file api_interface.f.

Here is the call graph for this function:

set_string()

subroutine api_interface::set_string	(	integer, intent(in)	ID,
		character(len=3), intent(in)	TAG,
		character(len=t2d_var_len), intent(in)	VARNAME,
		character, dimension(valuelen), intent(in)	VALEUR,
		integer, intent(in)	VALUELEN,
		integer, intent(in)	INDEX1,
		integer, intent(in)	INDEX2,
		integer, intent(out)	IERR
	)

Brief:

Defines the value of a string variable

Parameters

[in]	ID	Id of the instance
[in]	TAG	Short of the module to use (t2d,sis...)
[in]	VARNAME	Name of the variable to write
[in]	VALEUR	The value to write in the variable
[in]	VALUELEN	Length of the string
[in]	INDEX1	Index on the first dimension
[in]	INDEX2	Index on the second dimension
[out]	IERR	0 if subroutine successfull, error id otherwise

Definition at line 764 of file api_interface.f.

Here is the call graph for this function:

Here is the caller graph for this function:

set_var_sis()

subroutine api_interface::set_var_sis	(	integer, intent(in)	ID_T2D,
		integer, intent(in)	ID_SIS,
		integer, intent(in)	CALL_TYPE,
		integer, intent(out)	IERR
	)

Brief:

Sets loop variables for sisyphe in case of coupling

Parameters

[in]	ID_T2D	Id of the telemac2d instance
[in]	ID_SIS	Id of the sisyphe instance
[in]	CALL_TYPE	Defines which sisyphe call = 0 Means Initializing = 1 Means Bedload CALL = 2 Means Suspension CALL
[out]	IERR	0 if subroutine successfull, error id otherwise

Definition at line 1828 of file api_interface.f.

Here is the call graph for this function:

Here is the caller graph for this function:

set_var_t2d()

subroutine api_interface::set_var_t2d	(	integer, intent(in)	ID_T2D,
		integer, intent(in)	ID_SIS,
		integer, intent(out)	IERR
	)

Brief:

Sends variables to telemac2d after sisyphe call

Parameters

[in]	ID_T2D	Id of the telemac2d instance
[in]	ID_SIS	Id of the sisyphe instance
[out]	IERR	0 if subroutine successfull, error id otherwise

Definition at line 1854 of file api_interface.f.

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

global_to_local_point

integer, external api_interface::global_to_local_point

Definition at line 29 of file api_interface.f.

str_len

integer, parameter api_interface::str_len = 250

Definition at line 30 of file api_interface.f.