sc::MTMPIMemoryGrp(3)

📦
version 2.3.1 · 5 versions
, in ubuntu jammy

💖 NAME 💖

Okay so welcome to the sc::MTMPIMemoryGrp(3) manual page, bestie — this MemoryGrp class requires a MT-safe MPI implementation. That's the whole main-character requirement, no cap.

✨ SYNOPSIS ✨

#include <memmtmpi.h>

🌱 Inherits

Inherits sc::ActiveMsgMemoryGrp.

💅 Public Member Functions

  • MTMPIMemoryGrp (const Ref< MessageGrp > &msg, const Ref< ThreadGrp > &th, MPI_Comm comm=MPI_COMM_WORLD) — Construct a MTMPIMemoryGrp given a MessageGrp, ThreadGrp, and an MPI communicator.
  • MTMPIMemoryGrp (const Ref< KeyVal > &) — Construct a MTMPIMemoryGrp given a KeyVal input object.
  • void activate () — activate() is called before the memory is to be used.
  • void deactivate () — deactivate() is called after the memory has been used.
  • void sync () — Synchronizes all the nodes.

👯 Friends

  • class MTMPIThread — yes bestie, this class is in the friend list.

🧬 Additional Inherited Members

There are additional inherited members too — the original page gives the heading Additional Inherited Members and doesn't list more here.

🌈 Detailed Description 🌈

This MemoryGrp class requires a MT-safe MPI implementation. Periodt.

The default MessageGrp must be a MPIMessageGrp. MPI must be safe with respect to the default ThreadGrp. Alternately, a MessageGrp and a ThreadGrp can be passed to the constructor.

Lowkey important: the MT-safe MPI requirement is not optional, bestie 💅.

🛠️ Constructor & Destructor Documentation 🛠️

sc::MTMPIMemoryGrp::MTMPIMemoryGrp (const Ref< MessageGrp > & msg, const Ref< ThreadGrp > & th, MPI_Comm comm = MPI_COMM_WORLD)

Construct a MTMPIMemoryGrp given a MessageGrp, ThreadGrp, and an MPI communicator.

The communicator can be a subset of MPI_COMM_WORLD, in which case, the MessageGrp must refer to the same subset. Like, they have to match — no mixing vibes.

sc::MTMPIMemoryGrp::MTMPIMemoryGrp (const Ref< KeyVal > &)

Construct a MTMPIMemoryGrp given a KeyVal input object.

A fully thread safe MPI is needed (MPI_THREAD_MULTIPLE). That's the vibe check for this constructor 🫶.

🔥 Member Function Documentation 🔥

void sc::MTMPIMemoryGrp::sync () [virtual]

Synchronizes all the nodes. This is useful after remote memory writes to be certain that all of the writes have completed and the data can be accessed locally, for example.

Reimplemented from sc::MsgMemoryGrp.

👑 Author 👑

Generated automatically by Doxygen for MPQC from the source code.

That's the whole page, bestie 💖 — source/version situation: MPQC Version 2.3.1, dated Sun Oct 4 2020, and the manual page is sc::MTMPIMemoryGrp(3). Slay. ✨

📦 where this page comes from