Public Member Functions | Private Attributes | List of all members
aspect::Particle::Property::IntegratorProperties< dim > Class Template Reference
Inheritance diagram for aspect::Particle::Property::IntegratorProperties< dim >:
Inheritance graph

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
virtual void parse_parameters (ParameterHandler &prm) override
- Public Member Functions inherited from aspect::Particle::Property::Interface< dim >
virtual ~Interface ()=default
virtual void initialize ()
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
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 UpdateTimeFlags need_update () const
virtual UpdateFlags get_needed_update_flags () const
virtual InitializationModeForLateParticles late_initialization_mode () const

Private Attributes

unsigned int n_integrator_properties

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::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 513 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

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

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

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

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

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

Member Data Documentation

§ n_integrator_properties

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

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

Definition at line 548 of file interface.h.

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