forwards.h

Go to the documentation of this file.

#ifndef VIENNASHE_FORWARDS_H
#define VIENNASHE_FORWARDS_H
 
/* ============================================================================
   Copyright (c) 2011-2022, Institute for Microelectronics,
                            Institute for Analysis and Scientific Computing,
                            TU Wien.
 
                            -----------------
     ViennaSHE - The Vienna Spherical Harmonics Expansion Boltzmann Solver
                            -----------------
 
                    http://viennashe.sourceforge.net/
 
   License:         MIT (X11), see file LICENSE in the base directory
=============================================================================== */
 
#include <stdexcept>
 
#include <ostream>
#include <cstddef>
#include <string>
#include <map>
 
#include "viennashe/version.hpp"
 
#include "viennagrid/forwards.hpp"
 
 
//
//  Section 1: Set up keys for ViennaData:
//
 
namespace viennashe
{
  namespace detail
  {
    template <typename MeshT, typename CellTag = typename viennagrid::result_of::cell_tag<MeshT>::type>
    struct is_1d_mesh
    {
      enum { value = false };
    };
 
    template <typename MeshT>
    struct is_1d_mesh<MeshT, viennagrid::simplex_tag<1> >
    {
      enum { value = true };
    };
 
    template <typename MeshT>
    struct is_1d_mesh<MeshT, viennagrid::hypercube_tag<1> >
    {
      enum { value = true };
    };
  }
 
  template <typename T>
  struct error_indicator {};
 
 
  template <typename MeshT,
            bool edges_and_cells_different = detail::is_1d_mesh<MeshT>::value >
  class device;
 
  template <typename DeviceType>
  class simulator;
 
 
  typedef std::map<std::string, std::pair<std::size_t, std::size_t> >    map_info_type;
 
 
  enum equation_id
  {
    EQUATION_INVALID = 0,
    EQUATION_POISSON_DD,
    EQUATION_CONTINUITY,
    EQUATION_SHE,
    EQUATION_DENSITY_GRADIENT,
    EQUATION_POISSON_HEAT
  };
 
  enum boundary_type_id
  {
    BOUNDARY_NONE = 0,
    BOUNDARY_DIRICHLET,      //     u = beta
    BOUNDARY_NEUMANN,        // du/dn = beta
    BOUNDARY_ROBIN,           // du/dn = beta - alpha * u
    BOUNDARY_GENERATION_RECOMBINATION // for SHE
  };
 
  enum material_category_id
  {
    MATERIAL_CONDUCTOR_ID,
    MATERIAL_NO_CONDUCTOR_ID,
    MATERIAL_SEMICONDUCTOR_ID,
    MATERIAL_NO_SEMICONDUCTOR_ID,
    MATERIAL_INSULATOR_ID,
    MATERIAL_NO_INSULATOR_ID
  };
 
  enum she_discretization_type_id
  {
    SHE_DISCRETIZATION_EVEN_ODD_ORDER_DF,
    SHE_DISCRETIZATION_EVEN_ODD_ORDER_GENERALIZED_DF
  };
 
  enum she_scaling_type_id
  {
    SHE_SCALING_KINETIC_ENERGY,
    SHE_SCALING_TOTAL_ENERGY
  };
 
  namespace math
  {
    enum harmonics_iteration_type
    {
      ALL_HARMONICS_ITERATION_ID = 0,
      EVEN_HARMONICS_ITERATION_ID,
      ODD_HARMONICS_ITERATION_ID
    };
  }
 
  //
  // Box-integration related. Keys used for storing box integration information on the mesh, cf. ViennaGrid manual.
  //
  struct box_volume_key {};            //box volume associated with an edge or vertex
 
  struct edge_interface_area_key {};   //box volume associated with an edge
 
 
  // Other ViennaSHE forward declarations:
  typedef std::vector<double>                   energy_vector_type;
 
  typedef std::vector<long>                     she_index_vector_type;
 
  enum carrier_type_id
  {
    INVALID_TYPE = 0,
    ELECTRON_TYPE_ID,
    HOLE_TYPE_ID
  };
 
  enum doping_type_id
  {
    INVALID_DOPING_TYPE = 0,
    DONATOR_DOPING_TYPE_ID,
    ACCEPTOR_DOPING_TYPE_ID
  };
 
  // Solver tags:
  namespace solvers
  {
    class dense_linear_solver_tag {};
 
    class serial_linear_solver_tag {};
 
    class parallel_linear_solver_tag {};
 
    class petsc_linear_solver_tag {};
 
    class petsc_amgx_solver_tag {};
    class gpu_parallel_linear_solver_tag {};
 
  }
}
 
 
#endif