represent a blacs multidimensional parallel environment (for the mpi corrispective see cp_paratypes/mp_para_cart_type) More...

Public Member Functions
procedure, non_overridable, pass, public	create (blacs_env, para_env, blacs_grid_layout, blacs_repeatable, row_major, grid_2d)
	allocates and initializes a type that represent a blacs context

procedure, non_overridable, pass, public	retain (blacs_env)
	retains the given blacs env

procedure, non_overridable, pass, public	release (blacs_env)
	releases the given blacs_env

procedure, non_overridable, pass, public	get (blacs_env, my_process_row, my_process_column, my_process_number, number_of_process_rows, number_of_process_columns, number_of_processes, para_env, blacs2mpi, mpi2blacs)
	Return informations about the specified BLACS context.

procedure, non_overridable, pass, public	write (blacs_env, unit_nr)
	writes the description of the given blacs env

Public Member Functions inherited from cp_blacs_types::cp_blacs_type
procedure, non_overridable, pass, public	gridinit (this, comm, order, nprow, npcol)
	...

procedure, non_overridable, pass, public	gridexit (this)
	...

procedure, non_overridable, pass, public	set (this, what, val)
	...

procedure, non_overridable, pass, public	zgebs2d (this, scope, top, m, n, a, lda)
	...

procedure, non_overridable, pass, public	dgebs2d (this, scope, top, m, n, a, lda)
	...

procedure, non_overridable, pass, public	zgebr2d (this, scope, top, m, n, a, lda, rsrc, csrc)
	...

procedure, non_overridable, pass, public	dgebr2d (this, scope, top, m, n, a, lda, rsrc, csrc)
	...

procedure, non_overridable, pass, public	get_handle (this)
	...

GENERIC, public	operator (this, other)
	...

GENERIC, public	operator (this, other)
	...

procedure, non_overridable, pass, public	interconnect (this, comm_super)
	...

Data Fields
integer	my_pid = -1

integer	n_pid = -1

integer	ref_count = -1

type(mp_para_env_type), pointer	para_env => NULL()

integer, dimension(:, :), pointer	blacs2mpi => NULL()

integer, dimension(:, :), pointer	mpi2blacs => NULL()

logical	repeatable = .FALSE.

Data Fields inherited from cp_blacs_types::cp_blacs_type
integer, dimension(2), public	mepos = -1

integer, dimension(2), public	num_pe = -1

Detailed Description

represent a blacs multidimensional parallel environment (for the mpi corrispective see cp_paratypes/mp_para_cart_type)

Parameters

ref_count	the reference count, when it is zero this object gets deallocated
my_pid	process id of the actual processor
n_pid	number of process ids
the	para_env associated (and compatible) with this blacs_env
blacs2mpi	maps mepos(1)-mepos(2) of blacs to its mpi rank
mpi2blacs(i,rank)	maps the mpi rank to the mepos(i)

History: 08.2002 created [fawzi]

Author: Fawzi Mohamed

Definition at line 53 of file cp_blacs_env.F.

Member Function/Subroutine Documentation

◆ create()

procedure, non_overridable, pass, public cp_blacs_env::cp_blacs_env_type::create	(	class(cp_blacs_env_type), intent(out)	blacs_env,
		type(mp_para_env_type), intent(inout), target	para_env,
		integer, intent(in), optional	blacs_grid_layout,
		logical, intent(in), optional	blacs_repeatable,
		logical, intent(in), optional	row_major,
		integer, dimension(:), intent(in), optional	grid_2d
	)

final

allocates and initializes a type that represent a blacs context

Parameters

blacs_env	the type to initialize
para_env	the para_env for which a blacs env should be created
blacs_grid_layout	...
blacs_repeatable	...
row_major	...
grid_2d	...

History: 08.2002 created [fawzi]

Author: Fawzi Mohamed

Definition at line 60 of file cp_blacs_env.F.

◆ retain()

