model.h

Go to the documentation of this file.

/* 
model.h
Igor Terentyev.
********************************************************************************
Model function types.
Model structure.
*/
/*============================================================================*/

/*
 * Modified 03.12 by WWS - case switch in action list changes from
 * array to be updated to internal time step, to accommodate the many
 * cases where more than one array is updated, hence needs to be
 * exchanged, and perhaps different numbers in fwd, lin, and adj
 * (inversion apps)
 */
#ifndef __IWAVE_MODEL_H_
#define __IWAVE_MODEL_H_
/*----------------------------------------------------------------------------*/

#include "utils.h"
#include "parser.h"
#include "stencil.h"
/* WWS 22.02.08 */
#include "grid.h"
#include "rdomain.h"

/*----------------------------------------------------------------------------*/
typedef struct {
  int it;    
  int iv;    
  int niv;   
  ireal dt;  
  ireal rhs; 
} TIMESTEPINDEX;

void next_step(TIMESTEPINDEX * ts);

int less_than(TIMESTEPINDEX t1, TIMESTEPINDEX t2);

ireal get_time(TIMESTEPINDEX ts);
  
/*----------------------------------------------------------------------------*/
/*
int ndim          :  number of dimensions.
STENCIL sten      :  stencil;
void *specs       :  model specific data.
TIMESTEP_FUN ts   :  timestep function.
void *tspars      :  timestep function parameters.
RDOM ld_a, ld_c   :  allocated domain, computational virtual domain.
RDOM *ld_s, *ld_r :  recv, send virtual domains.
int nt            :  number of timesteps.

BIG TODO: remove ld_s, ld_r to particular models and get rid of domains;
          they should be special objects that are prepared before send:
          copy overlaped data before sending, etc.
*/
/* WWS 22.08.12: added g, dt, it, removed ndim, nt */
/* Igor, Feb 26: added physical domain ld_p
RDOM ld_p
*/
typedef struct s_imodel {
  void * specs;

  grid g;

  std::vector<grid> sfg;

  grid gl;

  IPNT nls,nrs;

  int nnei;

  TIMESTEPINDEX tsind;

  std::vector<std::string> active;

  RDOM ld_a;
  RDOM ld_c;
  RDOM ld_p;
  RDOM *ld_s;
  RDOM *ld_r;
  
} IMODEL;

/*----------------------------------------------------------------------------*/

typedef int (*IMODELINIT_FUN)(PARARRAY *pars, FILE *stream, IMODEL *model);
/*----------------------------------------------------------------------------*/
int im_construct(IMODEL *model);
/*----------------------------------------------------------------------------*/
int im_destroy(IMODEL *model, void (*destr)(void **));
/*----------------------------------------------------------------------------*/
int im_setndim(IMODEL *model);
/*----------------------------------------------------------------------------*/

#endif /*__MODEL_H_*/

---