CellList_gen< dim, T, Prock, Mem_type, transform, vector_pos_type > Class Template Reference

Detailed Description

template<unsigned int dim, typename T, template< unsigned int, typename > class Prock, typename Mem_type = Mem_fast<>, typename transform = no_transform<dim,T>, typename vector_pos_type = openfpm::vector<Point<dim,T>>>
class CellList_gen< dim, T, Prock, Mem_type, transform, vector_pos_type >

Definition at line 33 of file CellListFast_gen.hpp.

Inheritance diagram for CellList_gen< dim, T, Prock, Mem_type, transform, vector_pos_type >:

Public Member Functions
const Prock< dim, CellList_gen< dim, T, Prock, Mem_type, transform, vector_pos_type > > &	getCellSFC () const
	Get the space filling curve object.
void	init_SFC ()
	Initialize Space-filling-curve (SFC)
Prock< dim, CellList_gen< dim, T, Prock, Mem_type, transform, vector_pos_type > >::Pit	getIterator ()
	return the celllist iterator (across cells)
void	Initialize (const Box< dim, T > &box, const size_t(&div)[dim], const size_t pad=1, size_t slot=STARTING_NSLOT)
const openfpm::vector< size_t > &	getKeys ()
	Return cellkeys vector.
size_t	get_gm ()
	return the ghost marker
void	set_gm (size_t g_m)
	Set the ghost marker.

Private Member Functions
void	initialize_sfc (size_t pad)
	Initialize the space-filling-curve.

Private Attributes
size_t	g_m = 0
	Ghost marker.
Prock< dim, CellList_gen< dim, T, Prock, Mem_type, transform, vector_pos_type > >	SFC
bool	init_sfc
	Init SFC.

Constructor & Destructor Documentation

CellList_gen()

template<unsigned int dim, typename T , template< unsigned int, typename > class Prock, typename Mem_type = Mem_fast<>, typename transform = no_transform<dim,T>, typename vector_pos_type = openfpm::vector<Point<dim,T>>>

CellList_gen< dim, T, Prock, Mem_type, transform, vector_pos_type >::CellList_gen ( )

inline

Definition at line 97 of file CellListFast_gen.hpp.

Member Function Documentation

get_gm()

template<unsigned int dim, typename T , template< unsigned int, typename > class Prock, typename Mem_type = Mem_fast<>, typename transform = no_transform<dim,T>, typename vector_pos_type = openfpm::vector<Point<dim,T>>>

size_t CellList_gen< dim, T, Prock, Mem_type, transform, vector_pos_type >::get_gm ( )

inline

return the ghost marker

Returns

ghost marker

Definition at line 167 of file CellListFast_gen.hpp.

getCellSFC()

template<unsigned int dim, typename T , template< unsigned int, typename > class Prock, typename Mem_type = Mem_fast<>, typename transform = no_transform<dim,T>, typename vector_pos_type = openfpm::vector<Point<dim,T>>>

const Prock< dim, CellList_gen< dim, T, Prock, Mem_type, transform, vector_pos_type > > & CellList_gen< dim, T, Prock, Mem_type, transform, vector_pos_type >::getCellSFC ( ) const

inline

Get the space filling curve object.

Returns

the SFC object

Definition at line 107 of file CellListFast_gen.hpp.

getIterator()

template<unsigned int dim, typename T , template< unsigned int, typename > class Prock, typename Mem_type = Mem_fast<>, typename transform = no_transform<dim,T>, typename vector_pos_type = openfpm::vector<Point<dim,T>>>

Prock< dim, CellList_gen< dim, T, Prock, Mem_type, transform, vector_pos_type > >::Pit CellList_gen< dim, T, Prock, Mem_type, transform, vector_pos_type >::getIterator ( )

inline

return the celllist iterator (across cells)

Returns

an iterator

Definition at line 130 of file CellListFast_gen.hpp.

getKeys()

template<unsigned int dim, typename T , template< unsigned int, typename > class Prock, typename Mem_type = Mem_fast<>, typename transform = no_transform<dim,T>, typename vector_pos_type = openfpm::vector<Point<dim,T>>>

