Linked list of fields

Data Types
type	mod_field_list::t_field_list_item
	One element of the linked list of fields. More...
type	mod_field_list::t_field_list
	Linked list of fields. More...

Functions/Subroutines
subroutine, private	mod_field_list::add_item_to_list (list, item)
	Add an item to the list.
integer function	mod_field_list::count_fields (list)
	Count the number of fields.
subroutine	mod_field_list::add_scalar_field_to_list (list, field, label, is_remove_ghost_values_from_fields, equation_isd_target, ibc_variable)
	Add an scalar field to the list If the scalar field is not allocated then we don't add it and log a msg.
subroutine	mod_field_list::add_vector_field_to_list (list, field, label)
	Add a vector field to the list.
subroutine	mod_field_list::add_face_field_to_list (list, field, label, is_remove_ghost_values_from_fields, equation_isd_target, ibc_variable)
	Add a face field to the list.
subroutine, private	mod_field_list::unalloc_field_list_item (item)
	Delete a single item.
subroutine	mod_field_list::unalloc_field_list (list)
	Delete all items in the list.

Detailed Description

Linked list of fields used for writing data fields

Function/Subroutine Documentation

add_face_field_to_list()

subroutine mod_field_list::add_face_field_to_list	(	class(t_field_list), intent(inout)	list,
		type(t_face_field), intent(in)	field,
		character(len=*), intent(in)	label,
		logical, intent(in), optional	is_remove_ghost_values_from_fields,
		integer, dimension(:), intent(in), optional, allocatable	equation_isd_target,
		type(t_face_immersed_boundary_condition), dimension(:), intent(in), optional	ibc_variable )

Add a face field to the list.

Parameters

[in,out]	list	linked list of fields
[in]	field	face field
[in]	label	label of the face field
[in]	is_remove_ghost_values_from_fields	flag to write outer value on ghost nodes (optional)
[in]	equation_isd_target	immersed subdomain target array of the equation (optional)
[in]	ibc_variable	immersed boundary condition variable (optional)

add_item_to_list()

subroutine, private mod_field_list::add_item_to_list ( type(t_field_list), intent(inout) list, type(t_field_list_item), pointer item )

private

Add an item to the list.

This routine maintains the list order to ensure the uniqueness of every items.

Parameters

[in,out]	list	linked list of fields
	item	pointer to the item to add

add_scalar_field_to_list()

subroutine mod_field_list::add_scalar_field_to_list	(	class(t_field_list), intent(inout)	list,
		double precision, dimension(:,:,:), intent(in)	field,
		character(len=*), intent(in)	label,
		logical, intent(in), optional	is_remove_ghost_values_from_fields,
		integer, dimension(:), intent(in), optional, allocatable	equation_isd_target,
		type(t_immersed_boundary_condition), dimension(:), intent(in), optional	ibc_variable )

Add an scalar field to the list If the scalar field is not allocated then we don't add it and log a msg.

Parameters

[in,out]	list	linked list of fields
[in]	field	scalar field
[in]	label	label of the scalar field
[in]	is_remove_ghost_values_from_fields	flag to write outer value on ghost nodes (optional)
[in]	equation_isd_target	immersed subdomain target array of the equation (optional)
[in]	ibc_variable	immersed boundary condition variable (optional)

add_vector_field_to_list()

subroutine mod_field_list::add_vector_field_to_list	(	class(t_field_list), intent(inout)	list,
		double precision, dimension(:,:,:,:), intent(in)	field,
		character(len=*), intent(in)	label )

Add a vector field to the list.

Parameters

[in,out]	list	linked list of fields
[in]	field	vector field
[in]	label	label of the vector field

count_fields()

integer function mod_field_list::count_fields

(

type(t_field_list), intent(in)

list

)

Count the number of fields.

Parameters

[in]

list

the list of fields

Returns

number of fields

unalloc_field_list()

subroutine mod_field_list::unalloc_field_list

(

type(t_field_list)

list

)

Delete all items in the list.

Parameters

[in,out]

list

linked list to deallocate

unalloc_field_list_item()

subroutine, private mod_field_list::unalloc_field_list_item ( type(t_field_list_item), pointer item )

private

Delete a single item.

Parameters

item	item of linked list to deallocate