NuTo
Numerics Tool
Public Member Functions | List of all members
NuTo::EventListHandler Class Reference

class for event list operations More...

#include <EventListHandler.h>

Public Member Functions

 EventListHandler ()
 constructor, provides an empty event list and initializes timers More...
 
 ~EventListHandler ()
 destructor, deletes all events More...
 
void PerformNextEvent ()
 performs the most recent event 1) get next events and performs it 2) removes all old events 3) finds new events More...
 
void PrintEvents ()
 prints all events More...
 
void AddEvent (double rTime, CollidableBase &rCollidable1, CollidableBase &rCollidable2, int rType)
 adds a new event, of rTime < mTimeBarrier More...
 
void DeleteOldEvents (Event::LocalEvents &rOldEvents)
 deletes every event in rOldEvents More...
 
double GetNextEventTime ()
 returns the time of the most recent event More...
 
double SetTimeBarrier (double rTimeBarrier, SubBoxHandler &rSubBoxes)
 setter for the time barrier, rebuilds the event list More...
 
int GetEventListSize ()
 getter for the event list size More...
 
void Clear ()
 deletes all events More...
 
void PrintStatistics (double rTimeTotal)
 prints all time mesurement statistics More...
 

Detailed Description

class for event list operations

Constructor & Destructor Documentation

NuTo::EventListHandler::EventListHandler ( )

constructor, provides an empty event list and initializes timers

NuTo::EventListHandler::~EventListHandler ( )

destructor, deletes all events

Member Function Documentation

void NuTo::EventListHandler::AddEvent ( double  rTime,
CollidableBase rCollidable1,
CollidableBase rCollidable2,
int  rType 
)

adds a new event, of rTime < mTimeBarrier

Parameters
rTimecollision time
rCollidable1collision partner 1
rCollidable2collision partner 2
rTypetype of the collision
void NuTo::EventListHandler::Clear ( )

deletes all events

void NuTo::EventListHandler::DeleteOldEvents ( Event::LocalEvents rOldEvents)

deletes every event in rOldEvents

Parameters
rOldEventsold events that need to be deleted
int NuTo::EventListHandler::GetEventListSize ( )

getter for the event list size

double NuTo::EventListHandler::GetNextEventTime ( )

returns the time of the most recent event

void NuTo::EventListHandler::PerformNextEvent ( )

performs the most recent event 1) get next events and performs it 2) removes all old events 3) finds new events

void NuTo::EventListHandler::PrintEvents ( )

prints all events

void NuTo::EventListHandler::PrintStatistics ( double  rTimeTotal)

prints all time mesurement statistics

double NuTo::EventListHandler::SetTimeBarrier ( double  rTimeBarrier,
SubBoxHandler rSubBoxes 
)

setter for the time barrier, rebuilds the event list

Parameters
rTimeBarriernew in-simulation time barrier
rSubBoxessub boxes to consider

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