procedure, non_overridable, pass, public cp_blacs_env::cp_blacs_env_type::retain ( class(cp_blacs_env_type), intent(inout) blacs_env )

final

retains the given blacs env

Parameters

blacs_env the blacs env to retain

History: 08.2002 created [fawzi]

Author: Fawzi Mohamed

Definition at line 61 of file cp_blacs_env.F.

◆ release()

procedure, non_overridable, pass, public cp_blacs_env::cp_blacs_env_type::release ( class(cp_blacs_env_type), intent(inout) blacs_env )

final

releases the given blacs_env

Parameters

blacs_env the blacs env to release

History: 08.2002 created [fawzi]

Author: Fawzi Mohamed

Definition at line 62 of file cp_blacs_env.F.

◆ get()

procedure, non_overridable, pass, public cp_blacs_env::cp_blacs_env_type::get	(	class(cp_blacs_env_type), intent(in)	blacs_env,
		integer, intent(out), optional	my_process_row,
		integer, intent(out), optional	my_process_column,
		integer, intent(out), optional	my_process_number,
		integer, intent(out), optional	number_of_process_rows,
		integer, intent(out), optional	number_of_process_columns,
		integer, intent(out), optional	number_of_processes,
		type(mp_para_env_type), optional, pointer	para_env,
		integer, dimension(:, :), optional, pointer	blacs2mpi,
		integer, dimension(:, :), optional, pointer	mpi2blacs
	)

final

Return informations about the specified BLACS context.

Parameters

blacs_env	...
my_process_row	...
my_process_column	...
my_process_number	...
number_of_process_rows	...
number_of_process_columns	...
number_of_processes	...
para_env	...
blacs2mpi	...
mpi2blacs	...

Date: 19.06.2001

History: MM.YYYY moved here from qs_blacs (Joost VandeVondele)

Author: Matthias Krack

Version: 1.0

Definition at line 63 of file cp_blacs_env.F.

◆ write()

procedure, non_overridable, pass, public cp_blacs_env::cp_blacs_env_type::write	(	class(cp_blacs_env_type), intent(in)	blacs_env,
		integer, intent(in)	unit_nr
	)

final

writes the description of the given blacs env

Parameters

blacs_env	the blacs environment to write
unit_nr	the unit number where to write the description of the blacs environment

History: 08.2002 created [fawzi]

Author: Fawzi Mohamed

Definition at line 64 of file cp_blacs_env.F.

Field Documentation

◆ my_pid

integer cp_blacs_env::cp_blacs_env_type::my_pid = -1

Definition at line 54 of file cp_blacs_env.F.

◆ n_pid

integer cp_blacs_env::cp_blacs_env_type::n_pid = -1

Definition at line 54 of file cp_blacs_env.F.

◆ ref_count

integer cp_blacs_env::cp_blacs_env_type::ref_count = -1

Definition at line 54 of file cp_blacs_env.F.

◆ para_env

type(mp_para_env_type), pointer cp_blacs_env::cp_blacs_env_type::para_env => NULL()

Definition at line 55 of file cp_blacs_env.F.

◆ blacs2mpi

integer, dimension(:, :), pointer cp_blacs_env::cp_blacs_env_type::blacs2mpi => NULL()

Definition at line 56 of file cp_blacs_env.F.

◆ mpi2blacs

integer, dimension(:, :), pointer cp_blacs_env::cp_blacs_env_type::mpi2blacs => NULL()

Definition at line 57 of file cp_blacs_env.F.

◆ repeatable

logical cp_blacs_env::cp_blacs_env_type::repeatable = .FALSE.

Definition at line 58 of file cp_blacs_env.F.

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

fm/cp_blacs_env.F

Public Member Functions

Data Fields

Detailed Description

Member Function/Subroutine Documentation

◆ create()

◆ retain()

◆ release()

◆ get()

◆ write()

Field Documentation

◆ my_pid

◆ n_pid

◆ ref_count

◆ para_env

◆ blacs2mpi

◆ mpi2blacs

◆ repeatable