Functions/Subroutines
subroutine	get_double_array_t3d_d (INST, VARNAME, VALEUR, DIM1, IERR, BLOCK_INDEX)

subroutine	set_double_array_t3d_d (INST, VARNAME, VALEUR, DIM1, IERR, BLOCK_INDEX)

subroutine	get_integer_array_t3d_d (INST, VARNAME, VALEUR, DIM1, IERR)

subroutine	set_integer_array_t3d_d (INST, VARNAME, VALEUR, DIM1, IERR)

subroutine	get_double_t3d_d (INST, VARNAME, VALEUR, INDEX1, INDEX2, INDEX3, IERR)

subroutine	set_double_t3d_d (INST, VARNAME, VALEUR, INDEX1, INDEX2, INDEX3, IERR)

subroutine	get_integer_t3d_d (INST, VARNAME, VALEUR, INDEX1, INDEX2, INDEX3, IERR)

subroutine	set_integer_t3d_d (INST, VARNAME, VALEUR, INDEX1, INDEX2, INDEX3, IERR)

subroutine	get_string_t3d_d (INST, VARNAME, VALEUR, VALUELEN, INDEX1, INDEX2, IERR)

subroutine	set_string_t3d_d (INST, VARNAME, VALEUR, VALUELEN, INDEX1, INDEX2, IERR)

subroutine	get_boolean_t3d_d (INST, VARNAME, VALEUR, INDEX1, INDEX2, INDEX3, IERR)

subroutine	set_boolean_t3d_d (INST, VARNAME, VALEUR, INDEX1, INDEX2, INDEX3, IERR)

subroutine	get_var_size_t3d_d (INST, VARNAME, DIM1, DIM2, DIM3, IERR)

subroutine	get_var_type_t3d_d (VARNAME, VARTYPE, READONLY, NDIM, IENT, JENT, KENT, GETPOS, SETPOS, IERR)

subroutine	get_var_info_t3d_d (I, VAR_LEN, INFO_LEN, VARNAME, VARINFO, IERR)

subroutine	set_var_list_t3d_d (IERR)

Variables
integer, parameter	t3d_var_len =40
	Size of the string containing the name of a variable. More...

integer, parameter	t3d_type_len =12
	Size of the string containing the type of a variable. More...

integer, parameter	t3d_info_len =200
	Size of the string containing the information about a variable. More...

integer, parameter	nb_var_t3d =108
	The maximum number of variable. More...

character(len=t3d_var_len), dimension(:), allocatable	vname_t3d
	List of variable names. More...

character(len=t3d_info_len), dimension(:), allocatable	vinfo_t3d
	List of variable info. More...

Detailed Description

Brief:: Getter/setter of telemac3d variables

Function/Subroutine Documentation

◆ get_boolean_t3d_d()

