SPARK::Requests::TDispatcher Class Reference

Wrapper class that defines a static function for each request that can be sent from an atomic class. Use in coordination with the class THeader for the request addressing. More...

#include <requests.h>

List of all members.

Static Public Member Functions
Requests processed when detected
bool	abort (const THeader &header)
	Aborts the simulation by exiting "cleanly" from the process.
Requests processed only after a successful step
bool	stop (const THeader &header)
	Stops the simulation after the next successful step.
bool	set_stop_time (const THeader &header, double time)
	Sets the time time at which the simulation will be stopped.
bool	report (const THeader &header)
	Generates a "forced" report at the current time.
bool	snapshot (const THeader &header, const char *filename)
	Generates a snapshot file named filename where filename can include a valid path.
bool	set_meeting_point (const THeader &header, double time)
	Forces the time stepper to synchronize with time, whereby time > current time.
bool	clear_meeting_points (const THeader &header)
	Clears all meeting points assumulated so far through synchronize requests.
bool	restart (const THeader &header)
	Restarts the simulation with a static step in order to perform a consistent initialization calculation.
Restricted requests
bool	set_time_step (const THeader &header, double h)
	Sets the time step h for the next dynamic step.
bool	set_dynamic_stepper (const THeader &header)
	Sets dynamic stepper that will be used from now on for all dynamic steps.

---

Detailed Description

Wrapper class that defines a static function for each request that can be sent from an atomic class. Use in coordination with the class THeader for the request addressing.

Note:

The dispatch functions return true if the dispatcher was capable to pass the request to the desired target problem. Otherwise, the functions return false to indicate that the request will not be taken into account.

---

Member Function Documentation

bool SPARK::Requests::TDispatcher::abort (  const THeader &  header  )  [static]

Aborts the simulation by exiting "cleanly" from the process. Parameters: header  Request header

bool SPARK::Requests::TDispatcher::stop (  const THeader &  header  )  [static]

Stops the simulation after the next successful step. Parameters: header  Request header

bool SPARK::Requests::TDispatcher::set_stop_time (  const THeader &  header, double  time )  [static]

Sets the time time at which the simulation will be stopped. This request is accepted only if the requested stop time is ahead of the current global time of the simulator. It will however overwrite a previous stop time request if the new one indicates an earlier stopping time. The stop time does not overwrite the final time specified in the runtime control parameters. Parameters: header  Request header time  Stopping time

bool SPARK::Requests::TDispatcher::report (  const THeader &  header  )  [static]

Generates a "forced" report at the current time. Parameters: header  Request header

bool SPARK::Requests::TDispatcher::snapshot (  const THeader &  header, const char *  filename )  [static]

Generates a snapshot file named filename where filename can include a valid path. Parameters: header  Request header filename  Name of the snapshot file

bool SPARK::Requests::TDispatcher::set_meeting_point (  const THeader &  header, double  time )  [static]

Forces the time stepper to synchronize with time, whereby time > current time. Parameters: header  Request header time  Meeting point

bool SPARK::Requests::TDispatcher::clear_meeting_points (  const THeader &  header  )  [static]

Clears all meeting points assumulated so far through synchronize requests. Parameters: header  Request header

bool SPARK::Requests::TDispatcher::restart (  const THeader &  header  )  [static]

Restarts the simulation with a static step in order to perform a consistent initialization calculation. Parameters: header  Request header

bool SPARK::Requests::TDispatcher::set_time_step (  const THeader &  header, double  h )  [static]

Sets the time step h for the next dynamic step. Parameters: header  Request header h  Candidate time step

bool SPARK::Requests::TDispatcher::set_dynamic_stepper (  const THeader &  header  )  [static]

Sets dynamic stepper that will be used from now on for all dynamic steps. Parameters: header  Request header

---

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

• requests.h

---