Detailed Description

template<typename ComLineType>
class ix::global::mpiprogram< ComLineType >

Definition at line 83 of file MPIGlobal.H.

#include <MPIGlobal.H>

Public Member Functions
	mpiprogram ()

	mpiprogram (mpiglobal &inglob)

	mpiprogram (ComLineType &incom)

	mpiprogram (int narg, char **args)

	mpiprogram (ComLineType &incom, mpiglobal &inglob)

	mpiprogram (int narg, char **args, mpiglobal &inglob)

	mpiprogram (int narg, char **args, MPI_Comm &inComm)

virtual int	Initialize ()

ComLineType &	CommandLine ()

virtual int	Run ()

virtual int	Finalize ()
	Finalizes the global object, and it's profiler object. More...

virtual	~mpiprogram ()

Public Member Functions inherited from mpiglobal
	mpiglobal ()

	mpiglobal (parallelglobal &inglob)

	mpiglobal (mpiglobal &pglobin)

	mpiglobal (const std::string &name)

	mpiglobal (const std::string &name, unsigned int id)

	mpiglobal (int narg, char **args)

	mpiglobal (int narg, char **args, CommunicatorType &incomm)

	mpiglobal (int narg, char **args, MPI_Comm &incomm)

int	NumProc ()

Public Member Functions inherited from ParallelGlobalObj< CommunicatorType, StackType, ErrorType, ProfilerType >
	ParallelGlobalObj ()

	ParallelGlobalObj (GlobalType &inglob)

	ParallelGlobalObj (ParallelGlobalObj< CommunicatorType, StackType, ErrorType, ProfilerType > &pglobin)

	ParallelGlobalObj (const std::string &name)

	ParallelGlobalObj (const std::string &name, unsigned int id)

	ParallelGlobalObj (int narg, char **args)

	ParallelGlobalObj (int narg, char **args, CommunicatorType &incomm)

virtual int	Init (const std::string &name, CommunicatorType &incomm)

virtual int	Init (const std::string &name)

virtual int	Init (const std::string &name, unsigned int id)

virtual int	Init (int narg, char **args)

bool	ProfilingBarriers ()

void	EnableProfilingBarriers ()

void	DisableProfilingBarriers ()

virtual void	FunctionEntry (const StackType &stackentry)
	FunctionEntry updates the Stack as well as the Profiler. More...

virtual void	FunctionExit (const StackType &stackentry)
	FunctionExit updates the Stack as well as the Profiler. More...

virtual int	Rank ()

virtual int	NProc ()

virtual CommunicatorType &	Communicator ()

virtual	~ParallelGlobalObj ()

Public Member Functions inherited from GlobalObj< StackType, ErrorType, ProfilerType >
	GlobalObj ()
	Default constructor. Profiling is OFF by default. More...

	GlobalObj (int narg, char **args)
	Default constructor. More...

	GlobalObj (GlobalObj< StackType, ErrorType, ProfilerType > &globin)
	Constructor with args. More...

	GlobalObj (const StackType &name)
	Constructor with args. More...

	GlobalObj (const StackType &name, int id)
	Constructor with args. More...

virtual int	Init (const StackType &name)
	Initializes the global object and it's profiler object /// Initializes the global object and it's profiler object Profiling is ON by default if Init is invoked. More...

virtual int	Init (const StackType &name, unsigned int id)
	Initializes the global object and it's profiler object Profiling is ON by default if Init is invoked. More...

virtual bool	WriteProfiles ()
	Get state of enablement for writing profile files. More...

virtual bool	WriteProfiles (bool yn)
	Enable or disable profile file writing. More...

virtual bool	Profiling ()
	Get profiling state. More...

virtual bool	Profiling (bool yn)
	Enable or disable profiling. More...

virtual void	Report (std::ostream &ReportStream)
	Creates the final profiling report on the specified stream. More...

virtual void	Register (const StackType &stackentry)
	Register will push to the Stack only. More...

virtual void	DeRegister (const StackType &stackentry)
	DeRegister will pop from the stack only. More...

virtual void	FunctionExitAll ()
	FunctionExitAll exits all from the Profiler only. More...

virtual void	Error (const ErrorType &error)
	Pushes an error onto the error stack. More...

virtual void	DumpErrors (std::ostream &Ostr)
	Dumps the errors themselves to the indicated stream. More...

virtual void	DumpStack (std::ostream &Ostr)
	Dumps the code construct statck to the indicated stream. More...

virtual void	DumpProfile (std::ostream &Ostr)
	Dumps the timing profile to the indicated stream. More...

bool	DebugStreamReady ()
	Checks debug stream. More...

void	SetDebugStream (std::ostream &dbstream)
	Sets the debug stream object. More...

std::ostream &	DebugStream ()
	Gets the debug stream object. More...

std::ostream *	DebugStreamPtr ()
	Gets the debug stream pointer. More...

bool	ErrStreamReady ()
	Checks error stream. More...

void	SetErrStream (std::ostream &dbstream)
	Sets the error stream object. More...

std::ostream &	ErrStream ()
	Gets the error stream object. More...

std::ostream *	ErrStreamPtr ()
	Gets the error stream pointer. More...

bool	OutStreamReady ()
	Checks out stream. More...

void	SetOutStream (std::ostream &outstream)
	Sets the stdout stream object. More...

std::ostream &	OutStream ()
	Gets the stdout stream object. More...

std::ostream *	OutStreamPtr ()
	Gets the stdout stream pointer. More...

void	UnsetOutStream ()
	Sets outstream to NULL. More...

