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

Inheritance diagram for Algorithms::DoFOutputOperator< VectorType, dim, spacedim >:

[legend]

Public Member Functions
	DoFOutputOperator (const std::string &filename_base="output", const unsigned int digits=3)

void	parse_parameters (ParameterHandler &param)

void	initialize (const DoFHandler< dim, spacedim > &dof_handler)

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

void	initialize_stream (std::ostream &stream)

void	set_step (const unsigned int step)

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

Querying the observer pointers an object has.
unsigned int	n_subscriptions () const

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

void	list_subscribers () const

Static Public Member Functions
static ::ExceptionBase &	ExcInUse (int arg1, std::string arg2, std::string arg3)

static ::ExceptionBase &	ExcNoSubscriber (std::string arg1, std::string arg2)

Protected Attributes
unsigned int	step

Private Types
using	map_value_type = decltype(counter_map)::value_type

using	map_iterator = decltype(counter_map)::iterator

Private Member Functions
EnableObserverPointer functionality
Classes derived from EnableObserverPointer provide a facility to subscribe to this object. This is mostly used by the ObserverPointer 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

void	check_no_subscribers () const noexcept

Private Attributes
ObserverPointer< const DoFHandler< dim, spacedim >, DoFOutputOperator< VectorType, dim, spacedim > >	dof

const std::string	filename_base

const unsigned int	digits

DataOut< dim >	out

std::ostream *	os

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

Static Private Attributes
static std::mutex	mutex

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

Detailed Description

template<typename VectorType, int dim, int spacedim = dim>
class Algorithms::DoFOutputOperator< VectorType, dim, spacedim >

An output operator writing a separate file in each step and writing the vectors as finite element functions with respect to a given DoFHandler.

Definition at line 45 of file dof_output_operator.h.

Member Typedef Documentation

◆ map_value_type

using EnableObserverPointer::map_value_type = decltype(counter_map)::value_type

privateinherited

The data type used in counter_map.

Definition at line 223 of file enable_observer_pointer.h.

◆ map_iterator

using EnableObserverPointer::map_iterator = decltype(counter_map)::iterator

privateinherited

The iterator type used in counter_map.

Definition at line 228 of file enable_observer_pointer.h.

Constructor & Destructor Documentation

◆ DoFOutputOperator()

template<typename VectorType , int dim, int spacedim = dim>

Algorithms::DoFOutputOperator< VectorType, dim, spacedim >::DoFOutputOperator	(	const std::string &	filename_base = `"output"`,
		const unsigned int	digits = `3`
	)

Member Function Documentation

◆ parse_parameters()

template<typename VectorType , int dim, int spacedim = dim>

void Algorithms::DoFOutputOperator< VectorType, dim, spacedim >::parse_parameters ( ParameterHandler & param )

◆ initialize()

template<typename VectorType , int dim, int spacedim>

void Algorithms::DoFOutputOperator< VectorType, dim, spacedim >::initialize ( const DoFHandler< dim, spacedim > & dof_handler )

inline

Definition at line 80 of file dof_output_operator.h.

◆ operator<<()

template<typename VectorType , int dim, int spacedim = dim>

virtual OutputOperator< VectorType > & Algorithms::DoFOutputOperator< VectorType, dim, spacedim >::operator<< ( const AnyData & vectors )

overridevirtual

Output all the vectors in AnyData.

Reimplemented from Algorithms::OutputOperator< VectorType >.

◆ initialize_stream()

template<typename VectorType >

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

inherited

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 )

inlineinherited

Set the current step.

Definition at line 151 of file operator.h.

◆ n_subscriptions()

unsigned int EnableObserverPointer::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 339 of file enable_observer_pointer.h.

◆ list_subscribers() [1/2]

template<typename StreamType >

void EnableObserverPointer::list_subscribers ( StreamType & stream ) const

inlineinherited

List the subscribers to the input stream.

Definition at line 356 of file enable_observer_pointer.h.

◆ list_subscribers() [2/2]

void EnableObserverPointer::list_subscribers ( ) const

inherited

List the subscribers to deallog.

Definition at line 199 of file enable_observer_pointer.cc.

◆ serialize()

template<class Archive >

void EnableObserverPointer::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 348 of file enable_observer_pointer.h.

◆ subscribe()

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

privateinherited

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

Definition at line 131 of file enable_observer_pointer.cc.

◆ unsubscribe()

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

privateinherited

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 151 of file enable_observer_pointer.cc.

◆ check_no_subscribers()

