MODFLOW 6 version 6.9.0.dev0
USGS Modular Hydrologic Model
Loading...
Searching...
No Matches
mpimessagecachemodule::mpimessagecachetype Type Reference

Facility to cache the constructed MPI datatypes. This will avoid having to construct them over and over again for the communication inside the timestep loop. This class deals with separate caches for different units (solutions or global) and for different types of. More...

Collaboration diagram for mpimessagecachemodule::mpimessagecachetype:
Collaboration graph

Public Member Functions

procedure init (this)
procedure get (this, unit, rank, stage, msg_id)
procedure put (this, unit, rank, stage, msg_id, mpi_type)
 Put the mpi datatype for this particular unit, rank, and stage in cache. The datatype should be.
procedure clear (this)
procedure destroy (this)

Public Attributes

type(stlvecint) cached_ids
 a vector with ids for the cached units (solution ids)
type(listtype) unit_caches
 a list with caches per unit

Detailed Description

Definition at line 24 of file MpiMessageCache.f90.

Member Function/Subroutine Documentation

◆ clear()

procedure mpimessagecachemodule::mpimessagecachetype::clear ( class(mpimessagecachetype) this)
Parameters
thisthe message cache

Definition at line 31 of file MpiMessageCache.f90.

◆ destroy()

procedure mpimessagecachemodule::mpimessagecachetype::destroy ( class(mpimessagecachetype) this)
Parameters
thisthe message cache

Definition at line 32 of file MpiMessageCache.f90.

◆ get()

procedure mpimessagecachemodule::mpimessagecachetype::get ( class(mpimessagecachetype) this,
integer(i4b) unit,
integer(i4b) rank,
integer(i4b) stage,
integer(i4b) msg_id )
Parameters
thisthe message cache
unitthe unit (solution or global)
rankthe rank of the MPI process to communicate with
stagethe simulation stage at which the message is sent
msg_idthe message type as an integer between 1 and NR_MSG_TYPES (see above for predefined values)
Returns
the resulting mpi datatype

Definition at line 29 of file MpiMessageCache.f90.

◆ init()

procedure mpimessagecachemodule::mpimessagecachetype::init ( class(mpimessagecachetype) this)
Parameters
thisthe message cache

Definition at line 28 of file MpiMessageCache.f90.

◆ put()

procedure mpimessagecachemodule::mpimessagecachetype::put ( class(mpimessagecachetype) this,
integer(i4b) unit,
integer(i4b) rank,
integer(i4b) stage,
integer(i4b) msg_id,
integer mpi_type )
Parameters
thisthe message cache
unitthe unit (solution or global)
rankthe rank of the MPI process to communicate with
stagethe simulation stage at which the message is sent
msg_idthe message type as an integer between 1 and NR_MSG_TYPES (see above for predefined values)
mpi_typethe mpi datatype to cache

Definition at line 30 of file MpiMessageCache.f90.

Member Data Documentation

◆ cached_ids

type(stlvecint) mpimessagecachemodule::mpimessagecachetype::cached_ids

Definition at line 25 of file MpiMessageCache.f90.

25 type(STLVecInt) :: cached_ids !< a vector with ids for the cached units (solution ids)

◆ unit_caches

type(listtype) mpimessagecachemodule::mpimessagecachetype::unit_caches

Definition at line 26 of file MpiMessageCache.f90.

26 type(ListType) :: unit_caches !< a list with caches per unit

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