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

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

Public Member Functions
void	initialize_one_particle_property (const Point< dim > &position, std::vector< double > &particle_properties) const override
virtual 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 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	~Interface ()=default
virtual void	initialize ()
virtual DEAL_II_DEPRECATED void	update_one_particle_property (const unsigned int data_position, const Point< dim > &position, const Vector< double > &solution, const std::vector< Tensor< 1, dim >> &gradients, const ArrayView< double > &particle_properties) const
virtual UpdateFlags	get_needed_update_flags () const
virtual InitializationModeForLateParticles	late_initialization_mode () const
virtual void	parse_parameters (ParameterHandler &prm)

Additional Inherited Members
Static Public Member Functions inherited from aspect::Particle::Property::Interface< dim >
static void	declare_parameters (ParameterHandler &prm)

Detailed Description

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

A class that sets particle properties to the current position.

Definition at line 38 of file reference_position.h.

Member Function Documentation

initialize_one_particle_property()

template<int dim>

void aspect::Particle::Property::ReferencePosition< 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 reference 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_property()

template<int dim>

virtual void aspect::Particle::Property::ReferencePosition< dim >::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

overridevirtual

Update function. This function is called every time an update is request by need_update() for every particle for every property. 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]	data_position	An unsigned integer that denotes which component of the particle property vector is associated with the current property. For properties that own several components it denotes the first component of this property, all other components fill consecutive entries in the particle_properties vector.
[in]	solution	The values of the solution variables at the current particle position.
[in]	gradients	The gradients of the solution variables at the current particle position.
[in,out]	particle	The particle that is updated within the call of this function. The particle location can be accessed using particle->get_location() and its properties using particle->get_properties().

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

need_update()

template<int dim>

UpdateTimeFlags aspect::Particle::Property::ReferencePosition< 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::ReferencePosition< 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/reference_position.h