aspect::Postprocess::Interface< dim > Class Template Reference

Inheritance diagram for aspect::Postprocess::Interface< dim >:

Public Member Functions
virtual	~Interface ()=default
virtual void	initialize ()
virtual void	update ()
virtual std::pair< std::string, std::string >	execute (TableHandler &statistics)=0
virtual void	parse_parameters (ParameterHandler &prm)
virtual std::list< std::string >	required_other_postprocessors () const
virtual void	save (std::map< std::string, std::string > &status_strings) const
virtual void	load (const std::map< std::string, std::string > &status_strings)

Static Public Member Functions
static void	declare_parameters (ParameterHandler &prm)

Detailed Description

template<int dim>
class aspect::Postprocess::Interface< dim >

This class declares the public interface of postprocessors. Postprocessors must implement a function that can be called at the end of each time step to evaluate the current solution, as well as functions that save the state of the object and restore it (for checkpoint/restart capabilities).

Access to the data of the simulator is granted by the protected member functions of the SimulatorAccess class, i.e., classes implementing this interface will in general want to derive from both this Interface class as well as from the SimulatorAccess class.

Definition at line 71 of file interface.h.

Constructor & Destructor Documentation

~Interface()

template<int dim>

virtual aspect::Postprocess::Interface< dim >::~Interface ( )

virtualdefault

Destructor. Does nothing but is virtual so that derived classes destructors are also virtual.

Member Function Documentation

initialize()

template<int dim>

virtual void aspect::Postprocess::Interface< dim >::initialize ( )

virtual

Initialize function.

Reimplemented in aspect::Postprocess::Geoid< dim >, aspect::Postprocess::GravityPointValues< dim >, aspect::Postprocess::CrystalPreferredOrientation< dim >, aspect::Postprocess::GlobalStatistics< dim >, aspect::Postprocess::StokesResidual< dim >, aspect::Postprocess::BoundaryVelocityResidualStatistics< dim >, aspect::Postprocess::SeaLevel< dim >, and aspect::Postprocess::BoundaryStrainRateResidualStatistics< dim >.

update()

template<int dim>

virtual void aspect::Postprocess::Interface< dim >::update ( )

virtual

Update function. This should be called before each postprocessor is run and allows an opportunity to prepare/update temporary data

Reimplemented in aspect::Postprocess::Visualization< dim >.

execute()

template<int dim>

virtual std::pair<std::string,std::string> aspect::Postprocess::Interface< dim >::execute ( TableHandler &  statistics )

pure virtual

Execute this postprocessor. Derived classes will implement this function to do whatever they want to do to evaluate the solution at the current time step.

Parameters

[in,out]

statistics

An object that contains statistics that are collected throughout the simulation and that will be written to an output file at the end of each time step. Postprocessors may deposit data in these tables for later visualization or further processing.

Returns

A pair of strings that will be printed to the screen after running the postprocessor in two columns; typically the first column contains a description of what the data is and the second contains a numerical value of this data. If there is nothing to print, simply return two empty strings.

Implemented in aspect::Postprocess::Visualization< dim >, aspect::Postprocess::Particles< dim >, aspect::Postprocess::HeatFluxMap< dim >, aspect::Postprocess::GravityPointValues< dim >, aspect::Postprocess::CrystalPreferredOrientation< dim >, aspect::Postprocess::BoundaryVelocityResidualStatistics< dim >, aspect::Postprocess::BoundaryStrainRateResidualStatistics< dim >, aspect::Postprocess::GlobalStatistics< dim >, aspect::Postprocess::CoreStatistics< dim >, aspect::Postprocess::Command< dim >, aspect::Postprocess::LoadBalanceStatistics< dim >, aspect::Postprocess::StokesResidual< dim >, aspect::Postprocess::SeaLevel< dim >, aspect::Postprocess::BasicStatistics< dim >, aspect::Postprocess::PointValues< dim >, aspect::Postprocess::DepthAverage< dim >, aspect::Postprocess::MeltStatistics< dim >, aspect::Postprocess::HeatingStatistics< dim >, aspect::Postprocess::BoundaryDensities< dim >, aspect::Postprocess::BoundaryPressures< dim >, aspect::Postprocess::VelocityBoundaryStatistics< dim >, aspect::Postprocess::DomainVolume< dim >, aspect::Postprocess::HeatFluxDensities< dim >, aspect::Postprocess::MassFluxStatistics< dim >, aspect::Postprocess::MaterialStatistics< dim >, aspect::Postprocess::SphericalVelocityStatistics< dim >, aspect::Postprocess::ViscousDissipationStatistics< dim >, aspect::Postprocess::CompositionStatistics< dim >, aspect::Postprocess::CompositionVelocityStatistics< dim >, aspect::Postprocess::DynamicTopography< dim >, aspect::Postprocess::HeatFluxStatistics< dim >, aspect::Postprocess::ParticleCountStatistics< dim >, aspect::Postprocess::RotationStatistics< dim >, aspect::Postprocess::VolumeOfFluidStatistics< dim >, aspect::Postprocess::EntropyViscosityStatistics< dim >, aspect::Postprocess::Geoid< dim >, aspect::Postprocess::MatrixStatistics< dim >, aspect::Postprocess::MaxDepthField< dim >, aspect::Postprocess::MemoryStatistics< dim >, aspect::Postprocess::MobilityStatistics< dim >, aspect::Postprocess::PressureStatistics< dim >, aspect::Postprocess::TemperatureStatistics< dim >, aspect::Postprocess::Topography< dim >, and aspect::Postprocess::VelocityStatistics< dim >.

