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

Inheritance diagram for aspect::Particle::Property::IntegratorProperties< 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
void	parse_parameters (ParameterHandler &prm) 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 ()

Private Attributes
unsigned int	n_integrator_properties

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::IntegratorProperties< dim >

A particle property that provides storage space for the properties that particle integrators need to store. This is an internal property that is not intended for use outside of the particle integrators and that will not be written to output files.

Definition at line 551 of file interface.h.

Member Function Documentation

initialize_one_particle_property()

template<int dim>

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

overridevirtual

Initialization function. Since these properties are set and used by the integrator this function only resizes them to the correct size, but does not need to do any initialization.

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

get_property_information()

template<int dim>

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

overridevirtual

Set up the information about the names and number of components this property requires. This depends on the chosen integration scheme.

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 >.

parse_parameters()

template<int dim>

void aspect::Particle::Property::IntegratorProperties< dim >::parse_parameters ( ParameterHandler &  prm )

overridevirtual

Read the parameters this class needs to determine which integrator is used, and therefore how many properties to reserve.

Reimplemented from aspect::Plugins::InterfaceBase.

Member Data Documentation

n_integrator_properties

template<int dim>

unsigned int aspect::Particle::Property::IntegratorProperties< dim >::n_integrator_properties

private

The number of integrator properties to store. This variable is initialized in parse_parameters().

Definition at line 585 of file interface.h.

---

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

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