aspect::Particle::ParticleInterfaceBase Class Reference

Inheritance diagram for aspect::Particle::ParticleInterfaceBase:

Public Member Functions
	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 ()
virtual void	parse_parameters (ParameterHandler &prm)

Private Attributes
unsigned int	particle_manager_index

Additional Inherited Members
Static Public Member Functions inherited from aspect::Plugins::InterfaceBase
static void	declare_parameters (ParameterHandler &prm)

Detailed Description

A base class defining methods and member variables shared along all the particle plugins. This includes the generator, integrator, interpolator and the property classes.

Definition at line 37 of file interface.h.

Constructor & Destructor Documentation

ParticleInterfaceBase()

aspect::Particle::ParticleInterfaceBase::ParticleInterfaceBase

(

)

Constructor.

Member Function Documentation

set_particle_manager_index()

void aspect::Particle::ParticleInterfaceBase::set_particle_manager_index

(

unsigned int

particle_manager_index

)

Set which particle manager the plugin belongs to.

Parameters

particle_manager_index

The index of the particle manager this plugin belongs to.

get_particle_manager_index()

unsigned int aspect::Particle::ParticleInterfaceBase::get_particle_manager_index

(

)

const

Gets which particle manager the plugin belong to.

Member Data Documentation

particle_manager_index

unsigned int aspect::Particle::ParticleInterfaceBase::particle_manager_index

private

Stores the index to the particle manager, to which the plugin belongs.

Definition at line 61 of file interface.h.

---

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

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