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)

Protected Attributes
unsigned int	step

Private Attributes
std::ostream *	os

Related Functions
(Note that these are not member functions.)
template<typename VectorType >
OutputOperator< VectorType > &	operator<< (OutputOperator< VectorType > &out, unsigned int step)

Subscriptor functionality
Classes derived from Subscriptor provide a facility to subscribe to this object. This is mostly used by the SmartPointer class.
std::atomic< unsigned int >	counter
std::map< std::string, unsigned int >	counter_map
std::vector< std::atomic< bool > * >	validity_pointers
const std::type_info *	object_info
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)
using	map_value_type = decltype(counter_map)::value_type
using	map_iterator = decltype(counter_map)::iterator
static std::mutex	mutex
static ::ExceptionBase &	ExcInUse (int arg1, std::string arg2, std::string arg3)
static ::ExceptionBase &	ExcNoSubscriber (std::string arg1, std::string arg2)
void	check_no_subscribers () const noexcept

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.

Definition at line 105 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 > &  )

delete

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

~OutputOperator()

template<typename VectorType >

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

overridevirtualdefault

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 )

inline

Set the current step.

Definition at line 152 of file operator.h.

operator<<()

template<typename VectorType >

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

virtual

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  )

related

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

Definition at line 152 of file operator.h.

Member Data Documentation

step

template<typename VectorType >

unsigned int Algorithms::OutputOperator< VectorType >::step

protected

Definition at line 144 of file operator.h.

os

template<typename VectorType >

std::ostream* Algorithms::OutputOperator< VectorType >::os

private

Definition at line 147 of file operator.h.

---

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

• include/deal.II/algorithms/operator.h