(git:c5411e0)
Loading...
Searching...
No Matches
pw_pool_types::pw_pool_type Type Reference

Manages a pool of grids (to be used for example as tmp objects), but can also be used to instantiate grids that are never given back. More...

Public Member Functions

procedure, non_overridable, public retain (pool)
 retains the pool (see cp2k/doc/ReferenceCounting.html)
 
procedure, non_overridable, public pw_pool_create_pw_r1d_rs (pool, pw)
 returns a pw, allocating it if none is in the pool
 
GENERIC, public create_pw (pool, pw)
 returns a pw, allocating it if none is in the pool
 
procedure, non_overridable, public pw_pool_give_back_pw_r1d_rs (pool, pw)
 returns the pw to the pool
 
GENERIC, public give_back_pw (pool, pw)
 returns the pw to the pool
 
procedure, non_overridable, public pw_pool_create_pw_r3d_rs (pool, pw)
 returns a pw, allocating it if none is in the pool
 
GENERIC, public create_pw (pool, pw)
 returns a pw, allocating it if none is in the pool
 
procedure, non_overridable, public pw_pool_give_back_pw_r3d_rs (pool, pw)
 returns the pw to the pool
 
GENERIC, public give_back_pw (pool, pw)
 returns the pw to the pool
 
procedure, non_overridable, public pw_pool_create_pw_c1d_rs (pool, pw)
 returns a pw, allocating it if none is in the pool
 
GENERIC, public create_pw (pool, pw)
 returns a pw, allocating it if none is in the pool
 
procedure, non_overridable, public pw_pool_give_back_pw_c1d_rs (pool, pw)
 returns the pw to the pool
 
GENERIC, public give_back_pw (pool, pw)
 returns the pw to the pool
 
procedure, non_overridable, public pw_pool_create_pw_c3d_rs (pool, pw)
 returns a pw, allocating it if none is in the pool
 
GENERIC, public create_pw (pool, pw)
 returns a pw, allocating it if none is in the pool
 
procedure, non_overridable, public pw_pool_give_back_pw_c3d_rs (pool, pw)
 returns the pw to the pool
 
GENERIC, public give_back_pw (pool, pw)
 returns the pw to the pool
 
procedure, non_overridable, public pw_pool_create_pw_r1d_gs (pool, pw)
 returns a pw, allocating it if none is in the pool
 
GENERIC, public create_pw (pool, pw)
 returns a pw, allocating it if none is in the pool
 
procedure, non_overridable, public pw_pool_give_back_pw_r1d_gs (pool, pw)
 returns the pw to the pool
 
GENERIC, public give_back_pw (pool, pw)
 returns the pw to the pool
 
procedure, non_overridable, public pw_pool_create_pw_r3d_gs (pool, pw)
 returns a pw, allocating it if none is in the pool
 
GENERIC, public create_pw (pool, pw)
 returns a pw, allocating it if none is in the pool
 
procedure, non_overridable, public pw_pool_give_back_pw_r3d_gs (pool, pw)
 returns the pw to the pool
 
GENERIC, public give_back_pw (pool, pw)
 returns the pw to the pool
 
procedure, non_overridable, public pw_pool_create_pw_c1d_gs (pool, pw)
 returns a pw, allocating it if none is in the pool
 
GENERIC, public create_pw (pool, pw)
 returns a pw, allocating it if none is in the pool
 
procedure, non_overridable, public pw_pool_give_back_pw_c1d_gs (pool, pw)
 returns the pw to the pool
 
GENERIC, public give_back_pw (pool, pw)
 returns the pw to the pool
 
procedure, non_overridable, public pw_pool_create_pw_c3d_gs (pool, pw)
 returns a pw, allocating it if none is in the pool
 
GENERIC, public create_pw (pool, pw)
 returns a pw, allocating it if none is in the pool
 
procedure, non_overridable, public pw_pool_give_back_pw_c3d_gs (pool, pw)
 returns the pw to the pool
 
GENERIC, public give_back_pw (pool, pw)
 returns the pw to the pool
 
