Reference documentation for deal.II version Git a2518c4284 2020-04-02 19:23:00 +0200
\(\newcommand{\vcentcolon}{\mathrel{\mathop{:}}}\) \(\newcommand{\dealcoloneq}{\vcentcolon\mathrel{\mkern-1.2mu}=}\) \(\newcommand{\jump}[1]{\left[\!\left[ #1 \right]\!\right]}\) \(\newcommand{\average}[1]{\left\{\!\left\{ #1 \right\}\!\right\}}\)
Public Member Functions | Related Functions | List of all members
Algorithms::OutputOperator< VectorType > Class Template Reference

#include <deal.II/algorithms/operator.h>

Inheritance diagram for Algorithms::OutputOperator< VectorType >:

Public Member Functions

 OutputOperator ()
 OutputOperator (const OutputOperator< VectorType > &)=delete
virtual ~OutputOperator () override=default
void initialize_stream (std::ostream &stream)
void set_step (const unsigned int step)
virtual OutputOperator< VectorType > & operator<< (const AnyData &vectors)
- Public Member Functions inherited from Subscriptor
 Subscriptor ()
 Subscriptor (const Subscriptor &)
 Subscriptor (Subscriptor &&) noexcept
virtual ~Subscriptor ()
Subscriptoroperator= (const Subscriptor &)
Subscriptoroperator= (Subscriptor &&) noexcept
void subscribe (std::atomic< bool > *const validity, const std::string &identifier="") const
void unsubscribe (std::atomic< bool > *const validity, const std::string &identifier="") const
unsigned int n_subscriptions () const
template<typename StreamType >
void list_subscribers (StreamType &stream) const
void list_subscribers () const
template<class Archive >
void serialize (Archive &ar, const unsigned int version)

Related Functions

(Note that these are not member functions.)

template<typename VectorType >
OutputOperator< VectorType > & operator<< (OutputOperator< VectorType > &out, unsigned int step)

Additional Inherited Members

- Static Public Member Functions inherited from Subscriptor
static ::ExceptionBaseExcInUse (int arg1, std::string arg2, std::string arg3)
static ::ExceptionBaseExcNoSubscriber (std::string arg1, std::string arg2)

Detailed Description

template<typename VectorType>
class Algorithms::OutputOperator< VectorType >

An unary operator base class, intended to output the vectors in AnyData in each step of an iteration.

Guido Kanschat, 2010

Definition at line 112 of file operator.h.

Constructor & Destructor Documentation

◆ OutputOperator() [1/2]

template<typename VectorType>
Algorithms::OutputOperator< VectorType >::OutputOperator ( )

Constructor initializing member variables with invalid data.

◆ OutputOperator() [2/2]

template<typename VectorType>
Algorithms::OutputOperator< VectorType >::OutputOperator ( const OutputOperator< VectorType > &  )

The copy constructor is deleted since objects of this class should not be copied.

◆ ~OutputOperator()

template<typename VectorType>
virtual Algorithms::OutputOperator< VectorType >::~OutputOperator ( )

Empty virtual destructor.

Member Function Documentation

◆ initialize_stream()

template<typename VectorType>
void Algorithms::OutputOperator< VectorType >::initialize_stream ( std::ostream &  stream)

Set the stream os to which data is written. If no stream is selected with this function, data goes to deallog.

◆ set_step()

template<typename VectorType >
void Algorithms::OutputOperator< VectorType >::set_step ( const unsigned int  step)

Set the current step.

Definition at line 157 of file operator.h.

◆ operator<<()

template<typename VectorType>
virtual OutputOperator<VectorType>& Algorithms::OutputOperator< VectorType >::operator<< ( const AnyData vectors)

Output all the vectors in AnyData.

Reimplemented in Algorithms::DoFOutputOperator< VectorType, dim, spacedim >.

Friends And Related Function Documentation

◆ operator<<()

template<typename VectorType >
OutputOperator< VectorType > & operator<< ( OutputOperator< VectorType > &  out,
unsigned int  step 

Set the step number in OutputOperator by shifting an integer value.

Definition at line 170 of file operator.h.

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