iwinfo.hh

Go to the documentation of this file.

#ifndef __IWAVE_M_TUPLE
#define __IWAVE_M_TUPLE

#include "std_cpp_includes.hh"
#include "utils.h"
#include "except.hh"
#include "write.hh"
#include "model.h"

// values for "active" flags
#define ACTIVE_LINEAR 2
#define ACTIVE_NONLINEAR 1

using RVL::RVLException;

size_t pow2(int);

/* max number of data tuples permitted */
#define IWAVEMAXDATA 256

// forward declaration
class IWaveInfo;

typedef void (*FD_TIMESTEP)(std::vector<RDOM *> dom, bool fwd, int iv, void* fdpars);

/*
typedef int (*FD_MODELINIT)(PARARRAY * pars, 
                FILE * stream, 
                grid const & g,
                ireal dt,
                std::vector<std::string> & active,
                void ** specs);
*/
typedef int (*FD_MODELINIT)(PARARRAY pars, 
                FILE * stream, 
                IMODEL & model);

typedef void (*FD_MODELDEST)(void ** specs);


typedef int (*FD_TIMEGRID)(PARARRAY * pars, 
               FILE * stream, 
               grid const & g, 
               ireal & dt,
               ireal & rhs);

  typedef int (*FD_STENCIL)(void * specs,
                FILE * stream,
                int ndim, 
                IPNT gtype[RDOM_MAX_NARR], 
                STENCIL * sten);

typedef void (*FD_CHECK)(RDOM * dom,
             void * specs,
             FILE * stream);

typedef void (*FD_LOOPDEF)(int const * gmin,
               int const * gmax,
               float tmax,
               int input,
               FILE * stream,
               void * specs);

/*
  IWAVE field spec struct. Model field structure 
  by static array of these. By convention the reference
  grid corresponds to the first of these fields.
*/

typedef struct s_field {
  std::string field;
  int dynamic;
  int substep;
  IPNT gtype;
} FIELD;

/* modeling task tuple - pertains only to forward 
   model. Couples keywords to rarray indices. Task can define 
   input or output, and can be active (coordinates of point in 
   operator domain) or passive (auxiliary parameters needed in
   simulation 

   i/o harness for simulation spec'd via a static array of these.
   by convention the first element should give the input connection
   for the first model field, and provides the keyword for looking
   up the external data source for the primary model grid.

   BIG CHANGE spring 16: input and active are ints, not bools. Value
   of 0 for active signifies inactive (ie. not part of domain space of
   op). Input=1 and active = 2 signifies linear input (source), which
   is treated as outout for adjoint with deriv=0 - in that case active
   outputs turn into input.
*/
typedef struct s_iokeys {
  std::string keyword;
  int rarrindex;
  int input;
  int active;
} IOKEY;

class IWaveInfo {
public:
  static std::string iwave_model;
  static FIELD iwave_fields[]; 
  static IOKEY iwave_iokeys[];
  static FD_MODELINIT minit;
  static FD_MODELDEST mdest;
  static FD_TIMESTEP timestep;
  static FD_TIMEGRID timegrid;
  static FD_STENCIL createstencil;
  static FD_CHECK check;
  static FD_LOOPDEF loopdef;
  
  // these are redundant relic of previous design, but don't want to chase
  // them down right now - 05.01.14
  std::string get_iwave_model() const { return this->iwave_model; }
  IOKEY * get_iwave_iokeys() const { return &(this->iwave_iokeys[0]); }
  FIELD * get_iwave_fields() const { return &(this->iwave_fields[0]); }
  FD_MODELINIT get_minit() const { return this->minit; }
  FD_MODELDEST get_mdest() const { return this->mdest; }
  FD_TIMEGRID get_timegrid() const { return this->timegrid; }
  FD_TIMESTEP get_timestep() const { return this->timestep; }
  FD_STENCIL get_stencil() const { return this->createstencil;}
  FD_CHECK get_check() const { return this->check; }
  FD_LOOPDEF get_loopdef() const { return this->loopdef; }
  // defined
  int get_num_fields() const;
  int get_num_iokeys() const;
  // legit return values are non-negative - negative return
  // indicates that this keyword is not amongst the basic i/o
  // keywords
  int get_property_iokeys(const std::string keyword,
              const std::string property) const;
  
  ostream & write_iwave_fields(ostream & str) const;
  ostream & write_iwave_iokeys(ostream & str) const;
};

namespace TSOpt {

  using RVL::RVLException;
  using RVL::Writeable;

  /* task component: defines relation between IWAVEs in
     IWaveTreeState, keywords indexing i/o info (filenames), input
     flags, and indices of rarrays in the simulation RDOM.
   */
  typedef struct s_task_reln {
    int iwaveindex;   
    std::string keyword;
    int rarrindex;
    bool input;
  } TASK_RELN;

  /* generates list of task relations defining i/o patterns for
     derivatives of a model. IO represented by a IODefn
     object. Algorithm: for order i, loops over 2^i copies of IO.
     In all cases, passive relations unaltered from basic model - all
     belong in order 0 branch. Forward mode: active inputs in comp 0
     (reference model), 1, 2, 4,...,2^{i-1}, with same access pattern
     as basic model. Keyword in comp 2^k altered by addition of suffix
     _d{k}. Active outputs in comp 2^{i}-1. Adjoint mode: inputs same
     except for comp 2^{i-1}, which becomes output with keyword suffix
     _b{i-1}. All forward ouputs in comp 2^{i-1} become inputs.
  */
    
  void IOTask(std::vector<TASK_RELN *> & tr, int order, bool fwd, IWaveInfo const & ic);

  void IOTaskWriter(std::vector<TASK_RELN *> const & tr, ostream & str);

}

#endif

---