procedure, non_overridable, public create_cr3d (pw_pool, cr3d)
 returns a 3d real array of coefficients as the one used by pw with REALDATA3D, allocating it if none is present in the pool
 
procedure, non_overridable, public give_back_cr3d (pw_pool, cr3d)
 returns a 3d real array of coefficients as the one used by pw with REALDATA3D, allocating it if none is present in the pool
 

Data Fields

integer ref_count = 0
 
integer max_cache = 0
 
type(pw_grid_type), pointer pw_grid => NULL()
 
type(cp_sll_1d_r_type), pointer r1d_array => NULL()
 
type(cp_sll_3d_r_type), pointer r3d_array => NULL()
 
type(cp_sll_1d_c_type), pointer c1d_array => NULL()
 
type(cp_sll_3d_c_type), pointer c3d_array => NULL()
 

Detailed Description

Manages a pool of grids (to be used for example as tmp objects), but can also be used to instantiate grids that are never given back.

Parameters
ref_countreference count (see /cp2k/doc/ReferenceCounting.html)
real1d_array, c1d_array, complex3d_array: liked list with the cached grids of the corresponding type
Note
As of now I would like replace the linked lists by arrays (no annoying list elements that are allocated would show up when tracking leaks) [fawzi]
History
08.2002 created [fawzi]
Author
Fawzi Mohamed

Definition at line 83 of file pw_pool_types.F.

Member Function/Subroutine Documentation

◆ retain()

procedure, non_overridable, public pw_pool_types::pw_pool_type::retain ( class(pw_pool_type), intent(inout)  pool)
final

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

Parameters
poolthe pool to retain
History
08.2002 created [fawzi]
Author
Fawzi Mohamed

Definition at line 91 of file pw_pool_types.F.

◆ pw_pool_create_pw_r1d_rs()

procedure, non_overridable, public pw_pool_types::pw_pool_type::pw_pool_create_pw_r1d_rs ( class(pw_pool_type), intent(in)  pool,
type(pw_r1d_rs_type), intent(out)  pw 
)
final

returns a pw, allocating it if none is in the pool

Parameters
poolthe pool from where you get the pw
pwwill contain the new pw
History
08.2002 created [fawzi]
Author
Fawzi Mohamed

Definition at line 92 of file pw_pool_types.F.

◆ create_pw() [1/8]

GENERIC, public pw_pool_types::pw_pool_type::create_pw ( class(pw_pool_type), intent(in)  pool,
type(pw_r1d_rs_type), intent(out)  pw 
)

returns a pw, allocating it if none is in the pool

Parameters
poolthe pool from where you get the pw
pwwill contain the new pw
History
08.2002 created [fawzi]
Author
Fawzi Mohamed

Definition at line 93 of file pw_pool_types.F.

◆ pw_pool_give_back_pw_r1d_rs()

procedure, non_overridable, public pw_pool_types::pw_pool_type::pw_pool_give_back_pw_r1d_rs ( class(pw_pool_type), intent(in)  pool,
type(pw_r1d_rs_type), intent(inout)  pw 
)
final

returns the pw to the pool

Parameters
poolthe pool where to reintegrate the pw
pwthe pw to give back
History
08.2002 created [fawzi]
Author
Fawzi Mohamed

Definition at line 94 of file pw_pool_types.F.

◆ give_back_pw() [1/8]

GENERIC, public pw_pool_types::pw_pool_type::give_back_pw ( class(pw_pool_type), intent(in)  pool,
type(pw_r1d_rs_type), intent(inout)  pw 
)

returns the pw to the pool

Parameters
poolthe pool where to reintegrate the pw
pwthe pw to give back
History
08.2002 created [fawzi]
Author
Fawzi Mohamed

Definition at line 95 of file pw_pool_types.F.

◆ pw_pool_create_pw_r3d_rs()

procedure, non_overridable, public pw_pool_types::pw_pool_type::pw_pool_create_pw_r3d_rs ( class(pw_pool_type), intent(in)  pool,
type(pw_r3d_rs_type), intent(out)  pw 
)
final

