Stop event

Name

Stop event -- Stopping a simulation when a stationary solution is reached

Synopsis


#include <gfs.h>


#define     GFS_EVENT_STOP                  (obj)
#define     GFS_IS_EVENT_STOP               (obj)

            GfsEventStop;

GfsEventClass* gfs_event_stop_class         (void);

Description

GfsEventStop will stop the simulation whenever the maximum difference between the current field and the previous field of the given variable is smaller than the specified threshold.

The syntax in parameter files is as follows:

[ GfsEvent ] NAME MIN

where NAME is the name of a variable and MIN is the threshold.

Details

GFS_EVENT_STOP()

#define     GFS_EVENT_STOP(obj)

obj :


GFS_IS_EVENT_STOP()

#define     GFS_IS_EVENT_STOP(obj)

obj :


GfsEventStop

typedef struct {
  GfsEvent parent;

  GfsVariable * v, * oldv, * diff;
  gdouble last, max;
} GfsEventStop;


gfs_event_stop_class ()

GfsEventClass* gfs_event_stop_class         (void);

Returns :