Reference documentation for deal.II version Git f102a78320 2021-10-16 14:49:02 -0400
\(\newcommand{\dealvcentcolon}{\mathrel{\mathop{:}}}\) \(\newcommand{\dealcoloneq}{\dealvcentcolon\mathrel{\mkern-1.2mu}=}\) \(\newcommand{\jump}[1]{\left[\!\left[ #1 \right]\!\right]}\) \(\newcommand{\average}[1]{\left\{\!\left\{ #1 \right\}\!\right\}}\)
Public Member Functions | Static Public Member Functions | Protected Attributes | Private Attributes | Related Functions | List of all members
Algorithms::OutputOperator< VectorType > Class Template Reference

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

Inheritance diagram for Algorithms::OutputOperator< VectorType >:
[legend]

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)
 
template<class Archive >
void serialize (Archive &ar, const unsigned int version)
 
Subscriptor functionality

Classes derived from Subscriptor provide a facility to subscribe to this object. This is mostly used by the SmartPointer class.

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
 

Static Public Member Functions

static ::ExceptionBaseExcInUse (int arg1, std::string arg2, std::string arg3)
 
static ::ExceptionBaseExcNoSubscriber (std::string arg1, std::string arg2)
 

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)
 

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

◆ subscribe()

void Subscriptor::subscribe ( std::atomic< bool > *const  validity,
const std::string &  identifier = "" 
) const
inherited

Subscribes a user of the object by storing the pointer validity. The subscriber may be identified by text supplied as identifier.

Definition at line 136 of file subscriptor.cc.

◆ unsubscribe()

void Subscriptor::unsubscribe ( std::atomic< bool > *const  validity,
const std::string &  identifier = "" 
) const
inherited

Unsubscribes a user from the object.

Note
The identifier and the validity pointer must be the same as the one supplied to subscribe().

Definition at line 156 of file subscriptor.cc.

◆ n_subscriptions()

unsigned int Subscriptor::n_subscriptions ( ) const
inlineinherited

Return the present number of subscriptions to this object. This allows to use this class for reference counted lifetime determination where the last one to unsubscribe also deletes the object.

Definition at line 301 of file subscriptor.h.

◆ list_subscribers() [1/2]

template<typename StreamType >
void Subscriptor::list_subscribers ( StreamType &  stream) const
inlineinherited

List the subscribers to the input stream.

Definition at line 318 of file subscriptor.h.

◆ list_subscribers() [2/2]

void Subscriptor::list_subscribers ( ) const
inherited

List the subscribers to deallog.

Definition at line 204 of file subscriptor.cc.

◆ serialize()

template<class Archive >
void Subscriptor::serialize ( Archive &  ar,
const unsigned int  version 
)
inlineinherited

Read or write the data of this object to or from a stream for the purpose of serialization using the BOOST serialization library.

This function does not actually serialize any of the member variables of this class. The reason is that what this class stores is only who subscribes to this object, but who does so at the time of storing the contents of this object does not necessarily have anything to do with who subscribes to the object when it is restored. Consequently, we do not want to overwrite the subscribers at the time of restoring, and then there is no reason to write the subscribers out in the first place.

Definition at line 310 of file subscriptor.h.

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 165 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: