ConditionalOStreams Class Reference

A class that allows printing to different output streams that are classified based on their verbosity. For now, this consists of two stream the release and debug. The debug stream provides more information that may be useful when debugging. More...

#include <conditional_ostreams.h>

Public Member Functions
	ConditionalOStreams ()=default
	Constructor.
	~ConditionalOStreams ()=default
	Destructor.
	ConditionalOStreams (const ConditionalOStreams &solver_base)=delete
	Copy constructor.
ConditionalOStreams &	operator= (const ConditionalOStreams &solver_base)=delete
	Copy assignment.
	ConditionalOStreams (ConditionalOStreams &&solver_base) noexcept=delete
	Move constructor.
ConditionalOStreams &	operator= (ConditionalOStreams &&solver_base) noexcept=delete
	Move assignment.

Static Public Member Functions
static dealii::ConditionalOStream &	pout_base ()
	Generic parallel output stream. Used for essential information in release and debug mode.
static dealii::ConditionalOStream &	pout_verbose ()
	Verbose parallel output stream. Used for additional information in debug mode.
static dealii::ConditionalOStream &	pout_summary ()
	Log output stream for writing a summary.log file.

Detailed Description

A class that allows printing to different output streams that are classified based on their verbosity. For now, this consists of two stream the release and debug. The debug stream provides more information that may be useful when debugging.

Constructor & Destructor Documentation

ConditionalOStreams() [1/3]

ConditionalOStreams::ConditionalOStreams ( )

default

Constructor.

~ConditionalOStreams()

ConditionalOStreams::~ConditionalOStreams ( )

default

Destructor.

ConditionalOStreams() [2/3]

ConditionalOStreams::ConditionalOStreams ( const ConditionalOStreams &  solver_base )

delete

Copy constructor.

Deleted so ostream instances aren't copied.

ConditionalOStreams() [3/3]

ConditionalOStreams::ConditionalOStreams ( ConditionalOStreams &&  solver_base )

deletenoexcept

Move constructor.

Deleted so ostream instances aren't moved.

Member Function Documentation

operator=() [1/2]

ConditionalOStreams & ConditionalOStreams::operator= ( ConditionalOStreams &&  solver_base )

deletenoexcept

Move assignment.

Deleted so ostream instances aren't moved.

operator=() [2/2]

ConditionalOStreams & ConditionalOStreams::operator= ( const ConditionalOStreams &  solver_base )

delete

Copy assignment.

Deleted so ostream instances aren't copied.

pout_base()

dealii::ConditionalOStream & ConditionalOStreams::pout_base ( )

static

Generic parallel output stream. Used for essential information in release and debug mode.

pout_summary()

dealii::ConditionalOStream & ConditionalOStreams::pout_summary ( )

static

Log output stream for writing a summary.log file.

pout_verbose()

dealii::ConditionalOStream & ConditionalOStreams::pout_verbose ( )

static

Verbose parallel output stream. Used for additional information in debug mode.

---

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

• /home/runner/work/phaseField/phaseField/include/prismspf/core/conditional_ostreams.h
• /home/runner/work/phaseField/phaseField/src/core/conditional_ostreams.cc