returns a pw, allocating it if none is in the pool

Parameters
poolthe pool from where you get the pw
pwwill contain the new pw
History
08.2002 created [fawzi]
Author
Fawzi Mohamed

Definition at line 96 of file pw_pool_types.F.

◆ create_pw() [2/8]

GENERIC, public pw_pool_types::pw_pool_type::create_pw ( class(pw_pool_type), intent(in)  pool,
type(pw_r3d_rs_type), intent(out)  pw 
)

returns a pw, allocating it if none is in the pool

Parameters
poolthe pool from where you get the pw
pwwill contain the new pw
History
08.2002 created [fawzi]
Author
Fawzi Mohamed

Definition at line 97 of file pw_pool_types.F.

◆ pw_pool_give_back_pw_r3d_rs()

procedure, non_overridable, public pw_pool_types::pw_pool_type::pw_pool_give_back_pw_r3d_rs ( class(pw_pool_type), intent(in)  pool,
type(pw_r3d_rs_type), intent(inout)  pw 
)
final

returns the pw to the pool

Parameters
poolthe pool where to reintegrate the pw
pwthe pw to give back
History
08.2002 created [fawzi]
Author
Fawzi Mohamed

Definition at line 98 of file pw_pool_types.F.

◆ give_back_pw() [2/8]

GENERIC, public pw_pool_types::pw_pool_type::give_back_pw ( class(pw_pool_type), intent(in)  pool,
type(pw_r3d_rs_type), intent(inout)  pw 
)

returns the pw to the pool

Parameters
poolthe pool where to reintegrate the pw
pwthe pw to give back
History
08.2002 created [fawzi]
Author
Fawzi Mohamed

Definition at line 99 of file pw_pool_types.F.

◆ pw_pool_create_pw_c1d_rs()

procedure, non_overridable, public pw_pool_types::pw_pool_type::pw_pool_create_pw_c1d_rs ( class(pw_pool_type), intent(in)  pool,
type(pw_c1d_rs_type), intent(out)  pw 
)
final

returns a pw, allocating it if none is in the pool

Parameters
poolthe pool from where you get the pw
pwwill contain the new pw
History
08.2002 created [fawzi]
Author
Fawzi Mohamed

Definition at line 100 of file pw_pool_types.F.

◆ create_pw() [3/8]

GENERIC, public pw_pool_types::pw_pool_type::create_pw ( class(pw_pool_type), intent(in)  pool,
type(pw_c1d_rs_type), intent(out)  pw 
)

returns a pw, allocating it if none is in the pool

Parameters
poolthe pool from where you get the pw
pwwill contain the new pw
History
08.2002 created [fawzi]
Author
Fawzi Mohamed

Definition at line 101 of file pw_pool_types.F.

◆ pw_pool_give_back_pw_c1d_rs()

procedure, non_overridable, public pw_pool_types::pw_pool_type::pw_pool_give_back_pw_c1d_rs ( class(pw_pool_type), intent(in)  pool,
type(pw_c1d_rs_type), intent(inout)  pw 
)
final

returns the pw to the pool

Parameters
poolthe pool where to reintegrate the pw
pwthe pw to give back
History
08.2002 created [fawzi]
Author
Fawzi Mohamed

Definition at line 102 of file pw_pool_types.F.

◆ give_back_pw() [3/8]

GENERIC, public pw_pool_types::pw_pool_type::give_back_pw ( class(pw_pool_type), intent(in)  pool,
type(pw_c1d_rs_type), intent(inout)  pw 
)

returns the pw to the pool

Parameters
poolthe pool where to reintegrate the pw
pwthe pw to give back
History
08.2002 created [fawzi]
Author
Fawzi Mohamed

Definition at line 103 of file pw_pool_types.F.

◆ pw_pool_create_pw_c3d_rs()

procedure, non_overridable, public pw_pool_types::pw_pool_type::pw_pool_create_pw_c3d_rs ( class(pw_pool_type), intent(in)  pool,
type(pw_c3d_rs_type), intent(out)  pw 
)
final

returns a pw, allocating it if none is in the pool

