DataPostprocessorScalar< dim > Class Template Reference

#include <deal.II/numerics/data_postprocessor.h>

Inheritance diagram for DataPostprocessorScalar< dim >:

Public Member Functions
	DataPostprocessorScalar (const std::string &name, const UpdateFlags update_flags)
virtual std::vector< std::string >	get_names () const
virtual std::vector< DataComponentInterpretation::DataComponentInterpretation >	get_data_component_interpretation () const
virtual UpdateFlags	get_needed_update_flags () const
Public Member Functions inherited from DataPostprocessor< dim >
virtual	~DataPostprocessor ()=default
virtual void	evaluate_scalar_field (const DataPostprocessorInputs::Scalar< dim > &input_data, std::vector< Vector< double > > &computed_quantities) const
virtual void	evaluate_vector_field (const DataPostprocessorInputs::Vector< dim > &input_data, std::vector< Vector< double > > &computed_quantities) const
Public Member Functions inherited from Subscriptor
	Subscriptor ()
	Subscriptor (const Subscriptor &)
	Subscriptor (Subscriptor &&) noexcept
virtual	~Subscriptor ()
Subscriptor &	operator= (const Subscriptor &)
Subscriptor &	operator= (Subscriptor &&) noexcept
void	subscribe (const char *identifier=nullptr) const
void	unsubscribe (const char *identifier=nullptr) const
unsigned int	n_subscriptions () const
void	list_subscribers () const
template<class Archive >
void	serialize (Archive &ar, const unsigned int version)

Private Attributes
const std::string	name

Additional Inherited Members
Static Public Member Functions inherited from Subscriptor
static ::ExceptionBase &	ExcInUse (int arg1, std::string arg2, std::string arg3)
static ::ExceptionBase &	ExcNoSubscriber (std::string arg1, std::string arg2)

Detailed Description

template<int dim>
class DataPostprocessorScalar< dim >

This class provides a simpler interface to the functionality offered by the DataPostprocessor class in case one wants to compute only a single scalar quantity from the finite element field passed to the DataOut class. For this particular case, it is clear what the returned value of DataPostprocessor::get_data_component_interpretation() should be and we pass the values returned by get_names() and get_needed_update_flags() to the constructor so that derived classes do not have to implement these functions by hand.

All derived classes have to do is implement a constructor and overload either DataPostprocessor::evaluate_scalar_field() or DataPostprocessor::evaluate_vector_field().

An example of how this class can be used can be found in step-29. An example of how the closely related DataPostprocessorVector class can be used is found in the documentation of that class. The same is true for the DataPostprocessorTensor class.

Author

Wolfgang Bangerth, 2011

Definition at line 535 of file data_postprocessor.h.

Constructor & Destructor Documentation

DataPostprocessorScalar()

template<int dim>

DataPostprocessorScalar< dim >::DataPostprocessorScalar	(	const std::string &	name,
		const UpdateFlags	update_flags
	)

Constructor. Take the name of the single scalar variable computed by classes derived from the current one, as well as the update flags necessary to compute this quantity.

Parameters

name	The name by which the scalar variable computed by this class should be made available in graphical output files.
update_flags	This has to be a combination of update_values, update_gradients and update_hessians. If the DataPostprocessor is to be used in combination with DataOutFaces, you may also ask for a update of normals via the update_normal_vectors flag.

Definition at line 63 of file data_postprocessor.cc.

Member Function Documentation

get_names()

template<int dim>

std::vector< std::string > DataPostprocessorScalar< dim >::get_names ( ) const

virtual

Return the vector of strings describing the names of the computed quantities. Given the purpose of this class, this is a vector with a single entry equal to the name given to the constructor.

Implements DataPostprocessor< dim >.

Definition at line 75 of file data_postprocessor.cc.

get_data_component_interpretation()

template<int dim>

std::vector< DataComponentInterpretation::DataComponentInterpretation > DataPostprocessorScalar< dim >::get_data_component_interpretation ( ) const

virtual

This function returns information about how the individual components of output files that consist of more than one data set are to be interpreted. Since the current class is meant to be used for a single scalar result variable, the returned value is obviously DataComponentInterpretation::component_is_scalar.

Reimplemented from DataPostprocessor< dim >.

Definition at line 85 of file data_postprocessor.cc.

get_needed_update_flags()

template<int dim>

UpdateFlags DataPostprocessorScalar< dim >::get_needed_update_flags ( ) const

virtual

Return, which data has to be provided to compute the derived quantities. The flags returned here are the ones passed to the constructor of this class.

Implements DataPostprocessor< dim >.

Definition at line 96 of file data_postprocessor.cc.

Member Data Documentation

name

template<int dim>

const std::string DataPostprocessorScalar< dim >::name

private

Copies of the two arguments given to the constructor of this class.

Definition at line 582 of file data_postprocessor.h.

---

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

• deal.II/numerics/data_postprocessor.h
• source/numerics/data_postprocessor.cc