IBAMR::IBSourceSpec Class Reference

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

#include <ibamr/IBSourceSpec.h>

Inheritance diagram for IBAMR::IBSourceSpec:

Classes
class	Factory
	A factory class to rebuild IBSourceSpec objects from SAMRAI::tbox::AbstractStream data streams. More...

Public Member Functions
	IBSourceSpec (int master_idx=IBTK::invalid_index, int source_idx=IBTK::invalid_index)
	Default constructor. More...
	~IBSourceSpec ()
	Destructor. More...
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. More...
size_t	getDataStreamSize () const override
	Return an upper bound on the amount of space required to pack the object to a buffer. More...
void	packStream (SAMRAI::tbox::AbstractStream &stream) override
	Pack data into the output stream. More...
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. More...

Static Public Attributes
static int	STREAMABLE_CLASS_ID

Private Types
using	IBSourceSpecFactory = IBSourceSpec::Factory

Private Member Functions
	IBSourceSpec (const IBSourceSpec &from)=delete
	Copy constructor. More...
IBSourceSpec &	operator= (const IBSourceSpec &that)=delete
	Assignment operator. More...

Private Attributes
int	d_master_idx
int	d_source_idx

Member Typedef Documentation

IBSourceSpecFactory

using IBAMR::IBSourceSpec::IBSourceSpecFactory = IBSourceSpec::Factory

private

Constructor & Destructor Documentation

IBSourceSpec() [1/2]

IBAMR::IBSourceSpec::IBSourceSpec ( int  master_idx = IBTK::invalid_index, int  source_idx = IBTK::invalid_index  )

inline

~IBSourceSpec()

IBAMR::IBSourceSpec::~IBSourceSpec ( )

inline

IBSourceSpec() [2/2]

IBAMR::IBSourceSpec::IBSourceSpec ( const IBSourceSpec &  from )

privatedelete

Note

This constructor is not implemented and should not be used.

Parameters

from	The value to copy to this object.

Member Function Documentation

registerWithStreamableManager()

static void IBAMR::IBSourceSpec::registerWithStreamableManager ( )

static

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.

getIsRegisteredWithStreamableManager()

bool IBAMR::IBSourceSpec::getIsRegisteredWithStreamableManager ( )

inlinestatic

getMasterNodeIndex() [1/2]

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

inline

Returns

A const reference to the master node index.

getMasterNodeIndex() [2/2]

int& IBAMR::IBSourceSpec::getMasterNodeIndex

(

)

Returns

A non-const reference to the master node index.

getSourceIndex() [1/2]

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

inline

Returns

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

getSourceIndex() [2/2]

int& IBAMR::IBSourceSpec::getSourceIndex

(

)

Returns

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

getStreamableClassID()

int IBAMR::IBSourceSpec::getStreamableClassID ( ) const

inlineoverridevirtual

Implements IBTK::Streamable.

getDataStreamSize()

size_t IBAMR::IBSourceSpec::getDataStreamSize ( ) const

inlineoverridevirtual

Implements IBTK::Streamable.

packStream()

void IBAMR::IBSourceSpec::packStream ( SAMRAI::tbox::AbstractStream &  stream )

inlineoverridevirtual

Implements IBTK::Streamable.

operator=()

IBSourceSpec& IBAMR::IBSourceSpec::operator= ( const IBSourceSpec &  that )

privatedelete

Note

This operator is not implemented and should not be used.

Parameters

that	The value to assign to this object.

Returns

A reference to this object.

registerPeriodicShift()

virtual void IBTK::Streamable::registerPeriodicShift ( const SAMRAI::hier::IntVector< NDIM > &  offset, const Vector &  displacement  )

virtualinherited

Note

A default empty implementation is provided.

Member Data Documentation

STREAMABLE_CLASS_ID

int IBAMR::IBSourceSpec::STREAMABLE_CLASS_ID

static

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

d_master_idx

int IBAMR::IBSourceSpec::d_master_idx

private

Data required to define the source.

d_source_idx

int IBAMR::IBSourceSpec::d_source_idx

private

---

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

• include/ibamr/IBSourceSpec.h
• include/ibamr/private/IBSourceSpec-inl.h