Parameters
poolthe pool from where you get the pw
pwwill contain the new pw
History
08.2002 created [fawzi]
Author
Fawzi Mohamed

Definition at line 104 of file pw_pool_types.F.

◆ create_pw() [4/8]

GENERIC, public pw_pool_types::pw_pool_type::create_pw ( class(pw_pool_type), intent(in)  pool,
type(pw_c3d_rs_type), intent(out)  pw 
)

returns a pw, allocating it if none is in the pool

Parameters
poolthe pool from where you get the pw
pwwill contain the new pw
History
08.2002 created [fawzi]
Author
Fawzi Mohamed

Definition at line 105 of file pw_pool_types.F.

◆ pw_pool_give_back_pw_c3d_rs()

procedure, non_overridable, public pw_pool_types::pw_pool_type::pw_pool_give_back_pw_c3d_rs ( class(pw_pool_type), intent(in)  pool,
type(pw_c3d_rs_type), intent(inout)  pw 
)
final

returns the pw to the pool

Parameters
poolthe pool where to reintegrate the pw
pwthe pw to give back
History
08.2002 created [fawzi]
Author
Fawzi Mohamed

Definition at line 106 of file pw_pool_types.F.

◆ give_back_pw() [4/8]

GENERIC, public pw_pool_types::pw_pool_type::give_back_pw ( class(pw_pool_type), intent(in)  pool,
type(pw_c3d_rs_type), intent(inout)  pw 
)

returns the pw to the pool

Parameters
poolthe pool where to reintegrate the pw
pwthe pw to give back
History
08.2002 created [fawzi]
Author
Fawzi Mohamed

Definition at line 107 of file pw_pool_types.F.

◆ pw_pool_create_pw_r1d_gs()

procedure, non_overridable, public pw_pool_types::pw_pool_type::pw_pool_create_pw_r1d_gs ( class(pw_pool_type), intent(in)  pool,
type(pw_r1d_gs_type), intent(out)  pw 
)
final

returns a pw, allocating it if none is in the pool

Parameters
poolthe pool from where you get the pw
pwwill contain the new pw
History
08.2002 created [fawzi]
Author
Fawzi Mohamed

Definition at line 108 of file pw_pool_types.F.

◆ create_pw() [5/8]

GENERIC, public pw_pool_types::pw_pool_type::create_pw ( class(pw_pool_type), intent(in)  pool,
type(pw_r1d_gs_type), intent(out)  pw 
)

returns a pw, allocating it if none is in the pool

Parameters
poolthe pool from where you get the pw
pwwill contain the new pw
History
08.2002 created [fawzi]
Author
Fawzi Mohamed

Definition at line 109 of file pw_pool_types.F.

◆ pw_pool_give_back_pw_r1d_gs()

procedure, non_overridable, public pw_pool_types::pw_pool_type::pw_pool_give_back_pw_r1d_gs ( class(pw_pool_type), intent(in)  pool,
type(pw_r1d_gs_type), intent(inout)  pw 
)
final

returns the pw to the pool

Parameters
poolthe pool where to reintegrate the pw
pwthe pw to give back
History
08.2002 created [fawzi]
Author
Fawzi Mohamed

Definition at line 110 of file pw_pool_types.F.

◆ give_back_pw() [5/8]

GENERIC, public pw_pool_types::pw_pool_type::give_back_pw ( class(pw_pool_type), intent(in)  pool,
type(pw_r1d_gs_type), intent(inout)  pw 
)

returns the pw to the pool

Parameters
poolthe pool where to reintegrate the pw
pwthe pw to give back
History
08.2002 created [fawzi]
Author
Fawzi Mohamed

Definition at line 111 of file pw_pool_types.F.

◆ pw_pool_create_pw_r3d_gs()

procedure, non_overridable, public pw_pool_types::pw_pool_type::pw_pool_create_pw_r3d_gs ( class(pw_pool_type), intent(in)  pool,
type(pw_r3d_gs_type), intent(out)  pw 
)
final

returns a pw, allocating it if none is in the pool