const openfpm::vector< size_t > & CellList_gen< dim, T, Prock, Mem_type, transform, vector_pos_type >::getKeys ( )

inline

Return cellkeys vector.

Returns

vector of cell keys

Definition at line 157 of file CellListFast_gen.hpp.

init_SFC()

template<unsigned int dim, typename T , template< unsigned int, typename > class Prock, typename Mem_type = Mem_fast<>, typename transform = no_transform<dim,T>, typename vector_pos_type = openfpm::vector<Point<dim,T>>>

void CellList_gen< dim, T, Prock, Mem_type, transform, vector_pos_type >::init_SFC ( )

inline

Initialize Space-filling-curve (SFC)

Definition at line 115 of file CellListFast_gen.hpp.

Initialize()

template<unsigned int dim, typename T , template< unsigned int, typename > class Prock, typename Mem_type = Mem_fast<>, typename transform = no_transform<dim,T>, typename vector_pos_type = openfpm::vector<Point<dim,T>>>

void CellList_gen< dim, T, Prock, Mem_type, transform, vector_pos_type >::Initialize ( const Box< dim, T > &  box, const size_t(&)  div[dim], const size_t  pad = 1, size_t  slot = STARTING_NSLOT  )

inline

Initialize the cell list

Parameters

box	Domain where this cell list is living
div	grid size on each dimension
g_m_new	A ghost marker
pad	padding cell
slot	maximum number of slot

Definition at line 146 of file CellListFast_gen.hpp.

initialize_sfc()

template<unsigned int dim, typename T , template< unsigned int, typename > class Prock, typename Mem_type = Mem_fast<>, typename transform = no_transform<dim,T>, typename vector_pos_type = openfpm::vector<Point<dim,T>>>

void CellList_gen< dim, T, Prock, Mem_type, transform, vector_pos_type >::initialize_sfc ( size_t  pad )

inlineprivate

Initialize the space-filling-curve.

Parameters

pad	padding of the cell-list

Definition at line 52 of file CellListFast_gen.hpp.

set_gm()

template<unsigned int dim, typename T , template< unsigned int, typename > class Prock, typename Mem_type = Mem_fast<>, typename transform = no_transform<dim,T>, typename vector_pos_type = openfpm::vector<Point<dim,T>>>

void CellList_gen< dim, T, Prock, Mem_type, transform, vector_pos_type >::set_gm ( size_t  g_m )

inline

Set the ghost marker.

Definition at line 176 of file CellListFast_gen.hpp.

Field Documentation

g_m

template<unsigned int dim, typename T , template< unsigned int, typename > class Prock, typename Mem_type = Mem_fast<>, typename transform = no_transform<dim,T>, typename vector_pos_type = openfpm::vector<Point<dim,T>>>

size_t CellList_gen< dim, T, Prock, Mem_type, transform, vector_pos_type >::g_m = 0

private

Ghost marker.

Definition at line 38 of file CellListFast_gen.hpp.

init_sfc

template<unsigned int dim, typename T , template< unsigned int, typename > class Prock, typename Mem_type = Mem_fast<>, typename transform = no_transform<dim,T>, typename vector_pos_type = openfpm::vector<Point<dim,T>>>

bool CellList_gen< dim, T, Prock, Mem_type, transform, vector_pos_type >::init_sfc

private

Init SFC.

Definition at line 45 of file CellListFast_gen.hpp.

SFC

template<unsigned int dim, typename T , template< unsigned int, typename > class Prock, typename Mem_type = Mem_fast<>, typename transform = no_transform<dim,T>, typename vector_pos_type = openfpm::vector<Point<dim,T>>>

Prock<dim,CellList_gen<dim,T,Prock,Mem_type,transform,vector_pos_type> > CellList_gen< dim, T, Prock, Mem_type, transform, vector_pos_type >::SFC

private

It is an object that indicate which space filling curve to use for the iteration across cells

Definition at line 42 of file CellListFast_gen.hpp.

---

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

• openfpm_data/src/NN/CellList/CellListFast_gen.hpp