IBAMR
An adaptive and distributed-memory parallel implementation of the immersed boundary (IB) method
Public Member Functions | List of all members
IBTK::ParallelSet Class Reference

Class ParallelSet is a utility class for storing collections of integer keys in parallel. More...

#include </home/runner/work/IBAMR/IBAMR/ibtk/include/ibtk/ParallelSet.h>

Inheritance diagram for IBTK::ParallelSet:
Inheritance graph
[legend]

Public Member Functions

 ParallelSet ()=default
 Default constructor.
 
 ParallelSet (const ParallelSet &from)=default
 Copy constructor. More...
 
virtual ~ParallelSet ()=default
 Destructor.
 
ParallelSetoperator= (const ParallelSet &that)
 Assignment operator. More...
 
void addItem (int key)
 Add an item with the specified key to the set. More...
 
void removeItem (int key)
 Remove an item from the set. More...
 
void communicateData ()
 Communicate data to (re-)initialize the set.
 
const std::set< int > & getSet () const
 Return a const reference to the set.
 

Detailed Description

Class ParallelSet is a utility class for storing collections of integer keys in parallel.

Constructor & Destructor Documentation

◆ ParallelSet()

IBTK::ParallelSet::ParallelSet ( const ParallelSet from)
default

Copy constructor.

Parameters
fromThe value to copy to this object.

Member Function Documentation

◆ addItem()

void IBTK::ParallelSet::addItem ( int  key)

Add an item with the specified key to the set.

Note
This method is not collective (i.e., it does not have to be called by all MPI tasks); however, it is necessary to call the collective function ParallelSet::communicateData() to finalize all parallel communication.
The underling set data structure is not updated until the collective method communicateData() is called, even for serial runs.

◆ operator=()

ParallelSet & IBTK::ParallelSet::operator= ( const ParallelSet that)

Assignment operator.

Parameters
thatThe value to assign to this object.
Returns
A reference to this object.

◆ removeItem()

void IBTK::ParallelSet::removeItem ( int  key)

Remove an item from the set.

Note
This method is not collective (i.e., it does not have to be called by all MPI tasks); however, it is necessary to call the collective function ParallelSet::communicateData() to finalize all parallel communication.
The underling set data structure is not updated until the collective method communicateData() is called, even for serial runs.

The documentation for this class was generated from the following files: