Documentation for module molecule_kind_list_types

represent a simple array based list of the given type

source: molecule_kind_list_types.F
Loading...

public Types:

molecule_kind_list_type
represent a list of objects
molecule_kind_list_p_type
represents a pointer to a list

public Subroutines/Functions:

creates a list
releases a list (see doc/ReferenceCounting.html)
retains a list (see doc/ReferenceCounting.html)

public Types:

TYPE :: molecule_kind_list_p_type

represents a pointer to a list


POINTER :: list the pointer to the list

TYPE :: molecule_kind_list_type

represent a list of objects


INTEGER
:: id_nr identification number of this list
INTEGER
:: ref_count reference count (see doc/ReferenceCounting.html)
INTEGER
:: n_els ...
LOGICAL
:: owns_els ...
DIMENSION(:), POINTER :: els ...

SUBROUTINEmolecule_kind_list_create(list, els_ptr, owns_els, n_els)

creates a list

Arguments:
POINTER, OPTIONAL
:: list the list to allocate and initialize
POINTER, OPTIONAL
:: els_ptr(:) the elements to store in the list (the array is only, referenced, not copied!)
LOGICAL,
INTENT(in),
OPTIONAL
:: owns_els if the list takes the ownership of els_ptr and will deallocate it (defaults to true)
INTEGER,
INTENT(in),
OPTIONAL
:: n_els number of elements in the list (at least one els_ptr or n_els should be given)

SUBROUTINEmolecule_kind_list_release(list)

releases a list (see doc/ReferenceCounting.html)

Arguments:
POINTER
:: list the list to release

SUBROUTINEmolecule_kind_list_retain(list)

retains a list (see doc/ReferenceCounting.html)

Arguments:
POINTER
:: list the list to retain