api_run_sis Module Reference

Functions/Subroutines
subroutine, public	run_set_config_sis_d (INST, U_LU, U_LNG, U_COMM, U_STD_OUTPUT, IERR)
subroutine, public	run_read_case_sis_d (INST, CODE1, CAS_FILE, DICO_FILE, INIT, IERR)
subroutine, public	run_allocation_sis_d (INST, IERR)
subroutine, public	run_init_sis_d (INST, IERR)
subroutine, public	run_timestep_sis_d (INST, IERR)
subroutine, public	run_finalize_sis_d (INST, IERR)

Variables
integer	tdeb
integer	tfin
integer	iflot
integer	ncar
integer	nit_ori
integer	nit_to_do
character(len=24), parameter	code ='SISYPHE '
character(len=maxlentmpdir)	path
character(len=250), dimension(300)	motcar
character(len=250), dimension(4, 300)	file_desc
integer, external	time_in_seconds

Detailed Description

Brief:

$function to control sisyphe execution

Function/Subroutine Documentation

run_allocation_sis_d()

subroutine, public api_run_sis::run_allocation_sis_d	(	type(instance_sis), intent(inout)	INST,
		integer, intent(out)	IERR
	)

Brief:

Allocate all of sisyphe variables

Parameters

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

Definition at line 122 of file api_run_sis.f.

Here is the call graph for this function:

Here is the caller graph for this function:

run_finalize_sis_d()

subroutine, public api_run_sis::run_finalize_sis_d	(	type(instance_sis), intent(inout)	INST,
		integer, intent(out)	IERR
	)

Brief:

Finalize a sisyphe run

Parameters

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

Definition at line 219 of file api_run_sis.f.

Here is the call graph for this function:

Here is the caller graph for this function:

run_init_sis_d()

subroutine, public api_run_sis::run_init_sis_d	(	type(instance_sis), intent(inout)	INST,
		integer, intent(out)	IERR
	)

Brief:

Initialise the sisyphe variables

Parameters

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

Definition at line 146 of file api_run_sis.f.

Here is the call graph for this function:

Here is the caller graph for this function:

run_read_case_sis_d()

subroutine, public api_run_sis::run_read_case_sis_d	(	type(instance_sis), intent(inout)	INST,
		character(len=24), intent(in)	CODE1,
		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,out]	INST	The instance
[in]	CODE1	Name of the code calling the function (TELEMAC2D when coupling)
[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 86 of file api_run_sis.f.

Here is the call graph for this function:

Here is the caller graph for this function:

run_set_config_sis_d()

subroutine, public api_run_sis::run_set_config_sis_d	(	type(instance_sis), intent(inout)	INST,
		integer, intent(in)	U_LU,
		integer, intent(in)	U_LNG,
		integer, intent(in)	U_COMM,
		logical, intent(in)	U_STD_OUTPUT,
		integer, intent(out)	IERR
	)

Brief:

Initialise the instance and set the output

Parameters

[in,out]	INST	The instance
[in]	U_LU	Output stream id
[in]	U_LNG	Output kanguage 2 english 1 french
[in]	U_COMM	The mpi communicator (-1 if none)
[in]	U_STD_OUTPUT	If false listing in file
[out]	IERR	0 if subroutine successfull, error id otherwise

Definition at line 56 of file api_run_sis.f.

Here is the caller graph for this function:

run_timestep_sis_d()

subroutine, public api_run_sis::run_timestep_sis_d	(	type(instance_sis), intent(inout)	INST,
		integer, intent(out)	IERR
	)

Brief:

Run a timestep in sisyphe

Parameters

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

Definition at line 179 of file api_run_sis.f.

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

code

character(len=24), parameter api_run_sis::code ='SISYPHE '

private

Definition at line 24 of file api_run_sis.f.

file_desc

character(len=250), dimension(4,300) api_run_sis::file_desc

private

Definition at line 27 of file api_run_sis.f.

iflot

integer api_run_sis::iflot

private

Definition at line 22 of file api_run_sis.f.

motcar

character(len=250), dimension(300) api_run_sis::motcar

private

Definition at line 27 of file api_run_sis.f.

ncar

integer api_run_sis::ncar

private

Definition at line 22 of file api_run_sis.f.

nit_ori

integer api_run_sis::nit_ori

private

Definition at line 22 of file api_run_sis.f.

nit_to_do

integer api_run_sis::nit_to_do

private

Definition at line 22 of file api_run_sis.f.

path

character(len=maxlentmpdir) api_run_sis::path

private

Definition at line 26 of file api_run_sis.f.

tdeb

integer api_run_sis::tdeb

private

Definition at line 22 of file api_run_sis.f.

tfin

integer api_run_sis::tfin

private

Definition at line 22 of file api_run_sis.f.

time_in_seconds

external api_run_sis::time_in_seconds

private

Definition at line 29 of file api_run_sis.f.