aspect::Particle::Generator Namespace Reference

Classes
class	AsciiFile
class	Interface
class	ProbabilityDensityFunction
class	QuadraturePoints
class	RandomUniform
class	ReferenceCell
class	UniformBox
class	UniformRadial

Functions
	DeclExceptionMsg (ExcParticlePointNotInDomain, "You requested to generate a particle at a position that " "is not owned by this process, therefore the " "Particle::Generator::Interface::generate_particle() function " "refused to create it. You can circumvent this error message " "by catching the ExcParticlePointNotInDomain exception and " "do whatever you think is appropriate in this case.")
template<int dim>
void	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 > >	create_particle_generator (ParameterHandler &prm)
template<int dim>
void	declare_parameters (ParameterHandler &prm)
template<int dim>
void	write_plugin_graph (std::ostream &output_stream)
template<int dim>
	DeclException1 (ProbabilityFunctionNegative, Point< dim >,<< "Your probability density function in the particle generator " "returned a negative probability density for the following position: "<< arg1<< ". Please check your function expression.")

Detailed Description

A namespace in which we define everything that has to do with defining the particle generation.

Function Documentation

DeclExceptionMsg()

aspect::Particle::Generator::DeclExceptionMsg	(	ExcParticlePointNotInDomain	,
		"You requested to generate a particle at a position that " "is not owned by this	process,
		therefore the " "Particle::Generator::Interface::generate_particle() function " "refused to create it. You can circumvent this error message " "by catching the ExcParticlePointNotInDomain exception and " "do whatever you think is appropriate in this case."
	)

Exception denoting a division by zero.

write_plugin_graph()

template<int dim>

void aspect::Particle::Generator::write_plugin_graph

(

std::ostream &

output_stream

)

For the current plugin subsystem, write a connection graph of all of the plugins we know about, in the format that the programs dot and neato understand. This allows for a visualization of how all of the plugins that ASPECT knows about are interconnected, and connect to other parts of the ASPECT code.

Parameters

output_stream

The stream to write the output to.

DeclException1()

template<int dim>

aspect::Particle::Generator::DeclException1	(	ProbabilityFunctionNegative	,
		Point< dim >	,
		<< "Your probability density function in the particle generator " "returned a negative probability density for the following position: "<< arg1<< ". Please check your function expression."
	)

Exception