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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

subroutine	set_var_list_sis_d (IERR)

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

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

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

integer, parameter	nb_var_sis =42
	The maximum number of variable. More...

character(len=sis_var_len), dimension(:), allocatable	vname_sis
	List of variable names. More...

character(len=sis_info_len), dimension(:), allocatable	vinfo_sis
	List of variable info. More...

Detailed Description

Brief:: Getter/setter of sisyphe variables

Function/Subroutine Documentation

◆ get_boolean_sis_d()

subroutine api_handle_var_sis::get_boolean_sis_d	(	type(instance_sis), intent(in)	INST,
		character(len=sis_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 sisyphe

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 699 of file api_handle_var_sis.f.

Here is the caller graph for this function:

◆ get_double_array_sis_d()

subroutine api_handle_var_sis::get_double_array_sis_d	(	type(instance_sis), intent(in)	INST,
		character(len=sis_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_sis.f.

Here is the caller graph for this function:

◆ get_double_sis_d()

subroutine api_handle_var_sis::get_double_sis_d	(	type(instance_sis), intent(in)	INST,
		character(len=sis_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 sisyphe

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 304 of file api_handle_var_sis.f.

Here is the caller graph for this function:

◆ get_integer_array_sis_d()

subroutine api_handle_var_sis::get_integer_array_sis_d	(	type(instance_sis), intent(in)	INST,
		character(len=sis_var_len), intent(in)	VARNAME,
		integer, dimension(dim1), intent(out)	VALEUR,
		integer, intent(in)	DIM1,
		integer, intent(out)	IERR
	)

Brief:: Get an integer variable from sisyphe

Definition at line 209 of file api_handle_var_sis.f.

Here is the caller graph for this function:

◆ get_integer_sis_d()

subroutine api_handle_var_sis::get_integer_sis_d	(	type(instance_sis), intent(in)	INST,
		character(len=sis_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 sisyphe

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 491 of file api_handle_var_sis.f.

Here is the caller graph for this function:

◆ get_string_sis_d()

subroutine api_handle_var_sis::get_string_sis_d	(	type(instance_sis), intent(in)	INST,
		character(len=sis_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 sisyphe

Parameters

[in,out]	INST	The instance
[in]	VARNAME	Name of the variable to read
[out]	VALEUR	Containis the read value
[in]	VALUELEN	Length of VALEUR
[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 609 of file api_handle_var_sis.f.

Here is the caller graph for this function:

◆ get_var_info_sis_d()

subroutine api_handle_var_sis::get_var_info_sis_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 1069 of file api_handle_var_sis.f.

◆ get_var_size_sis_d()

subroutine api_handle_var_sis::get_var_size_sis_d	(	type(instance_sis), intent(in)	INST,
		character(len=sis_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 sisyphe

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 769 of file api_handle_var_sis.f.

Here is the caller graph for this function:

◆ get_var_type_sis_d()

subroutine api_handle_var_sis::get_var_type_sis_d	(	character(len=sis_var_len), intent(in)	VARNAME,
		character(len=sis_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 879 of file api_handle_var_sis.f.

Here is the caller graph for this function:

◆ set_boolean_sis_d()

subroutine api_handle_var_sis::set_boolean_sis_d	(	type(instance_sis), intent(inout)	INST,
		character(len=sis_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 sisyphe

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 734 of file api_handle_var_sis.f.

Here is the caller graph for this function:

◆ set_double_array_sis_d()

subroutine api_handle_var_sis::set_double_array_sis_d	(	type(instance_sis), intent(inout)	INST,
		character(len=sis_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 120 of file api_handle_var_sis.f.

Here is the caller graph for this function:

◆ set_double_sis_d()

subroutine api_handle_var_sis::set_double_sis_d	(	type(instance_sis), intent(inout)	INST,
		character(len=sis_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 sisyphe

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 397 of file api_handle_var_sis.f.

Here is the caller graph for this function:

◆ set_integer_array_sis_d()

subroutine api_handle_var_sis::set_integer_array_sis_d	(	type(instance_sis), intent(inout)	INST,
		character(len=sis_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 variable of sisyphe

Definition at line 256 of file api_handle_var_sis.f.

Here is the caller graph for this function:

◆ set_integer_sis_d()

subroutine api_handle_var_sis::set_integer_sis_d	(	type(instance_sis), intent(inout)	INST,
		character(len=sis_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 sisyphe

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 561 of file api_handle_var_sis.f.

Here is the caller graph for this function:

◆ set_string_sis_d()

subroutine api_handle_var_sis::set_string_sis_d	(	type(instance_sis), intent(inout)	INST,
		character(len=sis_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 sisyphe

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 VALEUR
[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 659 of file api_handle_var_sis.f.

Here is the caller graph for this function:

◆ set_var_list_sis_d()

subroutine api_handle_var_sis::set_var_list_sis_d ( integer, intent(out) IERR )

Brief:: Build a description of each variable

Parameters

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

Definition at line 1098 of file api_handle_var_sis.f.

Here is the caller graph for this function:

Variable Documentation

◆ nb_var_sis

integer, parameter api_handle_var_sis::nb_var_sis =42

The maximum number of variable.

Definition at line 18 of file api_handle_var_sis.f.

◆ sis_info_len

integer, parameter api_handle_var_sis::sis_info_len =200

Size of the string containing the information about a variable.

Definition at line 16 of file api_handle_var_sis.f.

◆ sis_type_len

integer, parameter api_handle_var_sis::sis_type_len =12

Size of the string containing the type of a variable.

Definition at line 14 of file api_handle_var_sis.f.

◆ sis_var_len

integer, parameter api_handle_var_sis::sis_var_len =40

Size of the string containing the name of a variable.

Definition at line 12 of file api_handle_var_sis.f.

◆ vinfo_sis

character(len=sis_info_len), dimension(:), allocatable api_handle_var_sis::vinfo_sis

List of variable info.

Definition at line 22 of file api_handle_var_sis.f.

◆ vname_sis

character(len=sis_var_len), dimension(:), allocatable api_handle_var_sis::vname_sis

List of variable names.

Definition at line 20 of file api_handle_var_sis.f.

Functions/Subroutines

Variables

Detailed Description

Function/Subroutine Documentation

◆ get_boolean_sis_d()

◆ get_double_array_sis_d()

◆ get_double_sis_d()

◆ get_integer_array_sis_d()

◆ get_integer_sis_d()

◆ get_string_sis_d()

◆ get_var_info_sis_d()

◆ get_var_size_sis_d()

◆ get_var_type_sis_d()

◆ set_boolean_sis_d()

◆ set_double_array_sis_d()

◆ set_double_sis_d()

◆ set_integer_array_sis_d()

◆ set_integer_sis_d()

◆ set_string_sis_d()

◆ set_var_list_sis_d()

Variable Documentation

◆ nb_var_sis

◆ sis_info_len

◆ sis_type_len

◆ sis_var_len

◆ vinfo_sis

◆ vname_sis