scamac_internal.h

Go to the documentation of this file.

#ifndef SCAMAC_INTERNAL_H
#define SCAMAC_INTERNAL_H

#include "scamac_inttypes.h"
#include "scamac_error.h"
#include "scamac_defs.h"
#include "scamac_sparserow.h"

typedef struct {
  ScamacIdx nrow; // number of rows
  ScamacIdx ncol; // number of columns
  ScamacIdx maxnzrow; // maximal number of non-zeros per row
  ScamacIdx maxnzcol; // maximal number of non-zeros per column
  ScamacIdx maxnzgen; // maximal number of entries added to sparserow during generation [ maxnzrow,maxnzcol <= maxnzgen]
  ScamacIdx maxnz; // maximal number of non-zeros [maxnz <= min(nrow*maxnzrow, ncol*maxnzcol)]
  int valtype; // SCAMAC_NONE or SCAMAC_VAL_REAL or SCAMAC_VAL_COMPLEX
  int symmetry; // SCAMAC_NONE or SCAMAC_SYMMETRIC or SCAMAC_HERMITIAN
} scamac_info_st;

typedef ScamacErrorCode (*scamac_gen_work_alloc_ft)(const void * par, const void * tab, void ** ws);
typedef ScamacErrorCode (*scamac_gen_work_free_ft)(void * ws);
typedef ScamacErrorCode (*scamac_gen_tables_create_ft)(const void * par, void ** tables, scamac_info_st * info);
typedef ScamacErrorCode (*scamac_gen_tables_destroy_ft)(void * tables);
typedef ScamacErrorCode (*scamac_gen_row_ft)(const void * par, const void * table, void * ws, ScamacIdx irow, ScamacFlag flag, void *row);
typedef ScamacErrorCode (*scamac_gen_check_ft)(const void * par, char ** desc);

typedef ScamacErrorCode (*scamac_gen_unwrap_ft)(const void * wrapped_par, void *par);

typedef ScamacErrorCode (*scamac_gen_coord_ft)(const void * par, const void * table, void * ws, ScamacIdx idx,  double * x, double * y, double * z, int * ilayer, ScamacIdx * iblock);

struct scamac_generator_st {
  char name[SCAMAC_NAME_LENGTH];

  void * par;

  scamac_gen_work_alloc_ft fct_work_alloc;
  scamac_gen_work_free_ft fct_work_free;
  scamac_gen_tables_create_ft fct_tables_create;
  scamac_gen_tables_destroy_ft fct_tables_destroy;
  scamac_gen_row_ft fct_gen_row;
  scamac_gen_check_ft fct_check;

  // for "wrappers"
  bool needs_unwrapping;
  void * wrapped_par;
  scamac_gen_unwrap_ft fct_unwrap_par;
  scamac_gen_check_ft fct_check_wrapped;

  // for coordinates (new feature)
  scamac_gen_coord_ft fct_coord;

  // fully set after "finalize"
  bool needs_finalization;
  void * tables;
  scamac_info_st info;

};

struct scamac_workspace_st {
  scamac_sparserow_real_st * row_real;
  scamac_sparserow_cplx_st * row_cplx;
  scamac_gen_work_free_ft fct_work_free;
  void * ws;
};

// macro for scamac_matrix_***_check routines
#define SCAMAC_DESC_ERR(cond,conddesc)  \
    do { \
      if (cond) { \
        err=SCAMAC_EINPUT; \
        if (desc) {scamac_string_append(&str,conddesc"\n");} \
      } \
    } while (0)
#define SCAMAC_DESC_WARN(cond,conddesc)  \
    do { \
      if (cond) { \
        err=SCAMAC_EWARNING; \
        if (desc) {scamac_string_append(&str,"[WARNING] "conddesc"\n");} \
      } \
    } while (0)

#endif /* SCAMAC_INTERNAL_H */