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

Public Member Functions

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

Static Public Member Functions

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

Private Attributes

std::unique_ptr< Functions::ParsedFunction< dim > > function
 
unsigned int n_components
 

Detailed Description

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

A class that initializes particle properties based on a functional description provided in the input file.

Definition at line 41 of file function.h.

Constructor & Destructor Documentation

§ Function()

template<int dim>
aspect::Particle::Property::Function< dim >::Function ( )

Member Function Documentation

§ initialize_one_particle_property()

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

§ get_property_information()

template<int dim>
virtual std::vector<std::pair<std::string, unsigned int> > aspect::Particle::Property::Function< 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 >.

§ declare_parameters()

template<int dim>
static void aspect::Particle::Property::Function< dim >::declare_parameters ( ParameterHandler prm)
static

Declare the parameters this class takes through input files.

§ parse_parameters()

template<int dim>
virtual void aspect::Particle::Property::Function< dim >::parse_parameters ( ParameterHandler prm)
virtual

Read the parameters this class declares from the parameter file.

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

Member Data Documentation

§ function

template<int dim>
std::unique_ptr<Functions::ParsedFunction<dim> > aspect::Particle::Property::Function< dim >::function
private

A function object representing the particle property.

Definition at line 92 of file function.h.

§ n_components

template<int dim>
unsigned int aspect::Particle::Property::Function< dim >::n_components
private

A private variable that stores the number of particle property function components.

Definition at line 98 of file function.h.


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