User imported variables

Define and access to user imported variables More...

Functions/Subroutines
logical function, public	variables_ui::ui_is_defined (key)
	Check if a variable is defined (was exported)
integer function, public	variables_ui::ui_get_integer (key)
	Get integer user variable from key.
double precision function, public	variables_ui::ui_get_double (key)
	Get double user variable from key.
logical function, public	variables_ui::ui_get_boolean (key)
	Get boolean user variable from key.
character(len=:) function, allocatable, public	variables_ui::ui_get_string (key)
	Get string user variable from key.
subroutine, public	variables_ui::ui_get_scalar_equation (label, eq_id)
	Get user-defined scalar equation from label.
subroutine, public	variables_ui::ui_get_vector_equation (label, eq_id)
	Get user-defined vector equation from label.
subroutine, public	variables_ui::ui_get_scalar_field (label, eq_id, id)
	Get user-defined scalar field from label.
subroutine, public	variables_ui::ui_get_vector_field (label, eq_id, id)
	Get user-defined vector field from label.
subroutine, public	variables_ui::ui_get_scalar_boundary_condition (label, eq_id, id)
	Get user-defined scalar boundary condition from label.
subroutine, public	variables_ui::ui_get_vector_boundary_condition (label, eq_id, id)
	Get user-defined vector boundary condition from label.

Detailed Description

Function/Subroutine Documentation

ui_get_boolean()

logical function, public variables_ui::ui_get_boolean

(

character(len=*), intent(in)

key

)

Parameters

[in]

key

variable key

Returns

r: boolean value associated to key

ui_get_double()

double precision function, public variables_ui::ui_get_double

(

character(len=*), intent(in)

key

)

Parameters

[in]

key

variable key

Returns

r: double value associated to key

ui_get_integer()

integer function, public variables_ui::ui_get_integer

(

character(len=*), intent(in)

key

)

Parameters

[in]

key

variable key

Returns

r: integer value associated to key

ui_get_scalar_boundary_condition()

subroutine, public variables_ui::ui_get_scalar_boundary_condition	(	character(len=*), intent(in)	label,
		integer, intent(out)	eq_id,
		integer, intent(out)	id )

Parameters

[in]	label	scalar boundary condition label.
[out]	eq_id	index of the equation (0 if not found).
[out]	id	index of the boundary condition (0 if not found).

ui_get_scalar_equation()

subroutine, public variables_ui::ui_get_scalar_equation	(	character(len=*), intent(in)	label,
		integer, intent(out)	eq_id )

Parameters

[in]	label	scalar equation label.
[out]	eq_id	index of the equation (0 if not found).

ui_get_scalar_field()

subroutine, public variables_ui::ui_get_scalar_field	(	character(len=*), intent(in)	label,
		integer, intent(out)	eq_id,
		integer, intent(out)	id )

Parameters

[in]	label	scalar field label.
[out]	eq_id	index of the equation (0 if not found).
[out]	id	index of the field (0 if not found).

ui_get_string()

character(len=:) function, allocatable, public variables_ui::ui_get_string

(

character(len=*), intent(in)

key

)

Parameters

[in]

key

variable key

Returns

r: string value associated to key

ui_get_vector_boundary_condition()

subroutine, public variables_ui::ui_get_vector_boundary_condition	(	character(len=*), intent(in)	label,
		integer, intent(out)	eq_id,
		integer, intent(out)	id )

Parameters

[in]	label	vector boundary condition label.
[out]	eq_id	index of the equation (0 if not found).
[out]	id	index of the boundary condition (0 if not found).

ui_get_vector_equation()

subroutine, public variables_ui::ui_get_vector_equation	(	character(len=*), intent(in)	label,
		integer, intent(out)	eq_id )

Parameters

[in]	label	vector equation label.
[out]	eq_id	index of the equation (0 if not found).

ui_get_vector_field()

subroutine, public variables_ui::ui_get_vector_field	(	character(len=*), intent(in)	label,
		integer, intent(out)	eq_id,
		integer, intent(out)	id )

Parameters

[in]	label	vector field label.
[out]	eq_id	index of the equation (0 if not found).
[out]	id	index of the field (0 if not found).

ui_is_defined()

logical function, public variables_ui::ui_is_defined

(

character(len=*), intent(in)

key

)

Parameters

[in]

key

variable key

Returns

r: true if the variable is defined