OpenCMISS-Iron Internal API Documentation
List of all members | Private Member Functions
lists::list_detachanddestroy Interface Reference

Detaches the list values from a list and returns them as a pointer to a array of base type before destroying the list. More...

Private Member Functions

subroutine list_detach_and_destroy_intg1 (LIST, NUMBER_IN_LIST, LIST_VALUES, ERR, ERROR,)
 Detaches the list values from an integer list of data dimension 1 and returns them as an array of base type before destroying the list. The LIST_VALUES array must not be allocated on entry. It is up to the user to then deallocate the returned list memory. More...
 
subroutine list_detach_and_destroy_intg2 (LIST, NUMBER_IN_LIST, LIST_VALUES, ERR, ERROR,)
 Detaches the list values from an integer list of data dimension > 1 and returns them as an array of base type before destroying the list. The LIST_VALUES array must not be allocated on entry. It is up to the user to then deallocate the returned list memory. More...
 
subroutine list_detach_and_destroy_sp1 (LIST, NUMBER_IN_LIST, LIST_VALUES, ERR, ERROR,)
 Detaches the list values from a single precision real list of data dimension 1 and returns them as an array of base type before destroying the list. The LIST_VALUES array must not be allocated on entry. It is up to the user to then deallocate the returned list memory. More...
 
subroutine list_detach_and_destroy_sp2 (LIST, NUMBER_IN_LIST, LIST_VALUES, ERR, ERROR,)
 Detaches the list values from a single precision real list of data dimension > 1 and returns them as an array of base type before destroying the list. The LIST_VALUES array must not be allocated on entry. It is up to the user to then deallocate the returned list memory. More...
 
subroutine list_detach_and_destroy_dp1 (LIST, NUMBER_IN_LIST, LIST_VALUES, ERR, ERROR,)
 Detaches the list values from a double precision real list of data dimension 1 and returns them as an array of base type before destroying the list. The LIST_VALUES array must not be allocated on entry. It is up to the user to then deallocate the returned list memory. More...
 
subroutine list_detach_and_destroy_dp2 (LIST, NUMBER_IN_LIST, LIST_VALUES, ERR, ERROR,)
 Detaches the list values from a double precision real list of data dimension > 1 and returns them as an array of base type before destroying the list. The LIST_VALUES array must not be allocated on entry. It is up to the user to then deallocate the returned list memory. More...
 

Detailed Description

Detaches the list values from a list and returns them as a pointer to a array of base type before destroying the list.

See also
LISTS.

Definition at line 123 of file lists.f90.

Member Function/Subroutine Documentation

subroutine lists::list_detachanddestroy::list_detach_and_destroy_dp1 ( type(list_type), intent(inout), pointer  LIST,
integer(intg), intent(out)  NUMBER_IN_LIST,
real(dp), dimension(:), intent(inout), allocatable  LIST_VALUES,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Detaches the list values from a double precision real list of data dimension 1 and returns them as an array of base type before destroying the list. The LIST_VALUES array must not be allocated on entry. It is up to the user to then deallocate the returned list memory.

Parameters
[in,out]listThe pointer to the list
[out]number_in_listOn exit, the number in the list that has been detached.
[in,out]list_valuesOn exit, the detached list. Must not be associated on entry.
[out]errThe error code
[out]errorThe error string

Definition at line 2541 of file lists.f90.

subroutine lists::list_detachanddestroy::list_detach_and_destroy_dp2 ( type(list_type), intent(inout), pointer  LIST,
integer(intg), intent(out)  NUMBER_IN_LIST,
real(dp), dimension(:,:), intent(inout), allocatable  LIST_VALUES,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Detaches the list values from a double precision real list of data dimension > 1 and returns them as an array of base type before destroying the list. The LIST_VALUES array must not be allocated on entry. It is up to the user to then deallocate the returned list memory.

Parameters
[in,out]listThe pointer to the list
[out]number_in_listOn exit, the number in the list that has been detached.
[in,out]list_valuesOn exit, the detached list. Must not be allocated on entry.
[out]errThe error code
[out]errorThe error string

Definition at line 2596 of file lists.f90.

subroutine lists::list_detachanddestroy::list_detach_and_destroy_intg1 ( type(list_type), intent(inout), pointer  LIST,
integer(intg), intent(out)  NUMBER_IN_LIST,
integer(intg), dimension(:), intent(inout), allocatable  LIST_VALUES,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Detaches the list values from an integer list of data dimension 1 and returns them as an array of base type before destroying the list. The LIST_VALUES array must not be allocated on entry. It is up to the user to then deallocate the returned list memory.

Parameters
[in,out]listThe pointer to the list
[out]number_in_listOn exit, the number in the list that has been detached.
[in,out]list_valuesOn exit, the detached list. Must not be allocated on entry.
[out]errThe error code
[out]errorThe error string

Definition at line 2324 of file lists.f90.

subroutine lists::list_detachanddestroy::list_detach_and_destroy_intg2 ( type(list_type), intent(inout), pointer  LIST,
integer(intg), intent(out)  NUMBER_IN_LIST,
integer(intg), dimension(:,:), intent(inout), allocatable  LIST_VALUES,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Detaches the list values from an integer list of data dimension > 1 and returns them as an array of base type before destroying the list. The LIST_VALUES array must not be allocated on entry. It is up to the user to then deallocate the returned list memory.

Parameters
[in,out]listThe pointer to the list
[out]number_in_listOn exit, the number in the list that has been detached.
[in,out]list_valuesOn exit, the detached list. Must not be allocated on entry.
[out]errThe error code
[out]errorThe error string

Definition at line 2379 of file lists.f90.

subroutine lists::list_detachanddestroy::list_detach_and_destroy_sp1 ( type(list_type), intent(inout), pointer  LIST,
integer(intg), intent(out)  NUMBER_IN_LIST,
real(sp), dimension(:), intent(inout), allocatable  LIST_VALUES,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Detaches the list values from a single precision real list of data dimension 1 and returns them as an array of base type before destroying the list. The LIST_VALUES array must not be allocated on entry. It is up to the user to then deallocate the returned list memory.

Parameters
[in,out]listThe pointer to the list
[out]number_in_listOn exit, the number in the list that has been detached.
[in,out]list_valuesOn exit, the detached list. Must not be allocated on entry.
[out]errThe error code
[out]errorThe error string

Definition at line 2433 of file lists.f90.

subroutine lists::list_detachanddestroy::list_detach_and_destroy_sp2 ( type(list_type), intent(inout), pointer  LIST,
integer(intg), intent(out)  NUMBER_IN_LIST,
real(sp), dimension(:,:), intent(inout), allocatable  LIST_VALUES,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Detaches the list values from a single precision real list of data dimension > 1 and returns them as an array of base type before destroying the list. The LIST_VALUES array must not be allocated on entry. It is up to the user to then deallocate the returned list memory.

Parameters
[in,out]listThe pointer to the list
[out]number_in_listOn exit, the number in the list that has been detached.
[in,out]list_valuesOn exit, the detached list. Must not be allocated on entry.
[out]errThe error code
[out]errorThe error string

Definition at line 2487 of file lists.f90.