variables_ui Module Reference

Data Types
type	t_ui_equation
type	t_ui_field
type	t_ui_variable

Enumerations
enum	{ var_integer , var_double , var_boolean , var_string }
enum	{ eq_scalar , eq_vector }
enum	{ field_scalar , field_vector }

Functions/Subroutines
subroutine	ui_get_variable (key, var)
subroutine, public	ui_add_value (key, integer_value, double_value, boolean_value, string_value)
logical function, public	ui_is_defined (key)
	Check if a variable is defined (was exported)
integer function, public	ui_get_integer (key)
	Get integer user variable from key.
double precision function, public	ui_get_double (key)
	Get double user variable from key.
logical function, public	ui_get_boolean (key)
	Get boolean user variable from key.
character(len=:) function, allocatable, public	ui_get_string (key)
	Get string user variable from key.
subroutine	ui_get_equation (label, equation)
subroutine	ui_get_field (label, field_list, field)
subroutine	ui_add_equation (label, eq_type, id)
subroutine	ui_add_field (label, field_list, field_type, id, eq_id)
subroutine, public	ui_add_scalar_equation (label, id)
subroutine, public	ui_add_vector_equation (label, id)
subroutine, public	ui_add_scalar_field (label, id, eq_id)
subroutine, public	ui_add_vector_field (label, id, eq_id)
subroutine, public	ui_add_scalar_boundary_condition (label, id, eq_id)
subroutine, public	ui_add_vector_boundary_condition (label, id, eq_id)
logical function, public	ui_is_equation_defined (label)
logical function, public	ui_is_field_defined (label)
logical function, public	ui_is_boundary_condition_defined (label)
subroutine, public	ui_get_scalar_equation (label, eq_id)
	Get user-defined scalar equation from label.
subroutine, public	ui_get_vector_equation (label, eq_id)
	Get user-defined vector equation from label.
subroutine, public	ui_get_scalar_field (label, eq_id, id)
	Get user-defined scalar field from label.
subroutine, public	ui_get_vector_field (label, eq_id, id)
	Get user-defined vector field from label.
subroutine, public	ui_get_scalar_boundary_condition (label, eq_id, id)
	Get user-defined scalar boundary condition from label.
subroutine, public	ui_get_vector_boundary_condition (label, eq_id, id)
	Get user-defined vector boundary condition from label.

Variables
type(t_ui_variable), pointer	ui_vars => null()
type(t_ui_equation), pointer	ui_equation => null()
type(t_ui_field), pointer	ui_field => null()
type(t_ui_field), pointer	ui_boundary_condition => null()

Enumeration Type Documentation

anonymous enum

anonymous enum

private

Enumerator
var_integer
var_double
var_boolean
var_string

anonymous enum

anonymous enum

private

Enumerator
eq_scalar
eq_vector

anonymous enum

anonymous enum

private

Enumerator
field_scalar
field_vector

Function/Subroutine Documentation

ui_add_equation()

subroutine variables_ui::ui_add_equation ( character(len=*), intent(in) label, integer, intent(in) eq_type, integer, intent(in) id )

private

ui_add_field()

subroutine variables_ui::ui_add_field ( character(len=*), intent(in) label, type(t_ui_field), intent(inout), pointer field_list, integer, intent(in) field_type, integer, intent(in) id, integer, intent(in) eq_id )

private

ui_add_scalar_boundary_condition()

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

ui_add_scalar_equation()

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

ui_add_scalar_field()

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

ui_add_value()

subroutine, public variables_ui::ui_add_value	(	character(len=*), intent(in)	key,
		integer, intent(in), optional	integer_value,
		double precision, intent(in), optional	double_value,
		logical, intent(in), optional	boolean_value,
		character(len=*), intent(in), optional	string_value )

ui_add_vector_boundary_condition()

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

ui_add_vector_equation()

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

ui_add_vector_field()

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

ui_get_equation()

subroutine variables_ui::ui_get_equation ( character(len=*), intent(in) label, type(t_ui_equation), intent(out), pointer equation )

private

ui_get_field()

subroutine variables_ui::ui_get_field ( character(len=*), intent(in) label, type(t_ui_field), intent(in), pointer field_list, type(t_ui_field), intent(out), pointer field )

private

ui_get_variable()

subroutine variables_ui::ui_get_variable ( character(len=*), intent(in) key, type(t_ui_variable), pointer var )

private

ui_is_boundary_condition_defined()

logical function, public variables_ui::ui_is_boundary_condition_defined

(

character(len=*), intent(in)

label

)

ui_is_equation_defined()

logical function, public variables_ui::ui_is_equation_defined

(

character(len=*), intent(in)

label

)

ui_is_field_defined()

logical function, public variables_ui::ui_is_field_defined

(

character(len=*), intent(in)

label

)

Variable Documentation

ui_boundary_condition

type(t_ui_field), pointer variables_ui::ui_boundary_condition => null()

private

ui_equation

type(t_ui_equation), pointer variables_ui::ui_equation => null()

ui_field

type(t_ui_field), pointer variables_ui::ui_field => null()

ui_vars

type(t_ui_variable), pointer variables_ui::ui_vars => null()