ASPECT
Public Member Functions | List of all members
aspect::Particle::Property::Position< dim > Class Template Reference
Inheritance diagram for aspect::Particle::Property::Position< dim >:
Inheritance graph
[legend]

Public Member Functions

virtual void initialize_one_particle_property (const Point< dim > &position, std::vector< double > &particle_properties) const
 
virtual 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
 
UpdateTimeFlags need_update () const
 
virtual std::vector< std::pair< std::string, unsigned int > > get_property_information () const
 
- Public Member Functions inherited from aspect::Particle::Property::Interface< dim >
virtual ~Interface ()
 
virtual void initialize ()
 
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::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>
virtual void aspect::Particle::Property::Position< dim >::initialize_one_particle_property ( const Point< dim > &  position,
std::vector< double > &  particle_properties 
) const
virtual

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

Parameters
[in]positionThe current particle position.
[in,out]particle_propertiesThe 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_one_particle_property()

template<int dim>
virtual void aspect::Particle::Property::Position< dim >::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

Update function. This function is called every time an update is request by need_update() for every particle for every property.

Parameters
[in]data_positionAn 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]positionThe current particle position.
[in]solutionThe values of the solution variables at the current particle position.
[in]gradientsThe gradients of the solution variables at the current particle position.
[in,out]particle_propertiesThe properties of the particle that is updated within the call of this function.

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

§ need_update()

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

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>
virtual std::vector<std::pair<std::string, unsigned int> > aspect::Particle::Property::Position< dim >::get_property_information ( ) const
virtual

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: