comm_handler_m Module

Handles MPI topology and communicators


Uses


Contents

Derived Types

Functions

Subroutines


Derived Types

type, public ::  comm_handler_t

MPI topology and communicators

Finalizations Procedures

final :: destructor

Type-Bound Procedures

procedure , public :: init Subroutine
procedure , public :: get_comm_cart Function
procedure , public :: get_ncart Function
procedure , public :: get_rank Function
procedure , public :: get_comm_planes Function
procedure , public :: get_nplanes Function
procedure , public :: get_plane Function
procedure , public :: get_comm_species Function
procedure , public :: get_nspecies Function
procedure , public :: get_species Function
procedure , public :: say_hello Subroutine

Functions

public pure function get_comm_cart(self)

Arguments

Type IntentOptional Attributes Name
class(comm_handler_t), intent(in) :: self

Return Value integer

public pure function get_ncart(self)

Arguments

Type IntentOptional Attributes Name
class(comm_handler_t), intent(in) :: self

Return Value integer

public pure function get_rank(self)

Arguments

Type IntentOptional Attributes Name
class(comm_handler_t), intent(in) :: self

Return Value integer

public pure function get_comm_planes(self)

Arguments

Type IntentOptional Attributes Name
class(comm_handler_t), intent(in) :: self

Return Value integer

public pure function get_nplanes(self)

Arguments

Type IntentOptional Attributes Name
class(comm_handler_t), intent(in) :: self

Return Value integer

public pure function get_plane(self)

Arguments

Type IntentOptional Attributes Name
class(comm_handler_t), intent(in) :: self

Return Value integer

public pure function get_comm_species(self)

Arguments

Type IntentOptional Attributes Name
class(comm_handler_t), intent(in) :: self

Return Value integer

public pure function get_nspecies(self)

Arguments

Type IntentOptional Attributes Name
class(comm_handler_t), intent(in) :: self

Return Value integer

public pure function get_species(self)

Arguments

Type IntentOptional Attributes Name
class(comm_handler_t), intent(in) :: self

Return Value integer


Subroutines

public subroutine init(self, comm_old, nplanes, nspecies)

Initialises MPI topology and communicators

Arguments

Type IntentOptional Attributes Name
class(comm_handler_t), intent(inout) :: self

Instance of type
integer, intent(in) :: comm_old

Communicator topology is created on
integer, intent(in) :: nplanes

Number of poloidal planes
integer, intent(in) :: nspecies

Number of species

public subroutine say_hello(self)

Arguments

Type IntentOptional Attributes Name
class(comm_handler_t), intent(in) :: self

public subroutine destructor(self)

Arguments

Type IntentOptional Attributes Name
type(comm_handler_t), intent(inout) :: self