Parameters
poolthe pool from where you get the pw
pwwill contain the new pw
History
08.2002 created [fawzi]
Author
Fawzi Mohamed

Definition at line 112 of file pw_pool_types.F.

◆ create_pw() [6/8]

GENERIC, public pw_pool_types::pw_pool_type::create_pw ( class(pw_pool_type), intent(in)  pool,
type(pw_r3d_gs_type), intent(out)  pw 
)

returns a pw, allocating it if none is in the pool

Parameters
poolthe pool from where you get the pw
pwwill contain the new pw
History
08.2002 created [fawzi]
Author
Fawzi Mohamed

Definition at line 113 of file pw_pool_types.F.

◆ pw_pool_give_back_pw_r3d_gs()

procedure, non_overridable, public pw_pool_types::pw_pool_type::pw_pool_give_back_pw_r3d_gs ( class(pw_pool_type), intent(in)  pool,
type(pw_r3d_gs_type), intent(inout)  pw 
)
final

returns the pw to the pool

Parameters
poolthe pool where to reintegrate the pw
pwthe pw to give back
History
08.2002 created [fawzi]
Author
Fawzi Mohamed

Definition at line 114 of file pw_pool_types.F.

◆ give_back_pw() [6/8]

GENERIC, public pw_pool_types::pw_pool_type::give_back_pw ( class(pw_pool_type), intent(in)  pool,
type(pw_r3d_gs_type), intent(inout)  pw 
)

returns the pw to the pool

Parameters
poolthe pool where to reintegrate the pw
pwthe pw to give back
History
08.2002 created [fawzi]
Author
Fawzi Mohamed

Definition at line 115 of file pw_pool_types.F.

◆ pw_pool_create_pw_c1d_gs()

procedure, non_overridable, public pw_pool_types::pw_pool_type::pw_pool_create_pw_c1d_gs ( class(pw_pool_type), intent(in)  pool,
type(pw_c1d_gs_type), intent(out)  pw 
)
final

returns a pw, allocating it if none is in the pool

Parameters
poolthe pool from where you get the pw
pwwill contain the new pw
History
08.2002 created [fawzi]
Author
Fawzi Mohamed

Definition at line 116 of file pw_pool_types.F.

◆ create_pw() [7/8]

GENERIC, public pw_pool_types::pw_pool_type::create_pw ( class(pw_pool_type), intent(in)  pool,
type(pw_c1d_gs_type), intent(out)  pw 
)

returns a pw, allocating it if none is in the pool

Parameters
poolthe pool from where you get the pw
pwwill contain the new pw
History
08.2002 created [fawzi]
Author
Fawzi Mohamed

Definition at line 117 of file pw_pool_types.F.

◆ pw_pool_give_back_pw_c1d_gs()

procedure, non_overridable, public pw_pool_types::pw_pool_type::pw_pool_give_back_pw_c1d_gs ( class(pw_pool_type), intent(in)  pool,
type(pw_c1d_gs_type), intent(inout)  pw 
)
final

returns the pw to the pool

Parameters
poolthe pool where to reintegrate the pw
pwthe pw to give back
History
08.2002 created [fawzi]
Author
Fawzi Mohamed

Definition at line 118 of file pw_pool_types.F.

◆ give_back_pw() [7/8]

GENERIC, public pw_pool_types::pw_pool_type::give_back_pw ( class(pw_pool_type), intent(in)  pool,
type(pw_c1d_gs_type), intent(inout)  pw 
)

returns the pw to the pool

Parameters
poolthe pool where to reintegrate the pw
pwthe pw to give back
History
08.2002 created [fawzi]
Author
Fawzi Mohamed

Definition at line 119 of file pw_pool_types.F.

◆ pw_pool_create_pw_c3d_gs()

procedure, non_overridable, public pw_pool_types::pw_pool_type::pw_pool_create_pw_c3d_gs ( class(pw_pool_type), intent(in)  pool,
type(pw_c3d_gs_type), intent(out)  pw 
)
final

returns a pw, allocating it if none is in the pool