void EnableObserverPointer::check_no_subscribers ( ) const

privatenoexceptinherited

Check that there are no objects subscribing to this object. If this check passes then it is safe to destroy the current object. It this check fails then this function will either abort or print an error message to deallog (by using the AssertNothrow mechanism), but will not throw an exception.

Note: Since this function is just a consistency check it does nothing in release mode.; If this function is called when there is an uncaught exception then, rather than aborting, this function prints an error message to the standard error stream and returns.

Definition at line 53 of file enable_observer_pointer.cc.

Friends And Related Symbol Documentation

◆ operator<<()

template<typename VectorType >

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

Definition at line 151 of file operator.h.

Member Data Documentation

◆ dof

template<typename VectorType , int dim, int spacedim = dim>

ObserverPointer<const DoFHandler<dim, spacedim>, DoFOutputOperator<VectorType, dim, spacedim> > Algorithms::DoFOutputOperator< VectorType, dim, spacedim >::dof

private

Definition at line 70 of file dof_output_operator.h.

◆ filename_base

template<typename VectorType , int dim, int spacedim = dim>

const std::string Algorithms::DoFOutputOperator< VectorType, dim, spacedim >::filename_base

private

Definition at line 72 of file dof_output_operator.h.

◆ digits

template<typename VectorType , int dim, int spacedim = dim>

const unsigned int Algorithms::DoFOutputOperator< VectorType, dim, spacedim >::digits

private

Definition at line 73 of file dof_output_operator.h.

◆ out

template<typename VectorType , int dim, int spacedim = dim>

DataOut<dim> Algorithms::DoFOutputOperator< VectorType, dim, spacedim >::out

private

Definition at line 75 of file dof_output_operator.h.

◆ step

template<typename VectorType >

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

protectedinherited

Definition at line 143 of file operator.h.

◆ os

template<typename VectorType >

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

privateinherited

Definition at line 146 of file operator.h.

◆ counter

std::atomic<unsigned int> EnableObserverPointer::counter

mutableprivateinherited

Store the number of objects which subscribed to this object. Initially, this number is zero, and upon destruction it shall be zero again (i.e. all objects which subscribed should have unsubscribed again).

The creator (and owner) of an object is counted in the map below if HE manages to supply identification.

We use the mutable keyword in order to allow subscription to constant objects also.

This counter may be read from and written to concurrently in multithreaded code: hence we use the std::atomic class template.

Definition at line 212 of file enable_observer_pointer.h.

◆ counter_map

std::map<std::string, unsigned int> EnableObserverPointer::counter_map

mutableprivateinherited

In this map, we count subscriptions for each different identification string supplied to subscribe().

Definition at line 218 of file enable_observer_pointer.h.

◆ validity_pointers

std::vector<std::atomic<bool> *> EnableObserverPointer::validity_pointers

mutableprivateinherited

In this vector, we store pointers to the validity bool in the ObserverPointer objects that subscribe to this class.

Definition at line 234 of file enable_observer_pointer.h.

◆ object_info

const std::type_info* EnableObserverPointer::object_info

mutableprivateinherited

Pointer to the typeinfo object of this object, from which we can later deduce the class name. Since this information on the derived class is neither available in the destructor, nor in the constructor, we obtain it in between and store it here.

Definition at line 242 of file enable_observer_pointer.h.

◆ mutex

std::mutex EnableObserverPointer::mutex

staticprivateinherited

A mutex used to ensure data consistency when accessing the mutable members of this class. This lock is used in the subscribe() and unsubscribe() functions, as well as in list_subscribers().

Definition at line 249 of file enable_observer_pointer.h.

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

include/deal.II/numerics/dof_output_operator.h

Public Member Functions

Static Public Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Static Private Attributes

Related Symbols

Detailed Description

Member Typedef Documentation

◆ map_value_type

◆ map_iterator

Constructor & Destructor Documentation

◆ DoFOutputOperator()

Member Function Documentation

◆ parse_parameters()

◆ initialize()

◆ operator<<()

◆ initialize_stream()

◆ set_step()

◆ n_subscriptions()

◆ list_subscribers() [1/2]

◆ list_subscribers() [2/2]

◆ serialize()

◆ subscribe()

◆ unsubscribe()

◆ check_no_subscribers()

Friends And Related Symbol Documentation

◆ operator<<()

Member Data Documentation

◆ dof

◆ filename_base

◆ digits

◆ out

◆ step

◆ os

◆ counter

◆ counter_map

◆ validity_pointers

◆ object_info

◆ mutex