sf_interface.h

Go to the documentation of this file.

// ----------------------------------------------------------------------------
// openCARP is an open cardiac electrophysiology simulator.
//
// Copyright (C) 2020 openCARP project
//
// This program is licensed under the openCARP Academic Public License (APL)
// v1.0: You can use and redistribute it and/or modify it in non-commercial
// academic environments under the terms of APL as published by the openCARP
// project v1.0, or (at your option) any later version. Commercial use requires
// a commercial license (info@opencarp.org).
//
// This program is distributed without any warranty; see the openCARP APL for
// more details.
//
// You should have received a copy of the openCARP APL along with this program
// and can find it online: http://www.opencarp.org/license
// ----------------------------------------------------------------------------
 
#ifndef SF_INTERFACE_H
#define SF_INTERFACE_H
 
#include <map>
 
#include "fem_types.h"
#include "basics.h"
 
#ifndef CARP_PARAMS
#define CARP_PARAMS
#include "openCARP_p.h"
#include "openCARP_d.h"
#endif
 
#include "SF_base.h"
 
namespace opencarp {
 
typedef SF::meshdata<mesh_int_t,mesh_real_t>          sf_mesh;
typedef SF::abstract_vector<SF_int,SF_real>           sf_vec;
typedef SF::abstract_matrix<SF_int,SF_real>           sf_mat;
typedef SF::abstract_linear_solver<SF_int,SF_real>    sf_sol;
 
enum mesh_t {
  intra_elec_msh = 0,
  extra_elec_msh,
  eikonal_msh,
  elasticity_msh,
  fluid_msh,
  reference_msh,
  phie_recv_msh,
  unset_msh,
  num_msh
};
 
// Special gridIDs used in for identifying scatterers
#define ALG_TO_NODAL (num_msh+5)
#define PETSC_TO_CANONICAL (num_msh+6)
#define ELEM_PETSC_TO_CANONICAL (num_msh+7)
 
// The physics. Has to match with opencarp.prm
#define PHYSREG_INTRA_ELEC   0
#define PHYSREG_EXTRA_ELEC   1
#define PHYSREG_EIKONAL      2
#define PHYSREG_MECH         3
#define PHYSREG_FLUID        4
#define PHYSREG_LAPLACE      5
#define PHYSREG_NUM_PHYSICS  6
 
bool phys_defined(int physreg);
int get_phys_index(int physreg);
 
namespace user_globals {
  extern SF::scatter_registry       scatter_reg;
  extern std::map<mesh_t, sf_mesh>  mesh_reg;
  extern std::map<SF::quadruple<int>, SF::index_mapping<mesh_int_t> > map_reg;
}  // namespace user_globals
 
sf_mesh & get_mesh(const mesh_t gt);
 
const char* get_mesh_type_name(mesh_t t);
 
bool mesh_is_registered(const mesh_t gt);
 
SF::scattering*
register_scattering(const int from, const int to, const SF::SF_nbr nbr,
                    const int dpn);
 
inline SF::scattering*
register_scattering(const int from, const int to, const int dpn) {
  return register_scattering(from, to, SF::NBR_PETSC, dpn);
}
 
SF::scattering*
register_permutation(const int mesh_id, const int perm_id, const int dpn);
 
SF::scattering*
get_scattering(const int from, const int to, const SF::SF_nbr nbr, const int dpn);
 
inline SF::scattering*
get_scattering(const int from, const int to, const int dpn) {
  return get_scattering(from, to, SF::NBR_PETSC, dpn);
}
bool have_scattering(const int from, const int to, const SF::SF_nbr nbr, const int dpn);
inline bool have_scattering(const int from, const int to, const int dpn)
{
  return have_scattering(from, to, SF::NBR_PETSC, dpn);
}
bool have_permutation(const int from, const int perm_id, const int dpn);
 
SF::scattering*
get_permutation(const int mesh_id, const int perm_id, const int dpn);
 
}  // namespace opencarp
 
#endif