IBAMR::IBSourceSpec Class Reference

Class IBSourceSpec encapsulates the data required to initialize distributed internal sources and sinks. More...

#include </home/runner/work/IBAMR/IBAMR/include/ibamr/IBSourceSpec.h>

Inheritance diagram for IBAMR::IBSourceSpec:

Public Member Functions
	IBSourceSpec (int master_idx=IBTK::invalid_index, int source_idx=IBTK::invalid_index)
	Default constructor.
	~IBSourceSpec ()
	Destructor.
const int &	getMasterNodeIndex () const
int &	getMasterNodeIndex ()
const int &	getSourceIndex () const
int &	getSourceIndex ()
int	getStreamableClassID () const override
	Return the unique identifier used to specify the IBTK::StreamableFactory object used by the IBTK::StreamableManager to extract Streamable objects from data streams.
size_t	getDataStreamSize () const override
	Return an upper bound on the amount of space required to pack the object to a buffer.
void	packStream (SAMRAI::tbox::AbstractStream &stream) override
	Pack data into the output stream.
Public Member Functions inherited from IBTK::Streamable
	Streamable ()=default
	Default empty constructor.
virtual	~Streamable ()=default
	Virtual destructor.
virtual void	registerPeriodicShift (const SAMRAI::hier::IntVector< NDIM > &offset, const Vector &displacement)
	Indicate that the Streamable object has been shifted across a periodic boundary. More...

Static Public Member Functions
static void	registerWithStreamableManager ()
	Register this class and its factory class with the singleton IBTK::StreamableManager object. This method must be called before any IBSourceSpec objects are created. More...
static bool	getIsRegisteredWithStreamableManager ()
	Returns a boolean indicating whether the class has been registered with the singleton IBTK::StreamableManager object.

Static Public Attributes
static int	STREAMABLE_CLASS_ID = StreamableManager::getUnregisteredID()

Detailed Description

Class IBSourceSpec encapsulates the data required to initialize distributed internal sources and sinks.

Member Function Documentation

getMasterNodeIndex() [1/2]

int & IBAMR::IBSourceSpec::getMasterNodeIndex ( )

inline

Returns

A non-const reference to the master node index.

getMasterNodeIndex() [2/2]

const int & IBAMR::IBSourceSpec::getMasterNodeIndex ( ) const

inline

Returns

A const reference to the master node index.

getSourceIndex() [1/2]

int & IBAMR::IBSourceSpec::getSourceIndex ( )

inline

Returns

A non-const reference to the source index associated with the master node.

getSourceIndex() [2/2]

const int & IBAMR::IBSourceSpec::getSourceIndex ( ) const

inline

Returns

A const reference to the source index associated with the master node.

registerWithStreamableManager()

void IBAMR::IBSourceSpec::registerWithStreamableManager ( )

static

Register this class and its factory class with the singleton IBTK::StreamableManager object. This method must be called before any IBSourceSpec objects are created.

Note

This method is collective on all MPI processes. This is done to ensure that all processes employ the same class ID for the IBSourceSpec class.

Member Data Documentation

STREAMABLE_CLASS_ID

int IBAMR::IBSourceSpec::STREAMABLE_CLASS_ID = StreamableManager::getUnregisteredID()

static

The unique class ID for this object type assigned by the IBTK::StreamableManager.

---

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

• /home/runner/work/IBAMR/IBAMR/include/ibamr/IBSourceSpec.h
• /home/runner/work/IBAMR/IBAMR/include/ibamr/private/IBSourceSpec-inl.h
• /home/runner/work/IBAMR/IBAMR/src/IB/IBSourceSpec.cpp