Describing the method to integrate particles

Collaboration diagram for Describing the method to integrate particles:

Classes
class	aspect::Particle::Integrator::Euler< dim >
class	aspect::Particle::Integrator::Interface< dim >
class	aspect::Particle::Integrator::RK2< dim >
class	aspect::Particle::Integrator::RK4< dim >

Macros
#define	ASPECT_REGISTER_PARTICLE_INTEGRATOR(classname, name, description)

Functions
template<int dim>
void	aspect::Particle::Integrator::register_particle_integrator (const std::string &name, const std::string &description, void(*declare_parameters_function)(ParameterHandler &), std::unique_ptr< Interface< dim >>(*factory_function)())
template<int dim>
std::unique_ptr< Interface< dim > >	aspect::Particle::Integrator::create_particle_integrator (ParameterHandler &prm)
template<int dim>
void	aspect::Particle::Integrator::declare_parameters (ParameterHandler &prm)

Detailed Description

A module for the definition of functions and classes that have to do with integrating the particle positions through time.

Macro Definition Documentation

ASPECT_REGISTER_PARTICLE_INTEGRATOR

#define ASPECT_REGISTER_PARTICLE_INTEGRATOR	(		classname,
			name,
			description
	)

Value:

template class classname<2>; \
  template class classname<3>; \
  namespace ASPECT_REGISTER_PARTICLE_INTEGRATOR_ ## classname \
  { \
    aspect::internal::Plugins::RegisterHelper<aspect::Particle::Integrator::Interface<2>,classname<2>> \
    dummy_ ## classname ## _2d (&aspect::Particle::Integrator::register_particle_integrator<2>, \
                                name, description); \
    aspect::internal::Plugins::RegisterHelper<aspect::Particle::Integrator::Interface<3>,classname<3>> \
    dummy_ ## classname ## _3d (&aspect::Particle::Integrator::register_particle_integrator<3>, \
                                name, description); \
  }

Given a class name, a name, and a description for the parameter file for a particle integrator, register it with the functions that can declare their parameters and create these objects.

Definition at line 225 of file interface.h.

Function Documentation

register_particle_integrator()

template<int dim>

void aspect::Particle::Integrator::register_particle_integrator	(	const std::string &	name,
		const std::string &	description,
		void(*)(ParameterHandler &)	declare_parameters_function,
		std::unique_ptr< Interface< dim >>(*)()	factory_function
	)

Register a particle integrator so that it can be selected from the parameter file.

Parameters

name	A string that identifies the particle integrator
description	A text description of what this integrator does and that will be listed in the documentation of the parameter file.
declare_parameters_function	A pointer to a function that can be used to declare the parameters that this particle integrator wants to read from input files.
factory_function	A pointer to a function that can create an object of this particle integrator.

create_particle_integrator()

template<int dim>

std::unique_ptr<Interface<dim> > aspect::Particle::Integrator::create_particle_integrator

(

ParameterHandler &

prm

)

A function that given the name of a model returns a pointer to an object that describes it. Ownership of the pointer is transferred to the caller.

The model object returned is not yet initialized and has not read its runtime parameters yet.

declare_parameters()

template<int dim>

void aspect::Particle::Integrator::declare_parameters

(

ParameterHandler &

prm

)

Declare the runtime parameters of the registered particle integrators.