H4::Neighbor< Tparticle > Class Template Reference

Neighbor information collector. More...

#include <neighbor.h>

Collaboration diagram for H4::Neighbor< Tparticle >:

Public Member Functions
	Neighbor ()
	constructor More...
bool	checkParams ()
	check whether parameters values are correct More...
void	printColumnTitle (std::ostream &_fout, const int _width=20)
	print titles of class members using column style More...
void	printColumn (std::ostream &_fout, const int _width=20)
	print data of class members using column style More...
void	reserveMem (const int _nmax)
	reserve memory for neighbor lists More...
void	clearNoFreeMemNoResizeNeighborAdress ()
	clear function More...
void	resetNeighbor ()
	reset neighbor information More...
void	clear ()
	clear function More...
void	clearNoFreeMem ()
	clear no release memory More...
template<class Tp >
void	checkAndAddNeighborSingle (const Float _r2, Tp &_particle, const Neighbor< Tparticle > &_nbp, const int _index)
	check and add neighbor of single More...
template<class Tgroup >
void	checkAndAddNeighborGroup (const Float _r2, Tgroup &_group, const int _index)
	check and add neighbor of group More...
void	checkGroupResolve ()
	check whether members should be resolved for outside More...

Public Attributes
int	r_min_index
int	mass_min_index
Float	r_min_sq
Float	r_min_mass
Float	mass_min
Float	r_neighbor_crit_sq
bool	need_resolve_flag
bool	initial_step_flag
int	n_neighbor_group
int	n_neighbor_single
COMM::List< NBAdr< Tparticle > >	neighbor_address

Detailed Description

template<class Tparticle>
class H4::Neighbor< Tparticle >

Neighbor information collector.

Constructor & Destructor Documentation

Neighbor()

template<class Tparticle >

H4::Neighbor< Tparticle >::Neighbor ( )

inline

constructor

Member Function Documentation

checkAndAddNeighborGroup()

template<class Tparticle >

template<class Tgroup >

void H4::Neighbor< Tparticle >::checkAndAddNeighborGroup ( const Float  _r2, Tgroup &  _group, const int  _index  )

inline

check and add neighbor of group

checkAndAddNeighborSingle()

template<class Tparticle >

template<class Tp >

void H4::Neighbor< Tparticle >::checkAndAddNeighborSingle ( const Float  _r2, Tp &  _particle, const Neighbor< Tparticle > &  _nbp, const int  _index  )

inline

check and add neighbor of single

checkGroupResolve()

template<class Tparticle >

void H4::Neighbor< Tparticle >::checkGroupResolve ( )

inline

check whether members should be resolved for outside

Parameters

[in]

_kappa

slowdown factor

checkParams()

template<class Tparticle >

bool H4::Neighbor< Tparticle >::checkParams ( )

inline

check whether parameters values are correct

Returns

true: all correct

clear()

template<class Tparticle >

void H4::Neighbor< Tparticle >::clear ( )

inline

clear function

Here is the call graph for this function:

clearNoFreeMem()

template<class Tparticle >

void H4::Neighbor< Tparticle >::clearNoFreeMem ( )

inline

clear no release memory

Here is the call graph for this function:

clearNoFreeMemNoResizeNeighborAdress()

template<class Tparticle >

void H4::Neighbor< Tparticle >::clearNoFreeMemNoResizeNeighborAdress ( )

inline

clear function

Here is the caller graph for this function:

printColumn()

template<class Tparticle >

void H4::Neighbor< Tparticle >::printColumn ( std::ostream &  _fout, const int  _width = 20  )

inline

print data of class members using column style

print data of class members in one line for column style. Notice no newline is printed at the end

Parameters

[out]	_fout	std::ostream output object
[in]	_width	print width (defaulted 20)

printColumnTitle()

template<class Tparticle >

void H4::Neighbor< Tparticle >::printColumnTitle ( std::ostream &  _fout, const int  _width = 20  )

inline

print titles of class members using column style

print titles of class members in one line for column style

Parameters

[out]	_fout	std::ostream output object
[in]	_width	print width (defaulted 20)

reserveMem()

template<class Tparticle >

void H4::Neighbor< Tparticle >::reserveMem ( const int  _nmax )

inline

reserve memory for neighbor lists

Parameters

[in]

_nmax

maximum number of neighbors

resetNeighbor()

template<class Tparticle >

void H4::Neighbor< Tparticle >::resetNeighbor ( )

inline

reset neighbor information

Member Data Documentation

initial_step_flag

template<class Tparticle >

bool H4::Neighbor< Tparticle >::initial_step_flag

mass_min

template<class Tparticle >

Float H4::Neighbor< Tparticle >::mass_min

mass_min_index

template<class Tparticle >

int H4::Neighbor< Tparticle >::mass_min_index

n_neighbor_group

template<class Tparticle >

int H4::Neighbor< Tparticle >::n_neighbor_group

n_neighbor_single

template<class Tparticle >

int H4::Neighbor< Tparticle >::n_neighbor_single

need_resolve_flag

template<class Tparticle >

bool H4::Neighbor< Tparticle >::need_resolve_flag

neighbor_address

template<class Tparticle >

COMM::List<NBAdr<Tparticle> > H4::Neighbor< Tparticle >::neighbor_address

r_min_index

template<class Tparticle >

int H4::Neighbor< Tparticle >::r_min_index

r_min_mass

template<class Tparticle >

Float H4::Neighbor< Tparticle >::r_min_mass

r_min_sq

template<class Tparticle >

Float H4::Neighbor< Tparticle >::r_min_sq

r_neighbor_crit_sq

template<class Tparticle >

Float H4::Neighbor< Tparticle >::r_neighbor_crit_sq

---

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

• neighbor.h