api_run_t3d Module Reference

Functions/Subroutines
subroutine, public	run_set_config_t3d_d (INST, U_LU, U_LNG, U_COMM, U_STD_OUTPUT, IERR)
subroutine, public	run_read_case_t3d_d (INST, CAS_FILE, DICO_FILE, INIT, IERR, WAQ_CAS_FILE, WAQ_DICO_FILE, GAIA_CAS_FILE, GAIA_DICO_FILE)
subroutine, public	run_allocation_t3d_d (INST, IERR)
subroutine, public	run_init_t3d_d (INST, IERR)
subroutine, public	run_timestep_t3d_d (INST, IERR)
subroutine, public	run_finalize_t3d_d (INST, IERR)

Variables
integer, dimension(8)	tdeb
integer, dimension(8)	tfin
integer	ncar
integer	nit_ori
double precision	dt_ori
character(len=24), parameter	code1 ='TELEMAC3D '
character(len=24), parameter	code2 ='SISYPHE '
character(len=24), parameter	code3 ='TOMAWAC '
character(len=24), parameter	code4 ='WAQTEL '
character(len=24), parameter	code5 ='GAIA '
character(len=maxlentmpdir)	path
logical	gaia_cpl
logical	waq_cpl

Detailed Description

Brief:

Function to control telemac3d execution

Function/Subroutine Documentation

run_allocation_t3d_d()

subroutine, public api_run_t3d::run_allocation_t3d_d	(	type(instance_t3d), intent(inout)	INST,
		integer, intent(out)	IERR
	)

Brief:

Allocate all of telemac3d variables

Parameters

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

Definition at line 183 of file api_run_t3d.f.

Here is the call graph for this function:

Here is the caller graph for this function:

run_finalize_t3d_d()

subroutine, public api_run_t3d::run_finalize_t3d_d	(	type(instance_t3d), intent(inout)	INST,
		integer, intent(out)	IERR
	)

Brief:

Finalize a telemac3d run

Parameters

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

Definition at line 291 of file api_run_t3d.f.

Here is the call graph for this function:

Here is the caller graph for this function:

run_init_t3d_d()

subroutine, public api_run_t3d::run_init_t3d_d	(	type(instance_t3d), intent(inout)	INST,
		integer, intent(out)	IERR
	)

Brief:

Initialise the telemac3d variables

Parameters

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

Definition at line 252 of file api_run_t3d.f.

Here is the call graph for this function:

Here is the caller graph for this function:

run_read_case_t3d_d()

subroutine, public api_run_t3d::run_read_case_t3d_d	(	type(instance_t3d), intent(inout)	INST,
		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,out]	INST	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 96 of file api_run_t3d.f.

Here is the call graph for this function:

Here is the caller graph for this function:

run_set_config_t3d_d()

subroutine, public api_run_t3d::run_set_config_t3d_d	(	type(instance_t3d), 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 63 of file api_run_t3d.f.

Here is the caller graph for this function:

run_timestep_t3d_d()

subroutine, public api_run_t3d::run_timestep_t3d_d	(	type(instance_t3d), intent(inout)	INST,
		integer, intent(out)	IERR
	)

Brief:

Run a timestep in telemac3d

Parameters

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

Definition at line 272 of file api_run_t3d.f.

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

code1

character(len=24), parameter api_run_t3d::code1 ='TELEMAC3D '

private

Definition at line 28 of file api_run_t3d.f.

code2

character(len=24), parameter api_run_t3d::code2 ='SISYPHE '

private

Definition at line 29 of file api_run_t3d.f.

code3

character(len=24), parameter api_run_t3d::code3 ='TOMAWAC '

private

Definition at line 30 of file api_run_t3d.f.

code4

character(len=24), parameter api_run_t3d::code4 ='WAQTEL '

private

Definition at line 31 of file api_run_t3d.f.

code5

character(len=24), parameter api_run_t3d::code5 ='GAIA '

private

Definition at line 32 of file api_run_t3d.f.

dt_ori

double precision api_run_t3d::dt_ori

private

Definition at line 26 of file api_run_t3d.f.

gaia_cpl

logical api_run_t3d::gaia_cpl

private

Definition at line 36 of file api_run_t3d.f.

ncar

integer api_run_t3d::ncar

private

Definition at line 25 of file api_run_t3d.f.

nit_ori

integer api_run_t3d::nit_ori

private

Definition at line 25 of file api_run_t3d.f.

path

character(len=maxlentmpdir) api_run_t3d::path

private

Definition at line 34 of file api_run_t3d.f.

tdeb

integer, dimension(8) api_run_t3d::tdeb

private

Definition at line 25 of file api_run_t3d.f.

tfin

integer, dimension(8) api_run_t3d::tfin

private

Definition at line 25 of file api_run_t3d.f.

waq_cpl

logical api_run_t3d::waq_cpl

private

Definition at line 36 of file api_run_t3d.f.