oofem::Monitor Class Reference

#include <monitor.h>

Inheritance diagram for oofem::Monitor:

Public Types
enum	MonitorEvent { TimeStepTermination }

Public Member Functions
	Monitor (int n)
virtual	~Monitor ()
virtual void	initializeFrom (InputRecord &ir)=0
	Initializes receiver according to object description stored in input record.
virtual void	update (EngngModel *eModel, TimeStep *tStep, MonitorEvent event)=0
virtual const char *	giveClassName () const =0
	Returns class name of the receiver.

Protected Attributes
int	number

Detailed Description

Class representing monitor, an abstract class inplementing solution monitor. Monitors are managed by MonitorManager and are invoked at user controlled events, such as solution step termoination. Derived classes can perform specific actions (updating model, plotting proogress, etc)

Definition at line 55 of file monitor.h.

Member Enumeration Documentation

MonitorEvent

enum oofem::Monitor::MonitorEvent

Enumerator
TimeStepTermination

Definition at line 60 of file monitor.h.

Constructor & Destructor Documentation

Monitor()

oofem::Monitor::Monitor ( int n )

inline

Definition at line 64 of file monitor.h.

Referenced by oofem::DummyMonitor::DummyMonitor().

~Monitor()

virtual oofem::Monitor::~Monitor ( )

inlinevirtual

Definition at line 67 of file monitor.h.

Member Function Documentation

giveClassName()

virtual const char * oofem::Monitor::giveClassName ( ) const

pure virtual

Returns class name of the receiver.

Implemented in oofem::DummyMonitor.

initializeFrom()

virtual void oofem::Monitor::initializeFrom ( InputRecord & ir )

pure virtual

Initializes receiver according to object description stored in input record.

Implemented in oofem::DummyMonitor.

update()

virtual void oofem::Monitor::update ( EngngModel * eModel, TimeStep * tStep, MonitorEvent event )

pure virtual

updates the monitor state. This can also mean updating received eModel state.

Parameters

eModel	instance of EngngModel
tStep	time step
event	event type

Implemented in oofem::DummyMonitor.

Member Data Documentation

number

int oofem::Monitor::number

protected

Definition at line 58 of file monitor.h.

---

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

• monitor.h