Describing the method to generate particles

Collaboration diagram for Describing the method to generate particles:

Namespaces
	aspect::Particle::Generator

Classes
class	aspect::Particle::Generator::AsciiFile< dim >
class	aspect::Particle::Generator::Interface< dim >
class	aspect::Particle::Generator::ProbabilityDensityFunction< dim >
class	aspect::Particle::Generator::QuadraturePoints< dim >
class	aspect::Particle::Generator::RandomUniform< dim >
class	aspect::Particle::Generator::ReferenceCell< dim >
class	aspect::Particle::Generator::UniformBox< dim >
class	aspect::Particle::Generator::UniformRadial< dim >

Macros
#define	ASPECT_REGISTER_PARTICLE_GENERATOR(classname, name, description)

Functions
template<int dim>
void	aspect::Particle::Generator::register_particle_generator (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::Generator::create_particle_generator (ParameterHandler &prm)
template<int dim>
void	aspect::Particle::Generator::declare_parameters (ParameterHandler &prm)

Detailed Description

A module for the definition of functions and classes that have to do with describing a method to generate particles in the model domain.

Macro Definition Documentation

ASPECT_REGISTER_PARTICLE_GENERATOR

#define ASPECT_REGISTER_PARTICLE_GENERATOR	(		classname,
			name,
			description
	)

Value:

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

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

Definition at line 272 of file interface.h.

Function Documentation

register_particle_generator()

template<int dim>

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

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

Parameters

name	A string that identifies the particle generator
description	A text description of what this generator 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 generator wants to read from input files.
factory_function	A pointer to a function that can create an object of this particle generator.

create_particle_generator()

template<int dim>

std::unique_ptr<Interface<dim> > aspect::Particle::Generator::create_particle_generator

(

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::Generator::declare_parameters

(

ParameterHandler &

prm

)

Declare the runtime parameters of the registered particle generators.