The TELEMAC-MASCARET system  trunk
Functions/Subroutines | Variables
api_handle_var_wac Module Reference

Functions/Subroutines

subroutine get_double_array_wac_d (INST, VARNAME, VALEUR, DIM1, IERR, BLOCK_INDEX)
 
subroutine set_double_array_wac_d (INST, VARNAME, VALEUR, DIM1, IERR, BLOCK_INDEX)
 
subroutine get_integer_array_wac_d (INST, VARNAME, VALEUR, DIM1, IERR)
 
subroutine set_integer_array_wac_d (INST, VARNAME, VALEUR, DIM1, IERR)
 
subroutine get_double_wac_d (INST, VARNAME, VALEUR, INDEX1, INDEX2, INDEX3, IERR)
 
subroutine set_double_wac_d (INST, VARNAME, VALEUR, INDEX1, INDEX2, INDEX3, IERR)
 
subroutine get_integer_wac_d (INST, VARNAME, VALEUR, INDEX1, INDEX2, INDEX3, IERR)
 
subroutine set_integer_wac_d (INST, VARNAME, VALEUR, INDEX1, INDEX2, INDEX3, IERR)
 
subroutine get_string_wac_d (INST, VARNAME, VALEUR, VALUELEN, INDEX1, INDEX2, IERR)
 
subroutine set_string_wac_d (INST, VARNAME, VALEUR, VALUELEN, INDEX1, INDEX2, IERR)
 
subroutine get_boolean_wac_d (INST, VARNAME, VALEUR, INDEX1, INDEX2, INDEX3, IERR)
 
subroutine set_boolean_wac_d (INST, VARNAME, VALEUR, INDEX1, INDEX2, INDEX3, IERR)
 
subroutine get_var_size_wac_d (INST, VARNAME, DIM1, DIM2, DIM3, IERR)
 
subroutine get_var_type_wac_d (VARNAME, VARTYPE, READONLY, NDIM, IENT, JENT, KENT, GETPOS, SETPOS, IERR)
 
subroutine get_var_info_wac_d (I, VAR_LEN, INFO_LEN, VARNAME, VARINFO, IERR)
 
subroutine set_var_list_wac_d (IERR)
 

Variables

integer, parameter wac_var_len =40
 Size of the string containing the name of a variable. More...
 
integer, parameter wac_type_len =12
 Size of the string containing the type of a variable. More...
 
integer, parameter wac_info_len =200
 Size of the string containing the information about a variable. More...
 
integer, parameter nb_var_wac =16
 The maximum number of variable. More...
 
character(len=wac_var_len), dimension(:), allocatable vname_wac
 List of variable names. More...
 
character(len=wac_info_len), dimension(:), allocatable vinfo_wac
 List of variable info. More...
 

Detailed Description

Brief:
Getter/setter of tomawac variables

Function/Subroutine Documentation

◆ get_boolean_wac_d()

