Diffpack Documentation

Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members File Members Search

SimCase Class Reference

user dependent. code for standard menu functions in classes. More...

#include <SimCase.h>

Inheritance diagram for SimCase::

Public Methods
	SimCase ()
virtual	~SimCase ()
virtual void	adm (MenuSystem &menu)
void	attach (MenuSystem &menu)
MenuSystem&	getMenuSystem ()
virtual void	solveProblem ()
virtual void	openReport ()
virtual void	resultReport ()
virtual void	closeReport ()
int	getMultipleLoopLimit ()
int	getMultipleLoopIndex ()
Protected Attributes
Handle(MenuSystem)	menu_system

Detailed Description

user dependent. code for standard menu functions in classes.

NAME: SimCase - user dependent. code for standard menu functions in classes

DESCRIPTION:

Class "SimCase" represents the user''s problem dependent code that is needed when using the menu tool "MenuSystem". In fact, "SimCase" is only required when one applies the multiple loop functionality of class "MenuSystem". For further documentation, see the classes "MenuSystem" and "MultipleReporter" and H.P. Langtangen, "Computational Partial Differential Equations", Springer-Verlag, 1999.

Constructor & Destructor Documentation

SimCase::SimCase ( )

The constructor takes no arguments. No further initialization is required.

SimCase::~SimCase ( ) [virtual]

Member Function Documentation

void SimCase::adm ( MenuSystem & menu ) [virtual]

administrates the define, prompt and scan steps when using the menu system. The menu object that was used for these steps is available as "menu_system". (For interested users, the "menu_system" variable is needed for (1) flexible reading of menu answers at any time in a simulator, and (2) monitoring the multiple loop from the simulator object. Then the "menu_system" object must be properly initialized. This is done in "adm", and hence "adm" must always be written in a simulator. Note that "adm" is automatically called by "MenuSystem multipleLoop").

void SimCase::attach ( MenuSystem & menu )

void SimCase::closeReport ( ) [inline, virtual]

closes files etc that were opened in "openReport". (ML)

MenuSystem & SimCase::getMenuSystem ( )

int SimCase::getMultipleLoopIndex ( )

returns the current combination (simulation, execution) number in a multiple loop. This information is gained from class "MenuSystem". (ML)

int SimCase::getMultipleLoopLimit ( )

returns the number of combinations in a multiple loop, or in other words, the number of simulations that is implied by the the multiple menu answers. This information is gained from class "MenuSystem". (ML)

void SimCase::openReport ( ) [inline, virtual]

aimed at opening files, etc. that are used by "resultReport". (ML)

void SimCase::resultReport ( ) [virtual]

to be called right after "solveProblem" in order to report on the results of a single execution in tabular form. See also class "MultipleReporter" or class "Reporter". (ML)

void SimCase::solveProblem ( ) [virtual]

required in multiple loops for executing a single problem for one given combination of the menu answers. (ML)

Member Data Documentation

Handle(MenuSystem) SimCase::menu_system [protected]

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

SimCase.h