IBTK::LIndexSetData< T > Class Template Reference

Class LIndexSetData is a specialization of the templated class LSetData that is intended to be used with Lagrangian data objects that provide Lagrangian and PETSc indexing information. More...

#include <ibtk/LIndexSetData.h>

Public Member Functions
	LIndexSetData (SAMRAI::hier::Box< NDIM > box, SAMRAI::hier::IntVector< NDIM > ghosts)
virtual	~LIndexSetData ()=default
void	cacheLocalIndices (SAMRAI::tbox::Pointer< SAMRAI::hier::Patch< NDIM > > patch, const SAMRAI::hier::IntVector< NDIM > &periodic_shift)
	Update the cached indexing data. More...
const std::vector< int > &	getLagrangianIndices () const
const std::vector< int > &	getInteriorLagrangianIndices () const
const std::vector< int > &	getGhostLagrangianIndices () const
const std::vector< int > &	getGlobalPETScIndices () const
const std::vector< int > &	getInteriorGlobalPETScIndices () const
const std::vector< int > &	getGhostGlobalPETScIndices () const
const std::vector< int > &	getLocalPETScIndices () const
const std::vector< int > &	getInteriorLocalPETScIndices () const
const std::vector< int > &	getGhostLocalPETScIndices () const
const std::vector< double > &	getPeriodicShifts () const
const std::vector< double > &	getInteriorPeriodicShifts () const
const std::vector< double > &	getGhostPeriodicShifts () const

Private Member Functions
	LIndexSetData ()=delete
	Default constructor. More...
	LIndexSetData (const LIndexSetData< T > &from)=delete
	Copy constructor. More...
LIndexSetData &	operator= (const LIndexSetData< T > &that)=delete
	Assignment operator. More...

Private Attributes
std::vector< int >	d_lag_indices
std::vector< int >	d_interior_lag_indices
std::vector< int >	d_ghost_lag_indices
std::vector< int >	d_global_petsc_indices
std::vector< int >	d_interior_global_petsc_indices
std::vector< int >	d_ghost_global_petsc_indices
std::vector< int >	d_local_petsc_indices
std::vector< int >	d_interior_local_petsc_indices
std::vector< int >	d_ghost_local_petsc_indices
std::vector< double >	d_periodic_shifts
std::vector< double >	d_interior_periodic_shifts
std::vector< double >	d_ghost_periodic_shifts

Detailed Description

template<class T>
class IBTK::LIndexSetData< T >

See also

LSetData

SAMRAI::pdat::IndexData

Constructor & Destructor Documentation

LIndexSetData() [1/3]

template<class T >

IBTK::LIndexSetData< T >::LIndexSetData	(	SAMRAI::hier::Box< NDIM >	box,
		SAMRAI::hier::IntVector< NDIM >	ghosts
	)

The constructor for an LIndexSetData object. The box describes the interior of the index space and the ghosts vector describes the ghost nodes in each coordinate direction.

~LIndexSetData()

template<class T >

virtual IBTK::LIndexSetData< T >::~LIndexSetData ( )

virtualdefault

The virtual destructor for an LIndexSetData object.

LIndexSetData() [2/3]

template<class T >

IBTK::LIndexSetData< T >::LIndexSetData ( )

privatedelete

Note

This constructor is not implemented and should not be used.

LIndexSetData() [3/3]

template<class T >

