Public Member Functions | List of all members
aspect::Postprocess::VisualizationPostprocessors::CellDataVectorCreator< dim > Class Template Referenceabstract
Inheritance diagram for aspect::Postprocess::VisualizationPostprocessors::CellDataVectorCreator< dim >:
Inheritance graph

Public Member Functions

 CellDataVectorCreator (const std::string &physical_units="")
 ~CellDataVectorCreator () override=default
virtual std::pair< std::string, Vector< float > * > execute () const =0
- Public Member Functions inherited from aspect::Postprocess::VisualizationPostprocessors::Interface< dim >
 Interface (const std::string &physical_units="")
virtual ~Interface ()=default
virtual void initialize ()
virtual void update ()
virtual std::string get_physical_units () const
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)

Additional Inherited Members

- Static Public Member Functions inherited from aspect::Postprocess::VisualizationPostprocessors::Interface< dim >
static void declare_parameters (ParameterHandler &prm)

Detailed Description

template<int dim>
class aspect::Postprocess::VisualizationPostprocessors::CellDataVectorCreator< dim >

As explained in the documentation of the Interface class, the second kind of visualization plugin is one that wants to generate cell-wise data. Classes derived from this class need to implement a function execute() that computes these cell-wise values and return a pair of values where the first one indicates the name of a variable and the second one is a vector with one entry per cell. This class is the interface that such plugins have to implement.

Definition at line 284 of file visualization.h.

Constructor & Destructor Documentation

§ CellDataVectorCreator()

template<int dim>
aspect::Postprocess::VisualizationPostprocessors::CellDataVectorCreator< dim >::CellDataVectorCreator ( const std::string &  physical_units = "")

Constructor. The constructor takes as argument the physical units of the quantity (scalar or vector-valued) computed by derived classes.

§ ~CellDataVectorCreator()


Member Function Documentation

§ execute()

template<int dim>
virtual std::pair<std::string, Vector<float> *> aspect::Postprocess::VisualizationPostprocessors::CellDataVectorCreator< dim >::execute ( ) const
pure virtual

The function classes have to implement that want to output cell-wise data.

A pair of values with the following meaning:
  • The first element provides the name by which this data should be written to the output file.
  • The second element is a pointer to a vector with one element per active cell on the current processor. Elements corresponding to active cells that are either artificial or ghost cells (in deal.II language, see the deal.II glossary) will be ignored but must nevertheless exist in the returned vector. While implementations of this function must create this vector, ownership is taken over by the caller of this function and the caller will take care of destroying the vector pointed to.

Implemented in aspect::Postprocess::VisualizationPostprocessors::SeismicVpAnomaly< dim >, aspect::Postprocess::VisualizationPostprocessors::GrainLagAngle< dim >, aspect::Postprocess::VisualizationPostprocessors::ISARotationTimescale< dim >, aspect::Postprocess::VisualizationPostprocessors::BoundaryIndicator< dim >, aspect::Postprocess::VisualizationPostprocessors::ParticleCount< dim >, aspect::Postprocess::VisualizationPostprocessors::SeismicVsAnomaly< dim >, aspect::Postprocess::VisualizationPostprocessors::ArtificialViscosity< dim >, aspect::Postprocess::VisualizationPostprocessors::ArtificialViscosityComposition< dim >, and aspect::Postprocess::VisualizationPostprocessors::ErrorIndicator< dim >.

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