#include <deal.II/particles/particle_accessor.h>

Inheritance diagram for Particles::ParticleAccessor< dim, spacedim >:

Classes
struct	ParticlesInCell

Public Types
using	particle_container = std::list< ParticlesInCell >

Public Member Functions
void *	write_particle_data_to_memory (void *data) const

const void *	read_particle_data_from_memory (const void *data)

void	set_location (const Point< spacedim > &new_location)

const Point< spacedim > &	get_location () const

void	set_reference_location (const Point< dim > &new_reference_location)

const Point< dim > &	get_reference_location () const

void	set_id (const types::particle_index &new_id)

types::particle_index	get_id () const

types::particle_index	get_local_index () const

bool	has_properties () const

void	set_properties (const std::vector< double > &new_properties)

void	set_properties (const ArrayView< const double > &new_properties)

void	set_properties (const Tensor< 1, dim > &new_properties)

const ArrayView< double >	get_properties ()

const ArrayView< const double >	get_properties () const

void	set_property_pool (PropertyPool< dim, spacedim > &property_pool)

std::size_t	serialized_size_in_bytes () const

const Triangulation< dim, spacedim >::cell_iterator &	get_surrounding_cell () const

const Triangulation< dim, spacedim >::cell_iterator &	get_surrounding_cell (const Triangulation< dim, spacedim > &triangulation) const

template<class Archive >
void	save (Archive &ar, const unsigned int version) const

template<class Archive >
void	load (Archive &ar, const unsigned int version)

template<class Archive >
void	serialize (Archive &archive, const unsigned int version)

void	next ()

void	prev ()

bool	operator!= (const ParticleAccessor< dim, spacedim > &other) const

bool	operator== (const ParticleAccessor< dim, spacedim > &other) const

IteratorState::IteratorStates	state () const

Private Member Functions
	ParticleAccessor ()

	ParticleAccessor (const typename particle_container::iterator particles_in_cell, const PropertyPool< dim, spacedim > &property_pool, const unsigned int particle_index_within_cell)

const PropertyPool< dim, spacedim >::Handle &	get_handle () const

PropertyPool< dim, spacedim >::Handle &	get_handle ()

Private Attributes
particle_container::iterator	particles_in_cell

PropertyPool< dim, spacedim > *	property_pool

unsigned int	particle_index_within_cell

Friends
template<int , int >
class	ParticleIterator

template<int , int >
class	ParticleHandler

Detailed Description

template<int dim, int spacedim = dim>
class Particles::ParticleAccessor< dim, spacedim >

Accessor class used by ParticleIterator to access particle data.

Definition at line 45 of file particle_accessor.h.

Member Typedef Documentation

◆ particle_container

template<int dim, int spacedim = dim>

using Particles::ParticleAccessor< dim, spacedim >::particle_container = std::list<ParticlesInCell>

A type for the storage container for particles.

Definition at line 113 of file particle_accessor.h.

Constructor & Destructor Documentation

◆ ParticleAccessor() [1/2]

template<int dim, int spacedim>

Particles::ParticleAccessor< dim, spacedim >::ParticleAccessor

inlineprivate

Construct an invalid accessor. Such an object is not usable.

Definition at line 540 of file particle_accessor.h.

◆ ParticleAccessor() [2/2]

template<int dim, int spacedim>

Particles::ParticleAccessor< dim, spacedim >::ParticleAccessor	(	const typename particle_container::iterator	particles_in_cell,
		const PropertyPool< dim, spacedim > &	property_pool,
		const unsigned int	particle_index_within_cell
	)

inlineprivate

Construct an accessor from a reference to a container, an iterator to the current cell, and the particle index within that cell. This constructor is private so that it can only be accessed by friend classes.

Definition at line 549 of file particle_accessor.h.

Member Function Documentation

◆ write_particle_data_to_memory()

template<int dim, int spacedim>

void * Particles::ParticleAccessor< dim, spacedim >::write_particle_data_to_memory ( void * data ) const

inline

Write particle data into a data array. The array is expected to be large enough to take the data, and the void pointer should point to the first entry of the array to which the data should be written. This function is meant for serializing all particle properties and later de-serializing the properties by calling the appropriate constructor Particle(void *&data, PropertyPool *property_pool = nullptr);

Parameters

[in] data The memory location to write particle data into.

Returns: A pointer to the next byte after the array to which data has been written.

Definition at line 599 of file particle_accessor.h.

◆ read_particle_data_from_memory()

template<int dim, int spacedim>

const void * Particles::ParticleAccessor< dim, spacedim >::read_particle_data_from_memory ( const void * data )

inline