IBTK::LIndexSetData< T >::LIndexSetData ( const LIndexSetData< T > &  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

cacheLocalIndices()

template<class T >

void IBTK::LIndexSetData< T >::cacheLocalIndices	(	SAMRAI::tbox::Pointer< SAMRAI::hier::Patch< NDIM > >	patch,
		const SAMRAI::hier::IntVector< NDIM > &	periodic_shift
	)

getLagrangianIndices()

template<class T >

const std::vector< int > & IBTK::LIndexSetData< T >::getLagrangianIndices

inline

Returns

A constant reference to the set of Lagrangian data indices that lie in the patch (including the ghost cell region).

getInteriorLagrangianIndices()

template<class T >

const std::vector< int > & IBTK::LIndexSetData< T >::getInteriorLagrangianIndices

inline

Returns

A constant reference to the set of Lagrangian data indices that lie in the patch interior.

getGhostLagrangianIndices()

template<class T >

const std::vector< int > & IBTK::LIndexSetData< T >::getGhostLagrangianIndices

inline

Returns

A constant reference to the set of Lagrangian data indices that lie in the ghost cell region of the patch data object.

getGlobalPETScIndices()

template<class T >

const std::vector< int > & IBTK::LIndexSetData< T >::getGlobalPETScIndices

inline

Returns

A constant reference to the set of global PETSc data indices that lie in the patch (including the ghost cell region).

getInteriorGlobalPETScIndices()

template<class T >

const std::vector< int > & IBTK::LIndexSetData< T >::getInteriorGlobalPETScIndices

inline

Returns

A constant reference to the set of global PETSc data indices that lie in the patch interior.

getGhostGlobalPETScIndices()

template<class T >

const std::vector< int > & IBTK::LIndexSetData< T >::getGhostGlobalPETScIndices

inline

Returns

A constant reference to the set of global PETSc data indices that lie in the ghost cell region of the patch data object.

getLocalPETScIndices()

template<class T >

const std::vector< int > & IBTK::LIndexSetData< T >::getLocalPETScIndices

inline

Returns

A constant reference to the set of local PETSc data indices that lie in the patch (including the ghost cell region).

getInteriorLocalPETScIndices()

template<class T >

const std::vector< int > & IBTK::LIndexSetData< T >::getInteriorLocalPETScIndices

inline

Returns

A constant reference to the set of local PETSc data indices that lie in the patch interior.

getGhostLocalPETScIndices()

template<class T >

const std::vector< int > & IBTK::LIndexSetData< T >::getGhostLocalPETScIndices

inline

Returns

A constant reference to the set of local PETSc data indices that lie in the ghost cell region of the patch data object.

getPeriodicShifts()

template<class T >

const std::vector< double > & IBTK::LIndexSetData< T >::getPeriodicShifts

Returns

A constant reference to the periodic shifts for the indices that lie in the patch (including the ghost cell region).

getInteriorPeriodicShifts()

template<class T >

const std::vector< double > & IBTK::LIndexSetData< T >::getInteriorPeriodicShifts

Returns

A constant reference to the periodic shifts for the indices that lie in the patch interior.

getGhostPeriodicShifts()

template<class T >

const std::vector< double > & IBTK::LIndexSetData< T >::getGhostPeriodicShifts

Returns

A constant reference to the periodic shifts for the indices that lie in the ghost cell region of the patch data object.

operator=()

template<class T >

LIndexSetData& IBTK::LIndexSetData< T >::operator= ( const LIndexSetData< T > &  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.

Member Data Documentation

d_lag_indices

template<class T >

std::vector<int> IBTK::LIndexSetData< T >::d_lag_indices

private

d_interior_lag_indices

template<class T >

std::vector<int> IBTK::LIndexSetData< T >::d_interior_lag_indices

private

d_ghost_lag_indices

template<class T >

std::vector<int> IBTK::LIndexSetData< T >::d_ghost_lag_indices

private

d_global_petsc_indices

template<class T >

std::vector<int> IBTK::LIndexSetData< T >::d_global_petsc_indices

private

d_interior_global_petsc_indices

template<class T >

std::vector<int> IBTK::LIndexSetData< T >::d_interior_global_petsc_indices

private

d_ghost_global_petsc_indices

template<class T >

std::vector<int> IBTK::LIndexSetData< T >::d_ghost_global_petsc_indices

private

d_local_petsc_indices

template<class T >

std::vector<int> IBTK::LIndexSetData< T >::d_local_petsc_indices

private

d_interior_local_petsc_indices

template<class T >

std::vector<int> IBTK::LIndexSetData< T >::d_interior_local_petsc_indices

private

d_ghost_local_petsc_indices

template<class T >

std::vector<int> IBTK::LIndexSetData< T >::d_ghost_local_petsc_indices

private

d_periodic_shifts

template<class T >

std::vector<double> IBTK::LIndexSetData< T >::d_periodic_shifts

private

d_interior_periodic_shifts

template<class T >

std::vector<double> IBTK::LIndexSetData< T >::d_interior_periodic_shifts

private

d_ghost_periodic_shifts

template<class T >

std::vector<double> IBTK::LIndexSetData< T >::d_ghost_periodic_shifts

private

---

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

• ibtk/include/ibtk/LEInteractor.h
• ibtk/include/ibtk/LIndexSetData.h
• ibtk/include/ibtk/private/LIndexSetData-inl.h