GfsEvent

Collaboration diagram for GfsEvent:

Classes
	GfsAdapt
	GfsConstant
	GfsDiffusion
	GfsEventBalance
	GfsEventFilter
	GfsEventHarmonic
	GfsEventList
	GfsEventScript
	GfsEventStop
	GfsEventSum
	GfsGenericInit
	GfsGenericMetric
	GfsOutput
	GfsParticle
	GfsRemoveDroplets
	GfsSolid
	GfsSourceGeneric
	GfsVariable
Functions
gdouble	gfs_event_next (GfsEvent *event, GfsSimulation *sim)
void	gfs_event_set (GfsEvent *e, gdouble start, gdouble end, gdouble step, gint istart, gint iend, gint istep)
void	gfs_event_init (GfsEvent *event, GfsSimulation *sim)
void	gfs_event_do (GfsEvent *event, GfsSimulation *sim)
void	gfs_event_half_do (GfsEvent *event, GfsSimulation *sim)
void	gfs_event_redo (GfsEvent *event, GfsSimulation *sim)

---

Detailed Description

Any action to be performed at a given time.

See also:

Syntax reference

---

Function Documentation

void gfs_event_do	(	GfsEvent *	event,
		GfsSimulation *	sim
	)

Parameters:

event,:	a #GfsEvent
sim	a #GfsSimulation.

Realises the event if active.

Here is the call graph for this function:

void gfs_event_half_do	(	GfsEvent *	event,
		GfsSimulation *	sim
	)

Parameters:

event,:	a #GfsEvent
sim	a #GfsSimulation.

Realises the half-event if active.

void gfs_event_init	(	GfsEvent *	event,
		GfsSimulation *	sim
	)

Parameters:

event	a #GfsEvent.
sim	a #GfsSimulation.

Initalizes event associated with sim. In particular, if event is an "init" event it is activated by this function.

Here is the caller graph for this function:

gdouble gfs_event_next	(	GfsEvent *	event,
		GfsSimulation *	sim
	)

Parameters:

event	a #GfsEvent.
sim	a #GfsSimulation.

Returns:

the next physical time at which event will be realised.

Here is the caller graph for this function:

void gfs_event_redo	(	GfsEvent *	event,
		GfsSimulation *	sim
	)

Parameters:

event,:	a #GfsEvent
sim	a #GfsSimulation.

Realises the event if it has just been realised.

Here is the caller graph for this function:

void gfs_event_set	(	GfsEvent *	e,
		gdouble	start,
		gdouble	end,
		gdouble	step,
		gint	istart,
		gint	iend,
		gint	istep
	)

Parameters:

e	a #GfsEvent.
start	start time.
end	end time.
step	time step.
istart	start iteration.
iend	end iteration.
istep	iteration step.

Sets the properties of event e.

If any of the arguments is negative, the corresponding value in e is unchanged.