Update all of the data associated with a particle: id, location, reference location and, if any, properties by using a data array. The array is expected to be large enough to take the data, and the void pointer should point to the first entry of the array to which the data should be written. This function is meant for de-serializing the particle data without requiring that a new Particle class be built. This is used in the ParticleHandler to update the ghost particles without de-allocating and re-allocating memory.

Parameters

[in] data A pointer to a memory location from which to read the information that completely describes a particle. This class then de-serializes its data from this memory location.

Returns: A pointer to the next byte after the array from which data has been read.

Definition at line 562 of file particle_accessor.h.

◆ set_location()

template<int dim, int spacedim>

void Particles::ParticleAccessor< dim, spacedim >::set_location ( const Point< spacedim > & new_location )

inline

Set the location of this particle. Note that this does not check whether this is a valid location in the simulation domain.

Parameters

[in] new_location The new location for this particle.

Note: In parallel programs, the ParticleHandler class stores particles on both the locally owned cells, as well as on ghost cells. The particles on the latter are copies of particles owned on other processors, and should therefore be treated in the same way as ghost entries in vectors with ghost elements or ghost cells: In both cases, one should treat the ghost elements or cells as const objects that shouldn't be modified even if the objects allow for calls that modify properties. Rather, properties should only be modified on processors that actually own the particle.

Definition at line 633 of file particle_accessor.h.

◆ get_location()

template<int dim, int spacedim>

const Point< spacedim > & Particles::ParticleAccessor< dim, spacedim >::get_location

inline

Get the location of this particle.

Returns: The location of this particle.

Definition at line 644 of file particle_accessor.h.

◆ set_reference_location()

template<int dim, int spacedim>

void Particles::ParticleAccessor< dim, spacedim >::set_reference_location ( const Point< dim > & new_reference_location )

inline

Set the reference location of this particle.

Parameters

[in] new_reference_location The new reference location for this particle.

Note: In parallel programs, the ParticleHandler class stores particles on both the locally owned cells, as well as on ghost cells. The particles on the latter are copies of particles owned on other processors, and should therefore be treated in the same way as ghost entries in vectors with ghost elements or ghost cells: In both cases, one should treat the ghost elements or cells as const objects that shouldn't be modified even if the objects allow for calls that modify properties. Rather, properties should only be modified on processors that actually own the particle.

Definition at line 655 of file particle_accessor.h.

◆ get_reference_location()

template<int dim, int spacedim>

const Point< dim > & Particles::ParticleAccessor< dim, spacedim >::get_reference_location

inline

Return the reference location of this particle in its current cell.

Definition at line 667 of file particle_accessor.h.

◆ set_id()

template<int dim, int spacedim>

void Particles::ParticleAccessor< dim, spacedim >::set_id ( const types::particle_index & new_id )

inline

Set the ID number of this particle.

Definition at line 700 of file particle_accessor.h.

◆ get_id()

template<int dim, int spacedim>

types::particle_index Particles::ParticleAccessor< dim, spacedim >::get_id

inline

Return the ID number of this particle.

Definition at line 678 of file particle_accessor.h.

◆ get_local_index()

template<int dim, int spacedim>

types::particle_index Particles::ParticleAccessor< dim, spacedim >::get_local_index

inline

Return a particle ID number local to each MPI process. This number enables the direct array access (similar to LinearAlgebra::distributed::Vector::local_element()) to quantities used for local computations. Use ParticleHandler::get_max_local_particle_index() to query suitable array sizes.

Note: The number returned by this function is not stable between calls of ParticleHandler::sort_particles_into_subdomains_and_cells() and therefore it cannot be used to track quantities across those calls. Furthermore, the numbers returned by this function are typically not refreshed in case individual particles are removed from the underlying ParticleHandler object, which means that the returned indices of all particles on an MPI process typically do not form a contiguous interval of numbers. Use particle properties for storing persistent information and checkpointing the actual data.

Definition at line 689 of file particle_accessor.h.

◆ has_properties()

template<int dim, int spacedim>

bool Particles::ParticleAccessor< dim, spacedim >::has_properties

inline

Return whether this particle has a valid property pool and a valid handle to properties.

Definition at line 711 of file particle_accessor.h.

◆ set_properties() [1/3]

template<int dim, int spacedim>

void Particles::ParticleAccessor< dim, spacedim >::set_properties ( const std::vector< double > & new_properties )

inline

Set the properties of this particle.

Parameters

[in] new_properties A vector containing the new properties for this particle.

Note: In parallel programs, the ParticleHandler class stores particles on both the locally owned cells, as well as on ghost cells. The particles on the latter are copies of particles owned on other processors, and should therefore be treated in the same way as ghost entries in vectors with ghost elements or ghost cells: In both cases, one should treat the ghost elements or cells as const objects that shouldn't be modified even if the objects allow for calls that modify properties. Rather, properties should only be modified on processors that actually own the particle.