declare_parameters()

template<int dim>

static void aspect::Postprocess::Interface< dim >::declare_parameters ( ParameterHandler &  prm )

static

Declare the parameters this class takes through input files. Derived classes should overload this function if they actually do take parameters; this class declares a fall-back function that does nothing, so that postprocessor classes that do not take any parameters do not have to do anything at all.

This function is static (and needs to be static in derived classes) so that it can be called without creating actual objects (because declaring parameters happens before we read the input file and thus at a time when we don't even know yet which postprocessor objects we need).

parse_parameters()

template<int dim>

virtual void aspect::Postprocess::Interface< dim >::parse_parameters ( ParameterHandler &  prm )

virtual

Read the parameters this class declares from the parameter file. The default implementation in this class does nothing, so that derived classes that do not need any parameters do not need to implement it.

Reimplemented in aspect::Postprocess::Visualization< dim >, aspect::Postprocess::Particles< dim >, aspect::Postprocess::CrystalPreferredOrientation< dim >, aspect::Postprocess::SeaLevel< dim >, aspect::Postprocess::GravityPointValues< dim >, aspect::Postprocess::DynamicTopography< dim >, aspect::Postprocess::BoundaryVelocityResidualStatistics< dim >, aspect::Postprocess::BoundaryStrainRateResidualStatistics< dim >, aspect::Postprocess::GlobalStatistics< dim >, aspect::Postprocess::PointValues< dim >, aspect::Postprocess::DepthAverage< dim >, aspect::Postprocess::Geoid< dim >, aspect::Postprocess::CompositionVelocityStatistics< dim >, aspect::Postprocess::Topography< dim >, aspect::Postprocess::RotationStatistics< dim >, aspect::Postprocess::MemoryStatistics< dim >, aspect::Postprocess::CoreStatistics< dim >, and aspect::Postprocess::Command< dim >.

required_other_postprocessors()

template<int dim>

virtual std::list<std::string> aspect::Postprocess::Interface< dim >::required_other_postprocessors ( ) const

virtual

A function that is used to indicate to the postprocessor manager which other postprocessor(s) the current one depends upon. The returned list contains the names (as strings, as you would write them in the input file) of the postprocessors it requires. The manager will ensure that these postprocessors are indeed used, even if they were not explicitly listed in the input file, and are indeed run before this postprocessor every time they are executed.

The default implementation of this function returns an empty list.

Note

This mechanism is intended to support postprocessors that do not want to recompute information that other postprocessors already compute (or could compute, if they were run – which we can ensure using the current function). To do so, a postprocessor of course needs to be able to access these other postprocessors. This can be done by deriving your postprocessor from SimulatorAccess, and then using the SimulatorAccess::get_postprocess_manager::get_matching_postprocessor function.

Reimplemented in aspect::Postprocess::Visualization< dim >, aspect::Postprocess::CrystalPreferredOrientation< dim >, aspect::Postprocess::SeaLevel< dim >, aspect::Postprocess::DynamicTopography< dim >, aspect::Postprocess::ParticleCountStatistics< dim >, and aspect::Postprocess::Geoid< dim >.

save()

template<int dim>

virtual void aspect::Postprocess::Interface< dim >::save ( std::map< std::string, std::string > &  status_strings ) const

virtual

Save the state of this object to the argument given to this function. This function is in support of checkpoint/restart functionality.

Derived classes can implement this function and should store their state in a string that is deposited under a key in the map through which the respective class can later find the status again when the program is restarted. A legitimate key to store data under is typeid(*this).name(). It is up to derived classes to decide how they want to encode their state.

The default implementation of this function does nothing, i.e., it represents a stateless object for which nothing needs to be stored at checkpoint time and nothing needs to be restored at restart time.

Parameters

[in,out]

status_strings

The object into which implementations in derived classes can place their status under a key that they can use to retrieve the data.

Reimplemented in aspect::Postprocess::Visualization< dim >, aspect::Postprocess::Particles< dim >, aspect::Postprocess::GravityPointValues< dim >, aspect::Postprocess::SeaLevel< dim >, aspect::Postprocess::CoreStatistics< dim >, aspect::Postprocess::PointValues< dim >, aspect::Postprocess::DepthAverage< dim >, and aspect::Postprocess::StokesResidual< dim >.

load()

template<int dim>

virtual void aspect::Postprocess::Interface< dim >::load ( const std::map< std::string, std::string > &  status_strings )

virtual

Restore the state of the object by looking up a description of the state in the passed argument under the same key under which it was previously stored.

The default implementation does nothing.

Parameters

[in]

status_strings

The object from which the status will be restored by looking up the value for a key specific to this derived class.

Reimplemented in aspect::Postprocess::Visualization< dim >, aspect::Postprocess::Particles< dim >, aspect::Postprocess::GravityPointValues< dim >, aspect::Postprocess::SeaLevel< dim >, aspect::Postprocess::CoreStatistics< dim >, aspect::Postprocess::PointValues< dim >, aspect::Postprocess::DepthAverage< dim >, and aspect::Postprocess::StokesResidual< dim >.

---

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

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