subroutine api_handle_var_wac::get_boolean_wac_d ( type(instance_wac), intent(in)  INST,
character(len=wac_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 tomawac
Parameters
[in,out]INSTThe instance
[in]VARNAMEName of the variable to read
[out]VALEURContainis the read value
[in]INDEX1Index on the first dimension
[in]INDEX2Index on the second dimension
[in]INDEX3Index on the third dimension
[out]IERR0 if subroutine successfull, error id otherwise

Definition at line 404 of file api_handle_var_wac.f.

+ Here is the caller graph for this function:

◆ get_double_array_wac_d()

subroutine api_handle_var_wac::get_double_array_wac_d ( type(instance_wac), intent(in)  INST,
character(len=wac_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_wac.f.

+ Here is the caller graph for this function:

◆ get_double_wac_d()

subroutine api_handle_var_wac::get_double_wac_d ( type(instance_wac), intent(in)  INST,
character(len=wac_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 tomawac
Parameters
[in,out]INSTThe instance
[in]VARNAMEName of the variable to read
[out]VALEURContains the read value
[in]INDEX1Index on the first dimension
[in]INDEX2Index on the second dimension
[in]INDEX3Index on the third dimension
[out]IERR0 if subroutine successfull, error id otherwise

Definition at line 156 of file api_handle_var_wac.f.

+ Here is the caller graph for this function:

◆ get_integer_array_wac_d()

subroutine api_handle_var_wac::get_integer_array_wac_d ( type(instance_wac), intent(in)  INST,
character(len=wac_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 tomawac

Definition at line 87 of file api_handle_var_wac.f.

+ Here is the caller graph for this function:

◆ get_integer_wac_d()

subroutine api_handle_var_wac::get_integer_wac_d ( type(instance_wac), intent(in)  INST,
character(len=wac_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 tomawac
Parameters
[in,out]INSTThe instance
[in]VARNAMEName of the variable to read
[out]VALEURContainis the read value
[in]INDEX1Index on the first dimension
[in]INDEX2Index on the second dimension
[in]INDEX3Index on the third dimension
[out]IERR0 if subroutine successfull, error id otherwise

Definition at line 232 of file api_handle_var_wac.f.

+ Here is the caller graph for this function:

◆ get_string_wac_d()

subroutine api_handle_var_wac::get_string_wac_d ( type(instance_wac), intent(in)  INST,
character(len=wac_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 tomawac
Parameters
[in,out]INSTThe instance
[in]VARNAMEName of the variable to read
[out]VALEURContainis the read value
[in]VALUELENLength of the string
[in]INDEX1Index on the first dimension
[in]INDEX2Index on the second dimension
[out]IERR0 if subroutine successfull, error id otherwise

Definition at line 315 of file api_handle_var_wac.f.

+ Here is the caller graph for this function:

◆ get_var_info_wac_d()

subroutine api_handle_var_wac::get_var_info_wac_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]INumber of the variable
[in]VAR_LENSize of varname
[in]INFO_LENSize of varinfo
[out]VARNAMEName of the variable
[out]VARINFODescription of the variable
[out]IERR0 if subroutine successfull, error id otherwise

Definition at line 662 of file api_handle_var_wac.f.

◆ get_var_size_wac_d()

subroutine api_handle_var_wac::get_var_size_wac_d ( type(instance_wac), intent(in)  INST,
character(len=wac_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 tomawac
Parameters
[in]INSTInstance
[in]VARNAMEName of the variable
[out]DIM1Size of the first dimension
[out]DIM2Size of the second dimension
[out]DIM3Size of the third dimension
[out]IERR0 if subroutine successfull, error id otherwise

Definition at line 472 of file api_handle_var_wac.f.

+ Here is the caller graph for this function:

◆ get_var_type_wac_d()

subroutine api_handle_var_wac::get_var_type_wac_d ( character(len=wac_var_len), intent(in)  VARNAME,
character(len=wac_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]VARNAMEName of the varaible
[out]VARTYPEType of the varaible (INTEGER, DOUBLE,
[out]READONLYTrue if the varaible cannot be modified
[out]NDIMName of the varaible
[out]IENT1 if the numbering is on point
[out]JENT1 if the numbering is on point
[out]KENT1 if the numbering is on point
[out]GETPOSPostion after which the get is posible on the variable
[out]SETPOSPostion after which the set is posible on the variable
[out]IERR0 if subroutine successfull, error id otherwise

Definition at line 531 of file api_handle_var_wac.f.

+ Here is the caller graph for this function:

◆ set_boolean_wac_d()

subroutine api_handle_var_wac::set_boolean_wac_d ( type(instance_wac), intent(inout)  INST,
character(len=wac_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 tomawac
Parameters
[in,out]INSTThe instance
[in]VARNAMEName of the variable to write
[in]VALEURThe value to write in the variable
[in]INDEX1Index on the first dimension
[in]INDEX2Index on the second dimension
[in]INDEX3Index on the third dimension
[out]IERR0 if subroutine successfull, error id otherwise

Definition at line 439 of file api_handle_var_wac.f.

+ Here is the caller graph for this function:

◆ set_double_array_wac_d()

subroutine api_handle_var_wac::set_double_array_wac_d ( type(instance_wac), intent(inout)  INST,
character(len=wac_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 variable of tomawac

Definition at line 61 of file api_handle_var_wac.f.

+ Here is the caller graph for this function:

◆ set_double_wac_d()

subroutine api_handle_var_wac::set_double_wac_d ( type(instance_wac), intent(inout)  INST,
character(len=wac_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 tomawac
Parameters
[in,out]INSTThe instance
[in]VARNAMEName of the variable to write
[in]VALEURThe value to write in the variable
[in]INDEX1Index on the first dimension
[in]INDEX2Index on the second dimension
[in]INDEX3Index on the third dimension
[out]IERR0 if subroutine successfull, error id otherwise

Definition at line 196 of file api_handle_var_wac.f.

+ Here is the caller graph for this function:

◆ set_integer_array_wac_d()

subroutine api_handle_var_wac::set_integer_array_wac_d ( type(instance_wac), intent(inout)  INST,
character(len=wac_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 tomawac

Definition at line 117 of file api_handle_var_wac.f.

+ Here is the caller graph for this function:

◆ set_integer_wac_d()

subroutine api_handle_var_wac::set_integer_wac_d ( type(instance_wac), intent(inout)  INST,
character(len=wac_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 tomawac
Parameters
[in,out]INSTThe instance
[in]VARNAMEName of the variable to write
[in]VALEURThe value to write in the variable
[in]INDEX1Index on the first dimension
[in]INDEX2Index on the second dimension
[in]INDEX3Index on the third dimension
[out]IERR0 if subroutine successfull, error id otherwise

Definition at line 281 of file api_handle_var_wac.f.

+ Here is the caller graph for this function:

◆ set_string_wac_d()

subroutine api_handle_var_wac::set_string_wac_d ( type(instance_wac), intent(inout)  INST,
character(len=wac_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 tomawac
Parameters
[in,out]INSTThe instance
[in]VARNAMEName of the variable to write
[in]VALEURThe value to write in the variable
[in]VALUELENLength of the string
[in]INDEX1Index on the first dimension
[in]INDEX2Index on the second dimension
[out]IERR0 if subroutine successfull, error id otherwise

Definition at line 365 of file api_handle_var_wac.f.

+ Here is the caller graph for this function:

◆ set_var_list_wac_d()

subroutine api_handle_var_wac::set_var_list_wac_d ( integer, intent(out)  IERR)
Brief:
Get a description of each variable
Parameters
[out]IERR0 if subroutine successfull, error id otherwise

Definition at line 691 of file api_handle_var_wac.f.

+ Here is the caller graph for this function:

Variable Documentation

◆ nb_var_wac

integer, parameter api_handle_var_wac::nb_var_wac =16

The maximum number of variable.

Definition at line 18 of file api_handle_var_wac.f.

◆ vinfo_wac

character(len=wac_info_len), dimension(:), allocatable api_handle_var_wac::vinfo_wac

List of variable info.

Definition at line 22 of file api_handle_var_wac.f.

◆ vname_wac

character(len=wac_var_len), dimension(:), allocatable api_handle_var_wac::vname_wac

List of variable names.

Definition at line 20 of file api_handle_var_wac.f.

◆ wac_info_len

integer, parameter api_handle_var_wac::wac_info_len =200

Size of the string containing the information about a variable.

Definition at line 16 of file api_handle_var_wac.f.

◆ wac_type_len

integer, parameter api_handle_var_wac::wac_type_len =12

Size of the string containing the type of a variable.

Definition at line 14 of file api_handle_var_wac.f.

◆ wac_var_len

integer, parameter api_handle_var_wac::wac_var_len =40

Size of the string containing the name of a variable.

Definition at line 12 of file api_handle_var_wac.f.