Definition at line 729 of file particle_accessor.h.

◆ set_properties() [2/3]

template<int dim, int spacedim>

void Particles::ParticleAccessor< dim, spacedim >::set_properties ( const ArrayView< const double > & new_properties )

inline

Set the properties of this particle.

Parameters

[in] new_properties An ArrayView pointing to memory locations containing the new properties for this particle.

Note: In parallel programs, the ParticleHandler class stores particles on both the locally owned cells, as well as on ghost cells. The particles on the latter are copies of particles owned on other processors, and should therefore be treated in the same way as ghost entries in vectors with ghost elements or ghost cells: In both cases, one should treat the ghost elements or cells as const objects that shouldn't be modified even if the objects allow for calls that modify properties. Rather, properties should only be modified on processors that actually own the particle.

Definition at line 742 of file particle_accessor.h.

◆ set_properties() [3/3]

template<int dim, int spacedim>

void Particles::ParticleAccessor< dim, spacedim >::set_properties ( const Tensor< 1, dim > & new_properties )

inline

Set the properties of this particle, assuming that the properties stored on this particle correspond to a rank-1 Tensor object. In particular, this means that the number of properties stored on the particle must equal dim.

Parameters

[in] new_properties A Tensor containing the new properties for this particle.

Note: In parallel programs, the ParticleHandler class stores particles on both the locally owned cells, as well as on ghost cells. The particles on the latter are copies of particles owned on other processors, and should therefore be treated in the same way as ghost entries in vectors with ghost elements or ghost cells: In both cases, one should treat the ghost elements or cells as const objects that shouldn't be modified even if the objects allow for calls that modify properties. Rather, properties should only be modified on processors that actually own the particle.

Definition at line 769 of file particle_accessor.h.

◆ get_properties() [1/2]

template<int dim, int spacedim>

const ArrayView< double > Particles::ParticleAccessor< dim, spacedim >::get_properties

inline

Get write-access to properties of this particle.

Returns: An ArrayView of the properties of this particle.

Definition at line 837 of file particle_accessor.h.

◆ get_properties() [2/2]

template<int dim, int spacedim>

const ArrayView< const double > Particles::ParticleAccessor< dim, spacedim >::get_properties

inline

Get read-access to properties of this particle.

Returns: An ArrayView of the properties of this particle.

Definition at line 788 of file particle_accessor.h.

◆ set_property_pool()

template<int dim, int spacedim>

void Particles::ParticleAccessor< dim, spacedim >::set_property_pool ( PropertyPool< dim, spacedim > & property_pool )

inline

Tell the particle where to store its properties (even if it does not own properties). Usually this is only done once per particle, but since the particle generator does not know about the properties we want to do it not at construction time. Another use for this function is after particle transfer to a new process.

Deprecated:: This function is only kept for backward compatibility and has no meaning any more. ParticleAccessors always use the property pool of the owning particle handler.

Definition at line 799 of file particle_accessor.h.

◆ serialized_size_in_bytes()

template<int dim, int spacedim>

std::size_t Particles::ParticleAccessor< dim, spacedim >::serialized_size_in_bytes

inline

Return the size in bytes this particle occupies if all of its data is serialized (i.e. the number of bytes that is written by the write_data function of this class).

Definition at line 848 of file particle_accessor.h.

◆ get_surrounding_cell() [1/2]

template<int dim, int spacedim>

const Triangulation< dim, spacedim >::cell_iterator & Particles::ParticleAccessor< dim, spacedim >::get_surrounding_cell

inline

Get a cell iterator to the cell surrounding the current particle. As particles are organized in the structure of a triangulation, but the triangulation itself is not stored in the particle this operation requires a reference to the triangulation.

Definition at line 810 of file particle_accessor.h.

◆ get_surrounding_cell() [2/2]

template<int dim, int spacedim>

const Triangulation< dim, spacedim >::cell_iterator & Particles::ParticleAccessor< dim, spacedim >::get_surrounding_cell ( const Triangulation< dim, spacedim > & triangulation ) const

inline

Deprecated:: Deprecated version of the function with the same name above.

Definition at line 823 of file particle_accessor.h.

◆ save()

template<int dim, int spacedim>

template<class Archive >

void Particles::ParticleAccessor< dim, spacedim >::save	(	Archive &	ar,
		const unsigned int	version
	)		const

inline

Write the data of this object to a stream for the purpose of serialization using the BOOST serialization library.

Definition at line 518 of file particle_accessor.h.

◆ load()

template<int dim, int spacedim>

template<class Archive >

void Particles::ParticleAccessor< dim, spacedim >::load	(	Archive &	ar,
		const unsigned int	version
	)

inline

