Generic event

Name

Generic event -- Any action to be performed at a given time

Synopsis


#include <gfs.h>


#define     GFS_EVENT_CLASS                 (klass)
#define     GFS_EVENT                       (obj)
#define     GFS_IS_EVENT                    (obj)

struct      GfsEventClass;
struct      GfsEvent;

GfsEventClass* gfs_event_class              (void);
GfsEvent*   gfs_event_new                   (GfsEventClass *klass);

Description

Events are used to control any action which needs to be performed at a given time during a simulation. This includes one off actions as well as periodically repeated actions.

The syntax in parameter files is as follows:

GfsEvent { start = 0.1 istart = 10 ( step = 1.2 | istep = 10 ) end = 0.4 iend = 123 }

with

startPhysical starting time (default is zero). The end keyword can be used to indicate the end of the simulation.
istartTime step starting time (default is zero).
stepRepeat every step physical time units (default is infinity).
istepRepeat every istep time steps (default is infinity).
endStop at or before this physical time (default is infinity).
iendStop at or before this number of time steps (default is infinity).

Details

GFS_EVENT_CLASS()

#define     GFS_EVENT_CLASS(klass)

klass : 


GFS_EVENT()

#define     GFS_EVENT(obj)

obj : 


GFS_IS_EVENT()

#define     GFS_IS_EVENT(obj)

obj : 


struct GfsEventClass

struct GfsEventClass;


struct GfsEvent

struct GfsEvent {
  GtsSListContainee parent;

  gdouble t, start, end, step;
  guint i, istart, iend, istep;
  
  guint n;
  gboolean end_event;
};


gfs_event_class ()

GfsEventClass* gfs_event_class              (void);

Returns : 


gfs_event_new ()

GfsEvent*   gfs_event_new                   (GfsEventClass *klass);

klass : 
Returns :