Simulations

GFS_SIMULATION_CLASS()

#define             GFS_SIMULATION_CLASS(klass)

GFS_SIMULATION()

#define             GFS_SIMULATION(obj)

GFS_IS_SIMULATION()

#define             GFS_IS_SIMULATION(obj)

GfsSimulationClass

typedef struct {
  GfsDomainClass parent_class;

  void (* run) (GfsSimulation *);
} GfsSimulationClass;

GfsSimulation

typedef struct {
  GfsDomain parent;

  GfsTime time;
  GfsPhysicalParams physical_params;

  GfsMultilevelParams projection_params;
  GfsMultilevelParams approx_projection_params;

  GfsAdvectionParams advection_params;

  GtsSListContainer * refines;

  GtsSListContainer * adapts;
  GfsAdaptStats adapts_stats;

  GtsSListContainer * events, * maps;
  GSList * modules, * globals;

  GtsSListContainer * solids;
  guint thin;
  gboolean output_solid;

  gboolean deferred_compilation;

  gdouble tnext;
} GfsSimulation;

GfsTime

typedef struct {
  gdouble t, start, end;
  guint i, istart, iend;
  gdouble dtmax;
} GfsTime;

GfsPhysicalParams

typedef struct {
  gdouble L, g;
  GfsFunction * alpha;
} GfsPhysicalParams;

gfs_init ()

void                gfs_init                            (int *argc,
                                                         char ***argv);

Initializes the Gerris library. This function must be called before any other function of the library.

gfs_simulation_class ()

GfsSimulationClass* gfs_simulation_class                (void);

gfs_simulation_new ()

GfsSimulation*      gfs_simulation_new                  (GfsSimulationClass *klass);

gfs_simulation_read ()

GfsSimulation*      gfs_simulation_read                 (GtsFile *fp);

Reads a simulation file from fp.

gfs_simulation_refine ()

void                gfs_simulation_refine               (GfsSimulation *sim);

Calls the @refine() methods of the GfsRefine of sim. Matches the boundaries by calling gfs_domain_match().

gfs_simulation_set_timestep ()

void                gfs_simulation_set_timestep         (GfsSimulation *sim);

Sets the time step for the next iteration of sim using the CFL (computed using gfs_domain_cfl()), the stability conditions for source terms and taking into account the timings of the various GfsEvent associated to sim.

More precisely, the time step is adjusted (if necessary) so that the time of the closest event is exactly reached after the iteration.

gfs_simulation_adapt ()

void                gfs_simulation_adapt                (GfsSimulation *simulation);

Checks if any mesh adaptation is necessary and adapts the mesh using an OR combination of all the regular criteria defined in simulation->adapts.

If any one or several criteria are defined as "not" refinements, the mesh will be refined only if all of this criteria AND any other regular criterion is verified.

gfs_simulation_write ()

void                gfs_simulation_write                (GfsSimulation *sim,
                                                         gint max_depth,
                                                         FILE *fp);

Writes in fp a text representation of sim. If max_depth is smaller or equal to -2, no cell tree data is written.

gfs_simulation_run ()

void                gfs_simulation_run                  (GfsSimulation *sim);

Runs sim.

gfs_object_simulation()

#define              gfs_object_simulation(o)     GFS_SIMULATION(GTS_OBJECT (o)->reserved)

gfs_time_init ()

void                gfs_time_init                       (GfsTime *t);

Initializes the time structure t with default values.

gfs_time_read ()

void                gfs_time_read                       (GfsTime *t,
                                                         GtsFile *fp);

Reads a time structure from fp and puts it in t.

gfs_time_write ()

void                gfs_time_write                      (GfsTime *t,
                                                         FILE *fp);

Writes in fp a text representation of the time structure t.

gfs_physical_params_init ()

void                gfs_physical_params_init            (GfsPhysicalParams *p);

Initializes the physical parameters structure p with default values.

gfs_physical_params_read ()

void                gfs_physical_params_read            (GfsPhysicalParams *p,
                                                         GfsDomain *domain,
                                                         GtsFile *fp);

Reads a physical parameters structure from fp and puts it in p.

gfs_physical_params_write ()

void                gfs_physical_params_write           (GfsPhysicalParams *p,
                                                         FILE *fp);

Writes in fp a text representation of the physical parameters structure p.