Read the data of this object from a stream for the purpose of serialization using the BOOST serialization library. Note that in order to store the properties correctly, the property pool of this particle has to be known at the time of reading, i.e. set_property_pool() has to have been called, before this function is called.

Definition at line 484 of file particle_accessor.h.

◆ serialize()

template<int dim, int spacedim = dim>

template<class Archive >

void Particles::ParticleAccessor< dim, spacedim >::serialize	(	Archive &	archive,
		const unsigned int	version
	)

Write and read the data of this object from a stream for the purpose of serialization using the BOOST serialization library.

◆ next()

template<int dim, int spacedim>

void Particles::ParticleAccessor< dim, spacedim >::next

inline

Advance the ParticleAccessor to the next particle.

Definition at line 866 of file particle_accessor.h.

◆ prev()

template<int dim, int spacedim>

void Particles::ParticleAccessor< dim, spacedim >::prev

inline

Move the ParticleAccessor to the previous particle.

Definition at line 883 of file particle_accessor.h.

◆ operator!=()

template<int dim, int spacedim>

bool Particles::ParticleAccessor< dim, spacedim >::operator!= ( const ParticleAccessor< dim, spacedim > & other ) const

inline

Inequality operator.

Definition at line 902 of file particle_accessor.h.

◆ operator==()

template<int dim, int spacedim>

bool Particles::ParticleAccessor< dim, spacedim >::operator== ( const ParticleAccessor< dim, spacedim > & other ) const

inline

Equality operator.

Definition at line 912 of file particle_accessor.h.

◆ state()

template<int dim, int spacedim>

IteratorState::IteratorStates Particles::ParticleAccessor< dim, spacedim >::state

inline

Return the state of the accessor.

Definition at line 924 of file particle_accessor.h.

◆ get_handle() [1/2]

template<int dim, int spacedim>

const PropertyPool< dim, spacedim >::Handle & Particles::ParticleAccessor< dim, spacedim >::get_handle

inlineprivate

Returns a reference to the current Particle. Because the internal structure may change this is not intended for public use and only a convenience function for internal purposes.

Definition at line 953 of file particle_accessor.h.

◆ get_handle() [2/2]

template<int dim, int spacedim>

PropertyPool< dim, spacedim >::Handle & Particles::ParticleAccessor< dim, spacedim >::get_handle

inlineprivate

Non-const version of the function with the same name above.

Definition at line 944 of file particle_accessor.h.

Friends And Related Function Documentation

◆ ParticleIterator

template<int dim, int spacedim = dim>

template<int , int >

friend class ParticleIterator

friend

Definition at line 474 of file particle_accessor.h.

◆ ParticleHandler

template<int dim, int spacedim = dim>

template<int , int >

friend class ParticleHandler

friend

Definition at line 476 of file particle_accessor.h.

Member Data Documentation

◆ particles_in_cell

template<int dim, int spacedim = dim>

particle_container::iterator Particles::ParticleAccessor< dim, spacedim >::particles_in_cell

private

An iterator to the particles in the current cell within the particle_container object.

Definition at line 459 of file particle_accessor.h.

◆ property_pool

template<int dim, int spacedim = dim>

PropertyPool<dim, spacedim>* Particles::ParticleAccessor< dim, spacedim >::property_pool

private

A pointer to the property pool that stores the actual particle data.

Definition at line 464 of file particle_accessor.h.

◆ particle_index_within_cell

template<int dim, int spacedim = dim>

unsigned int Particles::ParticleAccessor< dim, spacedim >::particle_index_within_cell

private

Local index of the particle within its current cell.

Definition at line 469 of file particle_accessor.h.

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

include/deal.II/particles/particle_accessor.h

Classes

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ particle_container

Constructor & Destructor Documentation

◆ ParticleAccessor() [1/2]

◆ ParticleAccessor() [2/2]

Member Function Documentation

◆ write_particle_data_to_memory()

◆ read_particle_data_from_memory()

◆ set_location()

◆ get_location()

◆ set_reference_location()

◆ get_reference_location()

◆ set_id()

◆ get_id()

◆ get_local_index()

◆ has_properties()

◆ set_properties() [1/3]

◆ set_properties() [2/3]

◆ set_properties() [3/3]

◆ get_properties() [1/2]

◆ get_properties() [2/2]

◆ set_property_pool()

◆ serialized_size_in_bytes()

◆ get_surrounding_cell() [1/2]

◆ get_surrounding_cell() [2/2]

◆ save()

◆ load()

◆ serialize()

◆ next()

◆ prev()

◆ operator!=()

◆ operator==()

◆ state()

◆ get_handle() [1/2]

◆ get_handle() [2/2]

Friends And Related Function Documentation

◆ ParticleIterator

◆ ParticleHandler

Member Data Documentation

◆ particles_in_cell

◆ property_pool

◆ particle_index_within_cell