Public Member Functions | Private Attributes | List of all members
oomph::MPIOutputModifier Class Reference

#include <oomph_utilities.h>

+ Inheritance diagram for oomph::MPIOutputModifier:

Public Member Functions

 MPIOutputModifier ()
 Constructor – initialise flags for output from all processors. More...
 
OomphCommunicator *& communicator_pt ()
 Return pointer to communicator. More...
 
virtual bool operator() (std::ostream &stream)
 Precede the output by the processor ID but output everything. More...
 
void restrict_output_to_single_processor (const unsigned &output_rank=0)
 
void allow_output_from_all_processors ()
 
- Public Member Functions inherited from oomph::OutputModifier
 OutputModifier ()
 Empty constructor. More...
 
virtual ~OutputModifier ()
 Empty virtual destructor. More...
 

Private Attributes

unsigned Output_rank
 Rank of single processor that produces output (only used if Output_from_single_processor=true. More...
 
bool Output_from_single_processor
 
OomphCommunicatorCommunicator_pt
 Communicator. More...
 

Detailed Description

MPI output modifier: Precedes every output by specification of the processor ID. Output can be restricted to a single processor.

Definition at line 742 of file oomph_utilities.h.

Constructor & Destructor Documentation

oomph::MPIOutputModifier::MPIOutputModifier ( )
inline

Constructor – initialise flags for output from all processors.

Definition at line 762 of file oomph_utilities.h.

Member Function Documentation

void oomph::MPIOutputModifier::allow_output_from_all_processors ( )
inline

Switch to ensure output is only produced from a single processor (default: Master node, i.e. rank 0)

Definition at line 783 of file oomph_utilities.h.

OomphCommunicator*& oomph::MPIOutputModifier::communicator_pt ( )
inline

Return pointer to communicator.

Definition at line 767 of file oomph_utilities.h.

Referenced by oomph::MPI_Helpers::init().

bool oomph::MPIOutputModifier::operator() ( std::ostream &  stream)
virtual

Precede the output by the processor ID but output everything.

Reimplemented from oomph::OutputModifier.

Definition at line 1172 of file oomph_utilities.cc.

References Communicator_pt, Output_from_single_processor, and Output_rank.

void oomph::MPIOutputModifier::restrict_output_to_single_processor ( const unsigned &  output_rank = 0)
inline

Switch to ensure output is only produced from a single processor (default: Master node, i.e. rank 0)

Definition at line 774 of file oomph_utilities.h.

Member Data Documentation

OomphCommunicator* oomph::MPIOutputModifier::Communicator_pt
private

Communicator.

Definition at line 756 of file oomph_utilities.h.

Referenced by operator()().

bool oomph::MPIOutputModifier::Output_from_single_processor
private

Boolean to control if output is performed only on a single processor (default: false)

Definition at line 753 of file oomph_utilities.h.

Referenced by operator()().

unsigned oomph::MPIOutputModifier::Output_rank
private

Rank of single processor that produces output (only used if Output_from_single_processor=true.

Definition at line 749 of file oomph_utilities.h.

Referenced by operator()().


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