PlasCom2  1.0
XPACC Multi-physics simluation application
Public Member Functions | Protected Attributes | List of all members
parallel_program Class Reference

Detailed Description

Definition at line 21 of file ParallelApplication.H.

#include <ParallelApplication.H>

Public Member Functions

 parallel_program ()
 Default constructor. More...
 
 parallel_program (int nargs, char **args)
 Constructor designed to take all commandline args. More...
 
 parallel_program (CommandLineType &comline, CommunicatorType &incomm)
 Constructor designed to take all commandline args. More...
 
virtual int Initialize ()
 Populates native data structures from commandline. More...
 
virtual ~parallel_program ()
 Destructor. More...
 
virtual int Run ()
 This function implements the main function executed by the program. More...
 
virtual int Finalize ()
 
- Public Member Functions inherited from Program< GlobalType, ComLineType >
 Program ()
 
 Program (GlobalType &inglob)
 
 Program (ComLineType &incom)
 
 Program (int narg, char **args)
 
 Program (ComLineType &incom, GlobalType &inglob)
 
 Program (int narg, char **args, GlobalType &inglob)
 
ComLineType & CommandLine ()
 
virtual ~Program ()
 

Protected Attributes

std::string outFileName
 Name of file for output. More...
 
std::ofstream * outFilePtr
 Output file stream object for output. More...
 
- Protected Attributes inherited from Program< GlobalType, ComLineType >
ComLineType _command_line
 
Inheritance diagram for parallel_program:
[legend]
Collaboration diagram for parallel_program:
[legend]

Constructor & Destructor Documentation

◆ parallel_program() [1/3]

parallel_program ( )
inline

Default constructor.

Definition at line 32 of file ParallelApplication.H.

◆ parallel_program() [2/3]

parallel_program ( int  nargs,
char **  args 
)
inline

Constructor designed to take all commandline args.

Definition at line 41 of file ParallelApplication.H.

◆ parallel_program() [3/3]

parallel_program ( CommandLineType &  comline,
CommunicatorType &  incomm 
)
inline

Constructor designed to take all commandline args.

Definition at line 50 of file ParallelApplication.H.

References Program< GlobalType, ComLineType >::_command_line.

◆ ~parallel_program()

virtual ~parallel_program ( )
inlinevirtual

Destructor.

Definition at line 165 of file ParallelApplication.H.

References parallel_program::outFilePtr.

Member Function Documentation

◆ Finalize()

virtual int Finalize ( )
inlinevirtual

Reimplemented from Program< GlobalType, ComLineType >.

Definition at line 179 of file ParallelApplication.H.

References Program< GlobalType, ComLineType >::Finalize().

Here is the call graph for this function:

◆ Initialize()

virtual int Initialize ( void  )
inlinevirtual

Populates native data structures from commandline.

Reimplemented from Program< GlobalType, ComLineType >.

Definition at line 61 of file ParallelApplication.H.

References Program< GlobalType, ComLineType >::CommandLine(), and Program< GlobalType, ComLineType >::Initialize().

Here is the call graph for this function:

◆ Run()

virtual int Run ( )
inlinevirtual

This function implements the main function executed by the program.

Reimplemented from Program< GlobalType, ComLineType >.

Definition at line 178 of file ParallelApplication.H.

Member Data Documentation

◆ outFileName

std::string outFileName
protected

Name of file for output.

Definition at line 25 of file ParallelApplication.H.

◆ outFilePtr

std::ofstream* outFilePtr
protected

Output file stream object for output.

Definition at line 27 of file ParallelApplication.H.

Referenced by parallel_program::~parallel_program().

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