subroutine api_handle_var_t3d::get_boolean_t3d_d	(	type(instance_t3d), intent(in)	INST,
		character(len=t3d_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 from telemac3d

Parameters

[in,out]	INST	The instance
[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 1088 of file api_handle_var_t3d.f.

Here is the caller graph for this function:

◆ get_double_array_t3d_d()

subroutine api_handle_var_t3d::get_double_array_t3d_d	(	type(instance_t3d), intent(in)	INST,
		character(len=t3d_var_len), intent(in)	VARNAME,
		double precision, dimension(dim1), intent(out)	VALEUR,
		integer, intent(in)	DIM1,
		integer, intent(out)	IERR,
		integer, intent(in), optional	BLOCK_INDEX
	)

Brief:: Get a double array

Definition at line 31 of file api_handle_var_t3d.f.

Here is the caller graph for this function:

◆ get_double_t3d_d()

subroutine api_handle_var_t3d::get_double_t3d_d	(	type(instance_t3d), intent(in)	INST,
		character(len=t3d_var_len), intent(in)	VARNAME,
		double precision, intent(out)	VALEUR,
		integer, intent(in)	INDEX1,
		integer, intent(in)	INDEX2,
		integer, intent(in)	INDEX3,
		integer, intent(out)	IERR
	)

Brief:: Get a double variable from telemac3d

Parameters

[in,out]	INST	The instance
[in]	VARNAME	Name of the variable to read
[out]	VALEUR	Contains 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 494 of file api_handle_var_t3d.f.

Here is the caller graph for this function:

◆ get_integer_array_t3d_d()

subroutine api_handle_var_t3d::get_integer_array_t3d_d	(	type(instance_t3d), intent(in)	INST,
		character(len=t3d_var_len), intent(in)	VARNAME,
		integer, dimension(dim1), intent(out)	VALEUR,
		integer, intent(in)	DIM1,
		integer, intent(out)	IERR
	)

Brief:: Get an integer array

Definition at line 350 of file api_handle_var_t3d.f.

Here is the caller graph for this function:

◆ get_integer_t3d_d()

subroutine api_handle_var_t3d::get_integer_t3d_d	(	type(instance_t3d), intent(in)	INST,
		character(len=t3d_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 from telemac3d

Parameters

[in,out]	INST	The instance
[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_handle_var_t3d.f.

Here is the caller graph for this function:

◆ get_string_t3d_d()

subroutine api_handle_var_t3d::get_string_t3d_d	(	type(instance_t3d), intent(in)	INST,
		character(len=t3d_var_len), intent(in)	VARNAME,
		character, dimension(valuelen), intent(out)	VALEUR,
		integer, intent(in)	VALUELEN,
		integer, intent(in)	INDEX1,
		integer, intent(in)	INDEX2,
		integer, intent(out)	IERR
	)

Brief:: Get a string variable from telemac3d

Parameters

[in,out]	INST	The instance
[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 985 of file api_handle_var_t3d.f.

Here is the caller graph for this function:

◆ get_var_info_t3d_d()

subroutine api_handle_var_t3d::get_var_info_t3d_d	(	integer, intent(in)	I,
		integer, intent(in)	VAR_LEN,
		integer, intent(in)	INFO_LEN,
		character, dimension(var_len), intent(out)	VARNAME,
		character, dimension(info_len), intent(out)	VARINFO,
		integer, intent(out)	IERR
	)

Brief:: Get the description of the ith variable

Parameters

[in]	I	Number of the variable
[in]	VAR_LEN	Size of varname
[in]	INFO_LEN	Size of varinfo
[out]	VARNAME	Name of the variable
[out]	VARINFO	Description of the variable
[out]	IERR	0 if subroutine successfull, error id otherwise

Definition at line 2140 of file api_handle_var_t3d.f.

◆ get_var_size_t3d_d()

subroutine api_handle_var_t3d::get_var_size_t3d_d	(	type(instance_t3d), intent(in)	INST,
		character(len=t3d_var_len), intent(in)	VARNAME,
		integer, intent(out)	DIM1,
		integer, intent(out)	DIM2,
		integer, intent(out)	DIM3,
		integer, intent(out)	IERR
	)

Brief:: Get size informations on a variable of telemac3d

Parameters

[in]	INST	Instance
[in]	VARNAME	Name of the variable
[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 1156 of file api_handle_var_t3d.f.

Here is the caller graph for this function:

◆ get_var_type_t3d_d()

subroutine api_handle_var_t3d::get_var_type_t3d_d	(	character(len=t3d_var_len), intent(in)	VARNAME,
		character(len=t3d_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 the information on the type of variable

Parameters

[in]	VARNAME	Name of the varaible
[out]	VARTYPE	Type of the varaible (INTEGER, DOUBLE,
[out]	READONLY	True if the varaible cannot be modified
[out]	NDIM	Name of the varaible
[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	Postion after which the get is posible on the variable
[out]	SETPOS	Postion after which the set is posible on the variable
[out]	IERR	0 if subroutine successfull, error id otherwise

Definition at line 1368 of file api_handle_var_t3d.f.

Here is the caller graph for this function:

◆ set_boolean_t3d_d()

subroutine api_handle_var_t3d::set_boolean_t3d_d	(	type(instance_t3d), intent(inout)	INST,
		character(len=t3d_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 of telemac3d

Parameters

[in,out]	INST	The instance
[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 1123 of file api_handle_var_t3d.f.

Here is the caller graph for this function:

◆ set_double_array_t3d_d()

subroutine api_handle_var_t3d::set_double_array_t3d_d	(	type(instance_t3d), intent(inout)	INST,
		character(len=t3d_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:: Defines the value of a double array

Definition at line 197 of file api_handle_var_t3d.f.

Here is the caller graph for this function:

◆ set_double_t3d_d()

subroutine api_handle_var_t3d::set_double_t3d_d	(	type(instance_t3d), intent(inout)	INST,
		character(len=t3d_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 of telemac3d

Parameters

[in,out]	INST	The instance
[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 660 of file api_handle_var_t3d.f.

Here is the caller graph for this function:

◆ set_integer_array_t3d_d()

subroutine api_handle_var_t3d::set_integer_array_t3d_d	(	type(instance_t3d), intent(inout)	INST,
		character(len=t3d_var_len), intent(in)	VARNAME,
		integer, dimension(dim1), intent(in)	VALEUR,
		integer, intent(in)	DIM1,
		integer, intent(out)	IERR
	)

Brief:: Defines the value of an integer array

Definition at line 420 of file api_handle_var_t3d.f.

Here is the caller graph for this function:

◆ set_integer_t3d_d()

subroutine api_handle_var_t3d::set_integer_t3d_d	(	type(instance_t3d), intent(inout)	INST,
		character(len=t3d_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 of telemac3d

Parameters

[in,out]	INST	The instance
[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 917 of file api_handle_var_t3d.f.

Here is the caller graph for this function:

◆ set_string_t3d_d()

subroutine api_handle_var_t3d::set_string_t3d_d	(	type(instance_t3d), intent(inout)	INST,
		character(len=t3d_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 of telemac3d

Parameters

[in,out]	INST	The instance
[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 1044 of file api_handle_var_t3d.f.

Here is the caller graph for this function:

◆ set_var_list_t3d_d()

subroutine api_handle_var_t3d::set_var_list_t3d_d ( integer, intent(out) IERR )

Brief:: Buils the description of each variable

Parameters

[out] IERR 0 if subroutine successfull, error id otherwise

Definition at line 2169 of file api_handle_var_t3d.f.

Here is the caller graph for this function:

Variable Documentation

◆ nb_var_t3d

integer, parameter api_handle_var_t3d::nb_var_t3d =108

The maximum number of variable.

Definition at line 18 of file api_handle_var_t3d.f.

◆ t3d_info_len

integer, parameter api_handle_var_t3d::t3d_info_len =200

Size of the string containing the information about a variable.

Definition at line 16 of file api_handle_var_t3d.f.

◆ t3d_type_len

integer, parameter api_handle_var_t3d::t3d_type_len =12

Size of the string containing the type of a variable.

Definition at line 14 of file api_handle_var_t3d.f.

◆ t3d_var_len

integer, parameter api_handle_var_t3d::t3d_var_len =40

Size of the string containing the name of a variable.

Definition at line 12 of file api_handle_var_t3d.f.

◆ vinfo_t3d

character(len=t3d_info_len), dimension(:), allocatable api_handle_var_t3d::vinfo_t3d

List of variable info.

Definition at line 22 of file api_handle_var_t3d.f.

◆ vname_t3d

character(len=t3d_var_len), dimension(:), allocatable api_handle_var_t3d::vname_t3d

List of variable names.

Definition at line 20 of file api_handle_var_t3d.f.

Functions/Subroutines

Variables

Detailed Description

Function/Subroutine Documentation

◆ get_boolean_t3d_d()

◆ get_double_array_t3d_d()

◆ get_double_t3d_d()

◆ get_integer_array_t3d_d()

◆ get_integer_t3d_d()

◆ get_string_t3d_d()

◆ get_var_info_t3d_d()

◆ get_var_size_t3d_d()

◆ get_var_type_t3d_d()

◆ set_boolean_t3d_d()

◆ set_double_array_t3d_d()

◆ set_double_t3d_d()

◆ set_integer_array_t3d_d()

◆ set_integer_t3d_d()

◆ set_string_t3d_d()

◆ set_var_list_t3d_d()

Variable Documentation

◆ nb_var_t3d

◆ t3d_info_len

◆ t3d_type_len

◆ t3d_var_len

◆ vinfo_t3d

◆ vname_t3d