MODFLOW 6  version 6.5.0.dev2
MODFLOW 6 Code Documentation
mpiroutermodule::mpiroutertype Type Reference
Inheritance diagram for mpiroutermodule::mpiroutertype:
Inheritance graph
Collaboration diagram for mpiroutermodule::mpiroutertype:
Collaboration graph

Public Member Functions

procedure initialize => mr_initialize
 
procedure route_all => mr_route_all
 
procedure route_sln => mr_route_sln
 
procedure destroy => mr_destroy
 

Public Attributes

integer(i4b), dimension(:), pointer model_proc_ids
 
type(stlvecintsenders
 the process ids to receive data from More...
 
type(stlvecintreceivers
 the process ids to send data to More...
 
type(vdcptrtype), dimension(:), pointer all_models => null()
 all virtual models from the global list More...
 
type(vdcptrtype), dimension(:), pointer all_exchanges => null()
 all virtual exchanges from the global list More...
 
type(vdcptrtype), dimension(:), pointer rte_models => null()
 the currently active models to be routed More...
 
type(vdcptrtype), dimension(:), pointer rte_exchanges => null()
 the currently active exchanges to be routed More...
 
type(mpimessagebuildertypemessage_builder
 
type(mpimessagecachetypemsg_cache
 
type(mpiworldtype), pointer mpi_world => null()
 
integer(i4b) imon
 the output file unit for the mpi monitor More...
 
logical(lgp) enable_monitor
 when true, log diagnostics More...
 
logical(lgp) halo_activated
 when true, the halo has been activated (allowing more efficient routing of virtual data) More...
 

Private Member Functions

procedure, private activate
 
procedure, private deactivate
 
procedure, private update_senders
 
procedure, private update_receivers
 
procedure, private route_active
 
procedure, private is_cached
 
procedure, private compose_messages
 
procedure, private load_messages
 

Detailed Description

Definition at line 22 of file MpiRouter.f90.

Member Function/Subroutine Documentation

◆ activate()

procedure, private mpiroutermodule::mpiroutertype::activate
private

Definition at line 41 of file MpiRouter.f90.

◆ compose_messages()

procedure, private mpiroutermodule::mpiroutertype::compose_messages
private

Definition at line 47 of file MpiRouter.f90.

◆ deactivate()

procedure, private mpiroutermodule::mpiroutertype::deactivate
private

Definition at line 42 of file MpiRouter.f90.

◆ destroy()

procedure mpiroutermodule::mpiroutertype::destroy

Definition at line 39 of file MpiRouter.f90.

◆ initialize()

procedure mpiroutermodule::mpiroutertype::initialize

Definition at line 36 of file MpiRouter.f90.

◆ is_cached()

procedure, private mpiroutermodule::mpiroutertype::is_cached
private

Definition at line 46 of file MpiRouter.f90.

◆ load_messages()

procedure, private mpiroutermodule::mpiroutertype::load_messages
private

Definition at line 48 of file MpiRouter.f90.

◆ route_active()

procedure, private mpiroutermodule::mpiroutertype::route_active
private

Definition at line 45 of file MpiRouter.f90.

◆ route_all()

procedure mpiroutermodule::mpiroutertype::route_all

Definition at line 37 of file MpiRouter.f90.

◆ route_sln()

procedure mpiroutermodule::mpiroutertype::route_sln

Definition at line 38 of file MpiRouter.f90.

◆ update_receivers()

procedure, private mpiroutermodule::mpiroutertype::update_receivers
private

Definition at line 44 of file MpiRouter.f90.

◆ update_senders()

procedure, private mpiroutermodule::mpiroutertype::update_senders
private

Definition at line 43 of file MpiRouter.f90.

Member Data Documentation

◆ all_exchanges

type(vdcptrtype), dimension(:), pointer mpiroutermodule::mpiroutertype::all_exchanges => null()

Definition at line 27 of file MpiRouter.f90.

27  type(VdcPtrType), dimension(:), pointer :: all_exchanges => null() !< all virtual exchanges from the global list

◆ all_models

type(vdcptrtype), dimension(:), pointer mpiroutermodule::mpiroutertype::all_models => null()

Definition at line 26 of file MpiRouter.f90.

26  type(VdcPtrType), dimension(:), pointer :: all_models => null() !< all virtual models from the global list

◆ enable_monitor

logical(lgp) mpiroutermodule::mpiroutertype::enable_monitor

Definition at line 34 of file MpiRouter.f90.

34  logical(LGP) :: enable_monitor !< when true, log diagnostics

◆ halo_activated

logical(lgp) routerbasemodule::routerbasetype::halo_activated
inherited

Definition at line 8 of file RouterBase.f90.

8  logical(LGP) :: halo_activated !< when true, the halo has been activated

◆ imon

integer(i4b) mpiroutermodule::mpiroutertype::imon

Definition at line 33 of file MpiRouter.f90.

33  integer(I4B) :: imon !< the output file unit for the mpi monitor

◆ message_builder

type(mpimessagebuildertype) mpiroutermodule::mpiroutertype::message_builder

Definition at line 30 of file MpiRouter.f90.

30  type(MpiMessageBuilderType) :: message_builder

◆ model_proc_ids

integer(i4b), dimension(:), pointer mpiroutermodule::mpiroutertype::model_proc_ids

Definition at line 23 of file MpiRouter.f90.

23  integer(I4B), dimension(:), pointer :: model_proc_ids

◆ mpi_world

type(mpiworldtype), pointer mpiroutermodule::mpiroutertype::mpi_world => null()

Definition at line 32 of file MpiRouter.f90.

32  type(MpiWorldType), pointer :: mpi_world => null()

◆ msg_cache

type(mpimessagecachetype) mpiroutermodule::mpiroutertype::msg_cache

Definition at line 31 of file MpiRouter.f90.

31  type(MpiMessageCacheType) :: msg_cache

◆ receivers

type(stlvecint) mpiroutermodule::mpiroutertype::receivers

Definition at line 25 of file MpiRouter.f90.

25  type(STLVecInt) :: receivers !< the process ids to send data to

◆ rte_exchanges

type(vdcptrtype), dimension(:), pointer mpiroutermodule::mpiroutertype::rte_exchanges => null()

Definition at line 29 of file MpiRouter.f90.

29  type(VdcPtrType), dimension(:), pointer :: rte_exchanges => null() !< the currently active exchanges to be routed

◆ rte_models

type(vdcptrtype), dimension(:), pointer mpiroutermodule::mpiroutertype::rte_models => null()

Definition at line 28 of file MpiRouter.f90.

28  type(VdcPtrType), dimension(:), pointer :: rte_models => null() !< the currently active models to be routed

◆ senders

type(stlvecint) mpiroutermodule::mpiroutertype::senders

Definition at line 24 of file MpiRouter.f90.

24  type(STLVecInt) :: senders !< the process ids to receive data from

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