bool	LogStreamReady ()
	Checks log stream. More...

void	SetLogStream (std::ostream &logstream)
	Sets the stdout stream object. More...

std::ostream &	LogStream ()
	Gets the log stream object. More...

std::ostream *	LogStreamPtr ()
	Gets the log stream pointer. More...

void	SetProfiler (ProfilerType &profiler)
	Sets the Profiler object. More...

virtual void	SetName (const std::string &name)

virtual void	ReName (const std::string &name)

virtual const std::string &	Name ()

ProfilerType &	Profiler ()
	Gets the debug stream object. More...

void	SetDebugLevel (unsigned char l)
	Sets the level of debugging. More...

unsigned char	DebugLevel ()
	Returns the debugging level. More...

void	SetVerbLevel (unsigned char l)

unsigned char	VerbLevel ()
	Returns the verbosity level. More...

void	SetLogLevel (unsigned char l)

unsigned char	LogLevel ()
	Returns the verbosity level. More...

void	DeSyncIO ()
	DeSync IO - relinquish control over IO, revert to standard. More...

void	SyncIO ()
	Syncronize IO - assume control over IO, using established streams. More...

virtual int	ForceOut (const std::string &outstr, unsigned char inlev=1)

virtual int	StdOut (const std::string &outstr, unsigned char inlev=1)

virtual int	ErrOut (const std::string &outstr)

virtual int	DebugOut (const std::string &outstr, int inlev=1)

virtual int	LogOut (const std::string &outstr, int inlev=0)

virtual	~GlobalObj ()
	Destructor. More...

Protected Attributes
ComLineType	_command_line

Protected Attributes inherited from ParallelGlobalObj< CommunicatorType, StackType, ErrorType, ProfilerType >
bool	profilingBarrier

CommunicatorType	globalCommunicator

Protected Attributes inherited from GlobalObj< StackType, ErrorType, ProfilerType >
std::ostream *	_DebugStream
	DebugStream is useful for parallel programs that cannot stream debugging information to the screen. More...

std::ostream *	_OutStream

std::ostream *	_LogStream

std::ostream *	_ErrStream

ProfilerType *	_Profiler
	This is a placeholder for a generic profiling tool. More...

Inheritance diagram for mpiprogram< ComLineType >:

[legend]

Collaboration diagram for mpiprogram< ComLineType >:

[legend]

Constructor & Destructor Documentation

◆ mpiprogram() [1/7]

mpiprogram ( )

inline

Definition at line 88 of file MPIGlobal.H.

◆ mpiprogram() [2/7]

mpiprogram ( mpiglobal & inglob )

inline

Definition at line 91 of file MPIGlobal.H.

◆ mpiprogram() [3/7]

mpiprogram ( ComLineType & incom )

inline

Definition at line 93 of file MPIGlobal.H.

◆ mpiprogram() [4/7]

mpiprogram	(	int	narg,
		char **	args
	)

inline

Definition at line 96 of file MPIGlobal.H.

◆ mpiprogram() [5/7]

mpiprogram	(	ComLineType &	incom,
		mpiglobal &	inglob
	)

inline

Definition at line 102 of file MPIGlobal.H.

◆ mpiprogram() [6/7]

mpiprogram	(	int	narg,
		char **	args,
		mpiglobal &	inglob
	)

inline

Definition at line 104 of file MPIGlobal.H.

◆ mpiprogram() [7/7]

mpiprogram	(	int	narg,
		char **	args,
		MPI_Comm &	inComm
	)

inline

Definition at line 110 of file MPIGlobal.H.

◆ ~mpiprogram()

virtual ~mpiprogram ( )

inlinevirtual

Definition at line 123 of file MPIGlobal.H.

Member Function Documentation

◆ CommandLine()

ComLineType& CommandLine ( )

inline

Definition at line 120 of file MPIGlobal.H.

◆ Finalize()

virtual int Finalize ( )

inlinevirtual

Finalizes the global object, and it's profiler object.

Reimplemented from ParallelGlobalObj< CommunicatorType, StackType, ErrorType, ProfilerType >.

Reimplemented in parallelprogram.

Definition at line 122 of file MPIGlobal.H.

References ParallelGlobalObj< CommunicatorType, StackType, ErrorType, ProfilerType >::Finalize().

Referenced by parallelprogram::Finalize(), and application::FinalizeApplication().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Initialize()

virtual int Initialize ( void )

inlinevirtual

Reimplemented in parallelprogram.

Definition at line 115 of file MPIGlobal.H.

Referenced by parallelprogram::Initialize().

Here is the caller graph for this function:

◆ Run()

virtual int Run ( )

inlinevirtual

Reimplemented in parallelprogram.

Definition at line 121 of file MPIGlobal.H.

Member Data Documentation

◆ _command_line

ComLineType _command_line

protected

Definition at line 86 of file MPIGlobal.H.

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

MPIGlobal.H

Detailed Description

template<typename ComLineType> class ix::global::mpiprogram< ComLineType >

Public Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ mpiprogram() [1/7]

◆ mpiprogram() [2/7]

◆ mpiprogram() [3/7]

◆ mpiprogram() [4/7]

◆ mpiprogram() [5/7]

◆ mpiprogram() [6/7]

◆ mpiprogram() [7/7]

◆ ~mpiprogram()

Member Function Documentation

◆ CommandLine()

◆ Finalize()

◆ Initialize()

◆ Run()

Member Data Documentation

◆ _command_line

template<typename ComLineType>
class ix::global::mpiprogram< ComLineType >