ASPECT
Public Member Functions | Static Public Member Functions | List of all members
aspect::Particle::Output::Interface< dim > Class Template Referenceabstract
Inheritance diagram for aspect::Particle::Output::Interface< dim >:
Inheritance graph
[legend]

Public Member Functions

virtual ~Interface ()
 
virtual void initialize ()
 
virtual std::string output_particle_data (const ParticleHandler< dim > &particle_handler, const Property::ParticlePropertyInformation &property_information, const double current_time)=0
 
template<class Archive >
void serialize (Archive &ar, const unsigned int version)
 
virtual void save (std::ostringstream &os) const
 
virtual void load (std::istringstream &is)
 
virtual void parse_parameters (ParameterHandler &)
 

Static Public Member Functions

static void declare_parameters (ParameterHandler &)
 

Detailed Description

template<int dim>
class aspect::Particle::Output::Interface< dim >

Abstract base class used for classes that generate particle output.

Definition at line 45 of file interface.h.

Constructor & Destructor Documentation

§ ~Interface()

template<int dim>
virtual aspect::Particle::Output::Interface< dim >::~Interface ( )
virtual

Destructor. Made virtual so that derived classes can be created and destroyed through pointers to the base class.

Member Function Documentation

§ initialize()

template<int dim>
virtual void aspect::Particle::Output::Interface< dim >::initialize ( )
virtual

Initialization function. This function is called once at the beginning of the program after parse_parameters is run and after the SimulatorAccess (if applicable) is initialized.

Reimplemented in aspect::Particle::Output::HDF5Output< dim >, aspect::Particle::Output::ASCIIOutput< dim >, and aspect::Particle::Output::VTUOutput< dim >.

§ output_particle_data()

template<int dim>
virtual std::string aspect::Particle::Output::Interface< dim >::output_particle_data ( const ParticleHandler< dim > &  particle_handler,
const Property::ParticlePropertyInformation property_information,
const double  current_time 
)
pure virtual

Write data about the particles specified in the first argument to a file. If possible, encode the current simulation time into this file using the data provided in the last argument.

Parameters
[in]particle_handlerThe particle handler that allows access to the collection of particles.
[in]property_informationInformation object containing names and number of components of each property.
[in]current_timeCurrent time of the simulation, given as either years or seconds, as selected in the input file. In other words, output writers do not need to know the units in which time is described.
Returns
The name of the file that was written, or any other information that describes what output was produced if for example multiple files were created.

Implemented in aspect::Particle::Output::HDF5Output< dim >, aspect::Particle::Output::ASCIIOutput< dim >, and aspect::Particle::Output::VTUOutput< dim >.

§ serialize()

template<int dim>
template<class Archive >
void aspect::Particle::Output::Interface< dim >::serialize ( Archive &  ar,
const unsigned int  version 
)

§ save()

template<int dim>
virtual void aspect::Particle::Output::Interface< dim >::save ( std::ostringstream &  os) const
virtual

Save the state of the object. The default implementation assumes there is no state to save and does nothing.

Reimplemented in aspect::Particle::Output::HDF5Output< dim >, aspect::Particle::Output::ASCIIOutput< dim >, and aspect::Particle::Output::VTUOutput< dim >.

§ load()

template<int dim>
virtual void aspect::Particle::Output::Interface< dim >::load ( std::istringstream &  is)
virtual

Restore the state of the object. The default implementation assumes there is no state to restore and does nothing.

Reimplemented in aspect::Particle::Output::HDF5Output< dim >, aspect::Particle::Output::ASCIIOutput< dim >, and aspect::Particle::Output::VTUOutput< dim >.

§ declare_parameters()

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

Declare the parameters this class takes through input files. The default implementation of this function does not describe any parameters. Consequently, derived classes do not have to overload this function if they do not take any runtime parameters.

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

§ parse_parameters()

template<int dim>
virtual void aspect::Particle::Output::Interface< dim >::parse_parameters ( ParameterHandler )
virtual

Read the parameters this class declares from the parameter file. The default implementation of this function does not read any parameters. Consequently, derived classes do not have to overload this function if they do not take any runtime parameters.


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