Loading [MathJax]/extensions/tex2jax.js
https://mooseframework.inl.gov
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends
Public Attributes | List of all members
LocalRankConfig Struct Reference

Holds app partitioning information relevant to the a particular rank for a multiapp scenario. More...

#include <MultiApp.h>

Public Attributes

dof_id_type num_local_sims
 The number of simulations that should/will be run locally on this rank. More...
 
dof_id_type first_local_sim_index
 The (global) index of the first local simulation for this rank. More...
 
dof_id_type num_local_apps
 The number of (sub)apps that should/will be run locally on this rank. More...
 
dof_id_type first_local_app_index
 The (global) index of the first local app for this rank. More...
 
bool is_first_local_rank
 This is true if this rank is the primary/zero rank for a (sub)app slot. More...
 
processor_id_type my_first_rank
 For every rank working on a subapp, we store the first rank on each process to make the communication to root simpler on the main app. More...
 

Detailed Description

Holds app partitioning information relevant to the a particular rank for a multiapp scenario.

Definition at line 46 of file MultiApp.h.

Member Data Documentation

◆ first_local_app_index

dof_id_type LocalRankConfig::first_local_app_index

The (global) index of the first local app for this rank.

All ranks that are used to perform multi-proc parallel runs for a given app will have the same first_local_app_index as each other. This will generally be identical to first_local_sim_index unless operating in some sort of "batch" mode where a single subapp is reused for multiple simulations.

Definition at line 64 of file MultiApp.h.

Referenced by MultiApp::buildComm().

◆ first_local_sim_index

dof_id_type LocalRankConfig::first_local_sim_index

The (global) index of the first local simulation for this rank.

All ranks that are used to perform multi-proc parallel runs for a given simulation will have the same first_local_sim_index as each other.

Definition at line 53 of file MultiApp.h.

◆ is_first_local_rank

bool LocalRankConfig::is_first_local_rank

This is true if this rank is the primary/zero rank for a (sub)app slot.

A slot is all ranks that are grouped together to run a single (sub)app together. This field will be true for exactly one rank in each slot. This is important for things like multiapp transfers where you want to only transfer data to a given subapp once even though it may be running on multiple procs/ranks.

Definition at line 71 of file MultiApp.h.

Referenced by MultiApp::isFirstLocalRank().

◆ my_first_rank

processor_id_type LocalRankConfig::my_first_rank

For every rank working on a subapp, we store the first rank on each process to make the communication to root simpler on the main app.

Definition at line 74 of file MultiApp.h.

◆ num_local_apps

dof_id_type LocalRankConfig::num_local_apps

The number of (sub)apps that should/will be run locally on this rank.

This will generally be identical to num_local_sims unless operating in some sort of "batch" mode where a single subapp is reused for multiple simulations.

Definition at line 58 of file MultiApp.h.

Referenced by MultiApp::buildComm().

◆ num_local_sims

dof_id_type LocalRankConfig::num_local_sims

The number of simulations that should/will be run locally on this rank.

Definition at line 49 of file MultiApp.h.


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