Reference documentation for deal.II version Git 395ab8d 2014-10-31 13:01:43 -0600
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Member Functions | Private Attributes | List of all members
DataPostprocessorScalar< dim > Class Template Reference

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

Inheritance diagram for DataPostprocessorScalar< dim >:
[legend]

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 ()
 
virtual void compute_derived_quantities_scalar (const std::vector< double > &uh, const std::vector< Tensor< 1, dim > > &duh, const std::vector< Tensor< 2, dim > > &dduh, const std::vector< Point< dim > > &normals, std::vector< Vector< double > > &computed_quantities) const DEAL_II_DEPRECATED
 
virtual void compute_derived_quantities_scalar (const std::vector< double > &uh, const std::vector< Tensor< 1, dim > > &duh, const std::vector< Tensor< 2, dim > > &dduh, const std::vector< Point< dim > > &normals, const std::vector< Point< dim > > &evaluation_points, std::vector< Vector< double > > &computed_quantities) const
 
virtual void compute_derived_quantities_vector (const std::vector< Vector< double > > &uh, const std::vector< std::vector< Tensor< 1, dim > > > &duh, const std::vector< std::vector< Tensor< 2, dim > > > &dduh, const std::vector< Point< dim > > &normals, std::vector< Vector< double > > &computed_quantities) const DEAL_II_DEPRECATED
 
virtual void compute_derived_quantities_vector (const std::vector< Vector< double > > &uh, const std::vector< std::vector< Tensor< 1, dim > > > &duh, const std::vector< std::vector< Tensor< 2, dim > > > &dduh, const std::vector< Point< dim > > &normals, const std::vector< Point< dim > > &evaluation_points, std::vector< Vector< double > > &computed_quantities) const
 
- Public Member Functions inherited from Subscriptor
 Subscriptor ()
 
 Subscriptor (const Subscriptor &)
 
virtual ~Subscriptor ()
 
Subscriptoroperator= (const Subscriptor &)
 
void subscribe (const char *identifier=0) const
 
void unsubscribe (const char *identifier=0) const
 
unsigned int n_subscriptions () const
 
void list_subscribers () const
 
 DeclException3 (ExcInUse, int, char *, std::string &,<< "Object of class "<< arg2<< " is still used by "<< arg1<< " other objects.\n"<< "(Additional information: "<< arg3<< ")\n"<< "Note the entry in the Frequently Asked Questions of "<< "deal.II (linked to from http://www.dealii.org/) for "<< "more information on what this error means.")
 
 DeclException2 (ExcNoSubscriber, char *, char *,<< "No subscriber with identifier \""<< arg2<< "\" did subscribe to this object of class "<< arg1)
 
template<class Archive >
void serialize (Archive &ar, const unsigned int version)
 

Private Attributes

const std::string name
 
const UpdateFlags update_flags
 

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::compute_derived_quantities_scalar() or DataPostprocessor::compute_derived_quantities_vector().

An example of how this class can be used can be found in step-29.

Author
Wolfgang Bangerth, 2011

Definition at line 297 of file data_postprocessor.h.

Constructor & Destructor Documentation

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
nameThe name by which the scalar variable computed by this class should be made available in graphical output files.
update_flagsThis 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.

Member Function Documentation

template<int dim>
virtual 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 >.

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

This functions 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 >.

template<int dim>
virtual 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 >.

Member Data Documentation

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 359 of file data_postprocessor.h.


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