ElmerFoamFSI::ExampleProgram Namespace Reference

Encapsulate example program-specific code constructs. More...

Detailed Description

Encapsulate example program-specific code constructs.

This namespace contains all of the base code constructs that are used in the example programs. These example programs have several features which make them very easy to integrate in composite software systems.

• Program is entirely encapsulated in program object
• All screen output is automatically tagged with the program name
• Common look-and-feel interface
• Interface functionality allows menu-driven integration

Other convenient features of this API are:

• Built-in stack tracing for debugging
• Built-in profiling utilities
• Advanced command-line handling
• Built-in parallelism

Classes
class	ExampleProgramComLine
	The ComLineObject for the example programs. More...
class	SerialProgram
	Implementation of the basic parts of the serial program example. More...

Typedefs
typedef IRAD::Profiler::ProfilerObj	ProfilerType
	Convenience type definition for Profiler object. More...
typedef std::string	StackType
	Convenience type definition for program stack. More...
typedef IRAD::Global::GlobalObj < StackType, int, ProfilerType >	GlobalType
	Convenience type definition for the serial global object. More...
typedef ExampleProgramComLine	ComLineType
	Convenience type definition for the example comline object. More...
typedef IRAD::Global::Program < GlobalType, ComLineType >	SerialProgramType
	Convenience type definition for the serial program. More...
typedef ElmerFoamFSI::ExampleProgram::SerialProgram	SEProgramType
	Convenience definition for serial program type. More...

Functions
template<typename ProgramType >
int	Driver (int argc, char *argv[])
	Unified driver for the example programs. More...