#include <ParticleLayoutFromGrid.h>

Inheritance diagram for ParticleLayoutFromGrid:

Collaboration diagram for ParticleLayoutFromGrid:

Public Types
typedef int	pair_t

typedef pair_t *	pair_iterator

typedef ParticleAttrib < SingleParticlePos_t >	ParticlePos_t

typedef ParticleAttrib< Index_t >	ParticleIndex_t

typedef Vektor< double, 3 >	Vector_t

Public Types inherited from ParticleLayout< double, 3 >
enum

enum	UpdateFlags

typedef double	Position_t

typedef unsigned	Index_t

typedef Vektor< double, Dim >	SingleParticlePos_t

Public Member Functions
	ParticleLayoutFromGrid (Grid grid, Domain domain, D3vector &local_min, D3vector &local_max)

void	update (IpplParticleBase< ParticleLayoutFromGrid > &particles)

bool	is_local_pos (const Vector_t &x) const

bool	is_local_pos (const D3vector &x) const

bool	is_in_domain (const D3vector &x) const

bool	is_in_domain (const Vector_t &x) const

Public Member Functions inherited from ParticleLayout< double, 3 >
	ParticleLayout ()

	~ParticleLayout ()

void	setUpdateFlag (UpdateFlags f, bool val)

bool	getUpdateFlag (UpdateFlags f) const

ParticleBConds< double, Dim > &	getBConds ()

void	setBConds (const ParticleBConds< double, Dim > &bc)

Static Public Member Functions
static bool	is_inside_box (const D3vector &corner_min, const D3vector &corner_max, const D3vector &x)

Private Member Functions
void	apply_bconds (ParticlePos_t &R)

size_t	redistribute_particles (IpplParticleBase< ParticleLayoutFromGrid > &particles)

Private Attributes
Grid *	grid_

Domain *	geom_domain_

D3vector	my_corner_min_

D3vector	my_corner_max_

Additional Inherited Members
Protected Member Functions inherited from ParticleLayout< double, 3 >
void	apply_bconds (unsigned n, PPT &R, const ParticleBConds< double, Dim > &bcs, const NDI &nr)

Detailed Description

Definition at line 18 of file ParticleLayoutFromGrid.h.

Member Typedef Documentation

typedef pair_t* ParticleLayoutFromGrid::pair_iterator

Definition at line 21 of file ParticleLayoutFromGrid.h.

typedef int ParticleLayoutFromGrid::pair_t

Definition at line 20 of file ParticleLayoutFromGrid.h.

typedef ParticleAttrib<Index_t> ParticleLayoutFromGrid::ParticleIndex_t

Definition at line 23 of file ParticleLayoutFromGrid.h.

typedef ParticleAttrib<SingleParticlePos_t> ParticleLayoutFromGrid::ParticlePos_t

Definition at line 22 of file ParticleLayoutFromGrid.h.

typedef Vektor<double,3> ParticleLayoutFromGrid::Vector_t

Definition at line 24 of file ParticleLayoutFromGrid.h.

Constructor & Destructor Documentation

ParticleLayoutFromGrid::ParticleLayoutFromGrid	(	Grid *	grid,
		Domain *	domain,
		D3vector &	local_min,
		D3vector &	local_max
	)

inline

Constructor.

Parameters

grid	Grid.
domain	Domain on which the grid is based.
local_min	Corner of axiparallel box defining local domain (with minimal coordinates)
local_max	Corner of axiparallel box defining local domain (with maximal coordinates)

Definition at line 32 of file ParticleLayoutFromGrid.h.

Member Function Documentation

void ParticleLayoutFromGrid::apply_bconds ( ParticlePos_t & R )

private

Dummy function for boundary treatment (currently not used)

Parameters

R	Particle positions.

Definition at line 43 of file ParticleLayoutFromGrid.cpp.

References endl(), geom_domain_, and ParticleAttrib< T >::size().

Here is the call graph for this function:

bool ParticleLayoutFromGrid::is_in_domain ( const D3vector & x ) const

inline

Test if x is inside the geometric domain

Parameters

x	Position to test.

Returns: True if inside.

Definition at line 73 of file ParticleLayoutFromGrid.h.

References geom_domain_.

bool ParticleLayoutFromGrid::is_in_domain ( const Vector_t & x ) const

inline

Test if x is inside the geometric domain

Parameters

x	Position to test.

Returns: True if inside.

Definition at line 81 of file ParticleLayoutFromGrid.h.

References geom_domain_.

static bool ParticleLayoutFromGrid::is_inside_box	(	const D3vector &	corner_min,
		const D3vector &	corner_max,
		const D3vector &	x
	)

inlinestatic

Test whether x is inside axiparalllel box defined by corner_min and corner_max.

Parameters

corner_min	Coordinates of box corner with minimal values.
corner_max	Coordinates of box corner with maximal values.
x	Position to test.

Returns: True if x is inside.

Definition at line 93 of file ParticleLayoutFromGrid.h.

Referenced by is_local_pos(), and redistribute_particles().

bool ParticleLayoutFromGrid::is_local_pos ( const Vector_t & x ) const

inline

Test if x is inside the domain assigned to my processor.

Parameters

x	Position to test.

Returns: True if inside.

Definition at line 55 of file ParticleLayoutFromGrid.h.

References is_inside_box(), my_corner_max_, and my_corner_min_.

Referenced by redistribute_particles().

Here is the call graph for this function:

bool ParticleLayoutFromGrid::is_local_pos ( const D3vector & x ) const

inline

Test if x is inside the domain assigned to my processor.

Parameters

x	Position to test.

Returns: True if inside.

Definition at line 64 of file ParticleLayoutFromGrid.h.

References is_inside_box(), my_corner_max_, and my_corner_min_.

Here is the call graph for this function:

size_t ParticleLayoutFromGrid::redistribute_particles ( IpplParticleBase< ParticleLayoutFromGrid > & particles )

private

Go through all local particles, and send particles which are no longer in the local bounding box to the corresponding processors.

Parameters

particles Particle container

Returns: Number of locally stored particles after redistribution

Definition at line 56 of file ParticleLayoutFromGrid.cpp.

Referenced by update().

Here is the call graph for this function:

void ParticleLayoutFromGrid::update ( IpplParticleBase< ParticleLayoutFromGrid > & particles )

Does "book--keeping" after particles have been integrated one time step.

"Book--keeping" includes

Detecting particles which have moved across a boundary and taking appropriate measures. (not yet implemented)
Redistributing particles which have moved out of the domain assigned to the local processor.
Updating the total particle count.
Parameters

particles Particle container.

Definition at line 15 of file ParticleLayoutFromGrid.cpp.

References IpplParticleBase< PLayout >::getDestroyNum(), IpplParticleBase< PLayout >::getLocalNum(), IpplInfo::getNodes(), grid_, IpplInfo::myNode(), IpplParticleBase< PLayout >::performDestroy(), redistribute_particles(), reduce(), IpplParticleBase< PLayout >::setLocalNum(), and IpplParticleBase< PLayout >::setTotalNum().

Here is the call graph for this function: