cp_fm_pool_types Module Reference

pool for for elements that are retained and released More...

Data Types
type	cp_fm_pool_p_type
	to create arrays of pools More...
type	cp_fm_pool_type
	represent a pool of elements with the same structure More...
interface	fm_pools_create_fm_vect
interface	fm_pools_give_back_fm_vect

Functions/Subroutines
subroutine, public	fm_pool_create (pool, el_struct)
	creates a pool of elements
subroutine, public	fm_pool_retain (pool)
	retains the pool (see cp2k/doc/ReferenceCounting.html)
subroutine, public	fm_pool_release (pool)
	releases the given pool (see cp2k/doc/ReferenceCounting.html)
subroutine, public	fm_pool_create_fm (pool, element, name)
	returns an element, allocating it if none is in the pool
subroutine, public	fm_pool_give_back_fm (pool, element)
	returns the element to the pool
type(cp_fm_struct_type) function, pointer, public	fm_pool_get_el_struct (pool)
	returns the structure of the elements in this pool
subroutine, public	fm_pools_dealloc (pools)
	deallocate an array of pools (releasing each pool)

Detailed Description

pool for for elements that are retained and released

History

08.2002 created [fawzi]

Author

Fawzi Mohamed

Function/Subroutine Documentation

fm_pool_create()

subroutine, public cp_fm_pool_types::fm_pool_create	(	type(cp_fm_pool_type), pointer	pool,
		type(cp_fm_struct_type), target	el_struct
	)

creates a pool of elements

Parameters

pool	the pool to create
el_struct	the structure of the elements that are stored in this pool

History

08.2002 created [fawzi]

Author

Fawzi Mohamed

Definition at line 99 of file cp_fm_pool_types.F.

Here is the call graph for this function:

Here is the caller graph for this function:

fm_pool_retain()

subroutine, public cp_fm_pool_types::fm_pool_retain

(

type(cp_fm_pool_type), intent(inout)

pool

)

retains the pool (see cp2k/doc/ReferenceCounting.html)

Parameters

pool	the pool to retain

History

08.2002 created [fawzi]

Author

Fawzi Mohamed

Definition at line 117 of file cp_fm_pool_types.F.

Here is the call graph for this function:

Here is the caller graph for this function:

fm_pool_release()

subroutine, public cp_fm_pool_types::fm_pool_release

(

type(cp_fm_pool_type), pointer

pool

)

releases the given pool (see cp2k/doc/ReferenceCounting.html)

Parameters

pool	the pool to release

History

08.2002 created [fawzi]

Author

Fawzi Mohamed

Definition at line 155 of file cp_fm_pool_types.F.

Here is the call graph for this function:

Here is the caller graph for this function:

fm_pool_create_fm()

subroutine, public cp_fm_pool_types::fm_pool_create_fm	(	type(cp_fm_pool_type), intent(in)	pool,
		type(cp_fm_type), intent(out)	element,
		character(len=*), intent(in), optional	name
	)

returns an element, allocating it if none is in the pool

Parameters

pool	the pool from where you get the element
element	will contain the new element
name	the name for the new matrix (optional)
name	...

History

08.2002 created [fawzi]

Author

Fawzi Mohamed

Definition at line 183 of file cp_fm_pool_types.F.

Here is the call graph for this function:

Here is the caller graph for this function:

fm_pool_give_back_fm()

subroutine, public cp_fm_pool_types::fm_pool_give_back_fm	(	type(cp_fm_pool_type), intent(in)	pool,
		type(cp_fm_type), intent(inout)	element
	)

returns the element to the pool

Parameters

pool	the pool where to cache the element
element	the element to give back

History

08.2002 created [fawzi]

Author

Fawzi Mohamed

Note

transfers the ownership of the element to the pool (it is as if you had called cp_fm_release) Accept give_backs of non associated elements?

Definition at line 223 of file cp_fm_pool_types.F.

Here is the call graph for this function:

Here is the caller graph for this function:

fm_pool_get_el_struct()

type(cp_fm_struct_type) function, pointer, public cp_fm_pool_types::fm_pool_get_el_struct

(

type(cp_fm_pool_type), intent(in)

pool

)

returns the structure of the elements in this pool

Parameters

pool	the pool you are interested in

Returns

...

History

05.2002 created [fawzi]

Author

Fawzi Mohamed

Definition at line 248 of file cp_fm_pool_types.F.

Here is the call graph for this function:

Here is the caller graph for this function:

fm_pools_dealloc()

subroutine, public cp_fm_pool_types::fm_pools_dealloc

(

type(cp_fm_pool_p_type), dimension(:), pointer

pools

)

deallocate an array of pools (releasing each pool)

Parameters

pools

the pools to release

History

11.2002 created [fawzi]

Author

Fawzi Mohamed

Definition at line 285 of file cp_fm_pool_types.F.

Here is the call graph for this function:

Here is the caller graph for this function: