MODFLOW 6 version 6.9.0.dev0
USGS Modular Hydrologic Model
Loading...
Searching...
No Matches
distributedsimmodule::distributedsimtype Type Reference
Collaboration diagram for distributedsimmodule::distributedsimtype:
Collaboration graph

Public Member Functions

procedure create (this)
 Create the distributed simulation object from the simulation input ctx.
procedure get_load_mask (this)
 Return pointer to the load mask for models.
procedure get_load_balance (this)
 Get the model load balance for the simulation.
procedure destroy (this)
 clean up

Public Attributes

character(len=lenmempath) memory_path
integer(i4b), pointer nr_models
 the total (global) number of models, equals the length of the model block in mfsim.nam
integer(i4b), dimension(:), pointer, contiguous load_mask => null()
 mask for loading models and exchanges, 1 when active on this processor, else 0
integer(i4b), dimension(:), pointer, contiguous model_ranks => null()
 load balance: model rank (0,...,nr_procs-1) per global model id (array index)
logical(lgp), pointer print_ptable
 when true, the partition table is printed to file

Private Member Functions

procedure, private create_load_mask (this)
 Create a load mask for IDM from the load balance array.
procedure, private set_load_balance_from_input (this)
 Load load balance from the input configuration.
procedure, private set_load_balance_default (this)
 Distribute the models over the available processes in a parallel run. Expects an array sized.
procedure, private validate_load_balance (this)
 Check validity of load balance configuration.
procedure, private print_load_balance (this)
 Print the load balance table to the listing file.

Detailed Description

Definition at line 21 of file DistributedSim.f90.

Member Function/Subroutine Documentation

◆ create()

procedure distributedsimmodule::distributedsimtype::create ( class(distributedsimtype) this)

Definition at line 28 of file DistributedSim.f90.

◆ create_load_mask()

procedure, private distributedsimmodule::distributedsimtype::create_load_mask ( class(distributedsimtype) this)
private

Definition at line 33 of file DistributedSim.f90.

◆ destroy()

procedure distributedsimmodule::distributedsimtype::destroy ( class(distributedsimtype) this)

Definition at line 31 of file DistributedSim.f90.

◆ get_load_balance()

procedure distributedsimmodule::distributedsimtype::get_load_balance ( class(distributedsimtype) this)
Parameters
thisthis distributed sim instance
Returns
the load balance: array of ranks per model id

Definition at line 30 of file DistributedSim.f90.

◆ get_load_mask()

procedure distributedsimmodule::distributedsimtype::get_load_mask ( class(distributedsimtype) this)

Get a load mask to determine which models should be loaded by idm on this process. This is in sync with models create. The mask array is allocated with its size equal to the global number of models. It is returned as (1, 1, 0, 0, ... 0) with each entry being a load mask for the model at the corresponding

Definition at line 29 of file DistributedSim.f90.

◆ print_load_balance()

procedure, private distributedsimmodule::distributedsimtype::print_load_balance ( class(distributedsimtype) this)
private

Definition at line 37 of file DistributedSim.f90.

◆ set_load_balance_default()

procedure, private distributedsimmodule::distributedsimtype::set_load_balance_default ( class(distributedsimtype) this)
private
Parameters
thisthis distributed sim. instance

Definition at line 35 of file DistributedSim.f90.

◆ set_load_balance_from_input()

procedure, private distributedsimmodule::distributedsimtype::set_load_balance_from_input ( class(distributedsimtype) this)
private
Parameters
thisthis distributed sim instance

Definition at line 34 of file DistributedSim.f90.

◆ validate_load_balance()

procedure, private distributedsimmodule::distributedsimtype::validate_load_balance ( class(distributedsimtype) this)
private

Definition at line 36 of file DistributedSim.f90.

Member Data Documentation

◆ load_mask

integer(i4b), dimension(:), pointer, contiguous distributedsimmodule::distributedsimtype::load_mask => null()

Definition at line 24 of file DistributedSim.f90.

◆ memory_path

character(len=lenmempath) distributedsimmodule::distributedsimtype::memory_path

Definition at line 22 of file DistributedSim.f90.

22 character(len=LENMEMPATH) :: memory_path

◆ model_ranks

integer(i4b), dimension(:), pointer, contiguous distributedsimmodule::distributedsimtype::model_ranks => null()

Definition at line 25 of file DistributedSim.f90.

◆ nr_models

integer(i4b), pointer distributedsimmodule::distributedsimtype::nr_models

Definition at line 23 of file DistributedSim.f90.

23 integer(I4B), pointer :: nr_models !< the total (global) number of models, equals the length of the model block in mfsim.nam

◆ print_ptable

logical(lgp), pointer distributedsimmodule::distributedsimtype::print_ptable

Definition at line 26 of file DistributedSim.f90.

26 logical(LGP), pointer :: print_ptable !< when true, the partition table is printed to file

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