ASPECT
Classes | Functions
aspect::Particle::Output Namespace Reference

Classes

class  ASCIIOutput
 
class  HDF5Output
 
class  Interface
 
class  VTUOutput
 

Functions

template<int dim>
void register_particle_output (const std::string &name, const std::string &description, void(*declare_parameters_function)(ParameterHandler &), Interface< dim > *(*factory_function)())
 
template<int dim>
Interface< dim > * create_particle_output (ParameterHandler &prm)
 
template<int dim>
void declare_parameters (ParameterHandler &prm)
 
template<int dim>
void write_plugin_graph (std::ostream &output_stream)
 

Function Documentation

§ register_particle_output()

template<int dim>
void aspect::Particle::Output::register_particle_output ( const std::string &  name,
const std::string &  description,
void(*)(ParameterHandler &)  declare_parameters_function,
Interface< dim > *(*)()  factory_function 
)

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

Parameters
nameA string that identifies the particle output
descriptionA text description of what this output does and that will be listed in the documentation of the parameter file.
declare_parameters_functionA pointer to a function that can be used to declare the parameters that this particle output wants to read from input files.
factory_functionA pointer to a function that can create an object of this particle output.

Referenced by aspect::Particle::Output::Interface< dim >::serialize().

§ create_particle_output()

template<int dim>
Interface<dim>* aspect::Particle::Output::create_particle_output ( 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.

Referenced by aspect::Particle::Output::Interface< dim >::serialize().

§ declare_parameters()

template<int dim>
void aspect::Particle::Output::declare_parameters ( ParameterHandler prm)

Declare the runtime parameters of the registered particle outputs.

§ write_plugin_graph()

template<int dim>
void aspect::Particle::Output::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_streamThe stream to write the output to.

Referenced by aspect::Particle::Output::Interface< dim >::serialize().