Parameters
poolthe pool from where you get the pw
pwwill contain the new pw
History
08.2002 created [fawzi]
Author
Fawzi Mohamed

Definition at line 120 of file pw_pool_types.F.

◆ create_pw() [8/8]

GENERIC, public pw_pool_types::pw_pool_type::create_pw ( class(pw_pool_type), intent(in)  pool,
type(pw_c3d_gs_type), intent(out)  pw 
)

returns a pw, allocating it if none is in the pool

Parameters
poolthe pool from where you get the pw
pwwill contain the new pw
History
08.2002 created [fawzi]
Author
Fawzi Mohamed

Definition at line 121 of file pw_pool_types.F.

◆ pw_pool_give_back_pw_c3d_gs()

procedure, non_overridable, public pw_pool_types::pw_pool_type::pw_pool_give_back_pw_c3d_gs ( class(pw_pool_type), intent(in)  pool,
type(pw_c3d_gs_type), intent(inout)  pw 
)
final

returns the pw to the pool

Parameters
poolthe pool where to reintegrate the pw
pwthe pw to give back
History
08.2002 created [fawzi]
Author
Fawzi Mohamed

Definition at line 122 of file pw_pool_types.F.

◆ give_back_pw() [8/8]

GENERIC, public pw_pool_types::pw_pool_type::give_back_pw ( class(pw_pool_type), intent(in)  pool,
type(pw_c3d_gs_type), intent(inout)  pw 
)

returns the pw to the pool

Parameters
poolthe pool where to reintegrate the pw
pwthe pw to give back
History
08.2002 created [fawzi]
Author
Fawzi Mohamed

Definition at line 123 of file pw_pool_types.F.

◆ create_cr3d()

procedure, non_overridable, public pw_pool_types::pw_pool_type::create_cr3d ( class(pw_pool_type), intent(in)  pw_pool,
real(kind=dp), dimension(:, :, :), pointer  cr3d 
)
final

returns a 3d real array of coefficients as the one used by pw with REALDATA3D, allocating it if none is present in the pool

Parameters
pw_poolthe pool that caches the cr3d
cr3dthe pointer that will contain the array
History
11.2003 created [fawzi]
Author
fawzi

Definition at line 124 of file pw_pool_types.F.

◆ give_back_cr3d()

procedure, non_overridable, public pw_pool_types::pw_pool_type::give_back_cr3d ( class(pw_pool_type), intent(in)  pw_pool,
real(kind=dp), dimension(:, :, :), pointer, contiguous  cr3d 
)
final

returns a 3d real array of coefficients as the one used by pw with REALDATA3D, allocating it if none is present in the pool

Parameters
pw_poolthe pool that caches the cr3d
cr3dthe pointer that will contain the array
History
11.2003 created [fawzi]
Author
fawzi

Definition at line 125 of file pw_pool_types.F.

Field Documentation

◆ ref_count

integer pw_pool_types::pw_pool_type::ref_count = 0

Definition at line 84 of file pw_pool_types.F.

◆ max_cache

integer pw_pool_types::pw_pool_type::max_cache = 0

Definition at line 84 of file pw_pool_types.F.

◆ pw_grid

type(pw_grid_type), pointer pw_pool_types::pw_pool_type::pw_grid => NULL()

Definition at line 85 of file pw_pool_types.F.

◆ r1d_array

type(cp_sll_1d_r_type), pointer pw_pool_types::pw_pool_type::r1d_array => NULL()

Definition at line 86 of file pw_pool_types.F.

◆ r3d_array

type(cp_sll_3d_r_type), pointer pw_pool_types::pw_pool_type::r3d_array => NULL()

Definition at line 87 of file pw_pool_types.F.

◆ c1d_array

type(cp_sll_1d_c_type), pointer pw_pool_types::pw_pool_type::c1d_array => NULL()

Definition at line 88 of file pw_pool_types.F.

◆ c3d_array

type(cp_sll_3d_c_type), pointer pw_pool_types::pw_pool_type::c3d_array => NULL()

Definition at line 89 of file pw_pool_types.F.


The documentation for this type was generated from the following file: