event.h

Go to the documentation of this file.

// Copyright (c) 2024 The YAC Authors
//
// SPDX-License-Identifier: BSD-3-Clause
 
#ifndef EVENT_H
#define EVENT_H
 
#include "mtime_datetime.h"
#include "mtime_timedelta.h"
#include "mtime_eventHandling.h"
#include "couple_config.h"
 
enum yac_action_type {
  NONE               = 0,
  REDUCTION          = 1,
  COUPLING           = 2,
  RESTART            = 3,
  GET_FOR_RESTART    = 4,
  PUT_FOR_RESTART    = 5,
  GET_FOR_CHECKPOINT = 6,
  PUT_FOR_CHECKPOINT = 7,
  OUT_OF_BOUND       = 8,
};
 
extern int yac_number_of_events;
struct event;
 
struct event * yac_event_new();
 
void yac_event_add ( struct event * event,
                     char const *model_time_step,
                     char const *coupling_time_step,
                     int lag,
                     enum yac_reduction_type time_operation,
                     const char * start_date,
                     const char * stop_date);
 
void yac_event_delete ( struct event * event );
 
enum yac_action_type yac_event_check ( struct event * event );
 
void yac_event_update ( struct event * event );
 
int yac_get_event_lag ( struct event * event );
 
int yac_get_event_time_operation ( struct event * event );
 
char * yac_get_event_coupling_timestep (
  struct event * event, char * timedelta_str );
 
char * yac_get_event_model_timestep (
  struct event * event, char * timedelta_str );
 
char * yac_get_event_current_datetime(
  struct event * event, char * datetime_str);
 
char const * yac_time_to_ISO(
  char const * time, enum yac_time_unit_type time_unit);
 
#endif