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

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

Public Member Functions
void	initialize_one_particle_property (const Point< dim > &position, std::vector< double > &particle_properties) 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 void	update_particle_properties (const ParticleUpdateInputs< dim > &inputs, typename ParticleHandler< dim >::particle_iterator_range &particles) const
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 UpdateTimeFlags	need_update () 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::InitialPosition< dim >

A class that initializes particle properties based on the initial position of the particles.

Definition at line 39 of file initial_position.h.

Member Function Documentation

initialize_one_particle_property()

template<int dim>

void aspect::Particle::Property::InitialPosition< 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 >.

get_property_information()

template<int dim>

std::vector<std::pair<std::string, unsigned int> > aspect::Particle::Property::InitialPosition< 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/initial_position.h