aspect::Particle::Property::Position< dim > Class Template Reference

Inheritance diagram for aspect::Particle::Property::Position< dim >:

Public Member Functions
void	initialize_one_particle_property (const Point< dim > &position, std::vector< double > &particle_properties) const override
void	update_particle_properties (const ParticleUpdateInputs< dim > &inputs, typename ParticleHandler< dim >::particle_iterator_range &particles) const override
UpdateTimeFlags	need_update () const override
std::vector< std::pair< std::string, unsigned int > >	get_property_information () const override
Public Member Functions inherited from aspect::Particle::Property::Interface< dim >
virtual DEAL_II_DEPRECATED void	update_particle_property (const unsigned int data_position, const Vector< double > &solution, const std::vector< Tensor< 1, dim >> &gradients, typename ParticleHandler< dim >::particle_iterator &particle) const
virtual UpdateFlags	get_update_flags (const unsigned int component) const
virtual DEAL_II_DEPRECATED UpdateFlags	get_needed_update_flags () const
virtual InitializationModeForLateParticles	late_initialization_mode () const
virtual void	set_data_position (const unsigned int data_position)
virtual unsigned int	get_data_position () const
Public Member Functions inherited from aspect::Particle::ParticleInterfaceBase
	ParticleInterfaceBase ()
void	set_particle_manager_index (unsigned int particle_manager_index)
	Set which particle manager the plugin belongs to. More...
unsigned int	get_particle_manager_index () const
	Gets which particle manager the plugin belong to. More...
Public Member Functions inherited from aspect::Plugins::InterfaceBase
virtual	~InterfaceBase ()=default
virtual void	initialize ()
virtual void	update ()
virtual void	parse_parameters (ParameterHandler &prm)

Additional Inherited Members
Static Public Member Functions inherited from aspect::Plugins::InterfaceBase
static void	declare_parameters (ParameterHandler &prm)
Protected Attributes inherited from aspect::Particle::Property::Interface< dim >
unsigned int	data_position

Detailed Description

template<int dim>
class aspect::Particle::Property::Position< dim >

A class that sets particle properties to the current position.

Definition at line 38 of file position.h.

Member Function Documentation

initialize_one_particle_property()

template<int dim>

void aspect::Particle::Property::Position< dim >::initialize_one_particle_property ( const Point< dim > &  position, std::vector< double > &  particle_properties  ) const

overridevirtual

Initialization function. This function is called once at the creation of every particle for every property to initialize its value.

Parameters

[in]	position	The current particle position.
[in,out]	particle_properties	The properties of the particle that is initialized within the call of this function. The purpose of this function should be to extend this vector by a number of properties.

Reimplemented from aspect::Particle::Property::Interface< dim >.

update_particle_properties()

template<int dim>

void aspect::Particle::Property::Position< dim >::update_particle_properties ( const ParticleUpdateInputs< dim > &  inputs, typename ParticleHandler< dim >::particle_iterator_range &  particles  ) const

overridevirtual

Update function. This function is called every time an update is requested by need_update() for every cell for every property. It is expected to update the properties of all particles in the given range particles, which are all in one cell. It is obvious that this function is called a lot, so its code should be efficient. The interface provides a default implementation that does nothing, therefore derived plugins that do not require an update do not need to implement this function.

Parameters

[in]	inputs	A struct of type ParticleUpdateInputs that contains all necessary inputs to compute the particle updates. See the documentation of this struct in include/aspect/particle/property/interface.h for a list of all available inputs.
[in,out]	particles	The particles that are to be updated within this function.

Reimplemented from aspect::Particle::Property::Interface< dim >.

need_update()

template<int dim>

UpdateTimeFlags aspect::Particle::Property::Position< dim >::need_update ( ) const

overridevirtual

This implementation tells the particle manager that we need to update particle properties over time.

Reimplemented from aspect::Particle::Property::Interface< dim >.

get_property_information()

template<int dim>

std::vector<std::pair<std::string, unsigned int> > aspect::Particle::Property::Position< dim >::get_property_information ( ) const

overridevirtual

Set up the information about the names and number of components this property requires.

Returns

A vector that contains pairs of the property names and the number of components this property plugin defines.

Implements aspect::Particle::Property::Interface< dim >.

---

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

• /home/bob/source/include/aspect/particle/property/position.h