api_instance_t3d Module Reference

Data Types
type	instance_t3d

Functions/Subroutines
subroutine, public	create_instance_t3d (ID, IERR)
subroutine	update_instance_t3d (ID, IERR)
subroutine, public	delete_instance_t3d (ID, IERR)
subroutine, public	check_instance_t3d (ID, IERR)
subroutine, public	get_instance_error_t3d (ID, MESS)

Variables
integer, parameter	max_instances =10
type(instance_t3d), dimension(:), pointer, public	instance_list_t3d
logical, dimension(:), allocatable	used_instance

Detailed Description

Brief:

module handling all the instance function

Function/Subroutine Documentation

check_instance_t3d()

subroutine, public api_instance_t3d::check_instance_t3d	(	integer, intent(in)	ID,
		integer, intent(out)	IERR
	)

Brief:

Check if the id is following convention

Parameters

[in]	ID	Id of the instance
[out]	IERR	0 if subroutine successfull, error id otherwise

Definition at line 431 of file api_instance_t3d.f.

Here is the call graph for this function:

Here is the caller graph for this function:

create_instance_t3d()

subroutine, public api_instance_t3d::create_instance_t3d	(	integer, intent(out)	ID,
		integer, intent(out)	IERR
	)

Brief:

Creates a TELEMAC3D instance

Parameters

[out]	ID	Id of the new instance
[out]	IERR	0 if subroutine successfull, error id otherwise

Definition at line 193 of file api_instance_t3d.f.

Here is the call graph for this function:

Here is the caller graph for this function:

delete_instance_t3d()

subroutine, public api_instance_t3d::delete_instance_t3d	(	integer, intent(in)	ID,
		integer, intent(out)	IERR
	)

Brief:

Deletes a TELEMAC3D instance

Parameters

[in]	ID	Id of the instance
[out]	IERR	0 if subroutine successfull, error id otherwise

Definition at line 413 of file api_instance_t3d.f.

Here is the call graph for this function:

Here is the caller graph for this function:

get_instance_error_t3d()

subroutine, public api_instance_t3d::get_instance_error_t3d	(	integer, intent(in)	ID,
		character(len=200), intent(out)	MESS
	)

Brief:

Returns the error message of the instance

Parameters

[in]	ID	Id of the instance
[out]	MESS	The error message

Definition at line 455 of file api_instance_t3d.f.

Here is the caller graph for this function:

update_instance_t3d()

subroutine api_instance_t3d::update_instance_t3d ( integer, intent(in)  ID, integer, intent(out)  IERR  )

private

Brief:

Updates a TELEMAC3D instance

Parameters

[out]	ID	Id of the new instance
[out]	IERR	0 if subroutine successfull, error id otherwise

Definition at line 244 of file api_instance_t3d.f.

Here is the caller graph for this function:

Variable Documentation

instance_list_t3d

type(instance_t3d), dimension(:), pointer, public api_instance_t3d::instance_list_t3d

Definition at line 180 of file api_instance_t3d.f.

max_instances

integer, parameter api_instance_t3d::max_instances =10

private

Definition at line 179 of file api_instance_t3d.f.

used_instance

logical, dimension(:), allocatable api_instance_t3d::used_instance

private

Definition at line 181 of file api_instance_t3d.f.