coupled_scattering_matrix.h

#ifndef COUPLED_SCATTERING_MATRIX_H
#define COUPLED_SCATTERING_MATRIX_H
 
#include "electron_h0_wannier.h"
#include "phonon_h0.h"
#include "base_el_scattering_matrix.h"
#include "base_ph_scattering_matrix.h"
#include "coupled_vector_bte.h"
 
class CoupledScatteringMatrix : virtual public BaseElScatteringMatrix,
                                virtual public BasePhScatteringMatrix {
 
 public:
 
// TODO update all these comments
 
 CoupledScatteringMatrix(Context &context_, StatisticsSweep &statisticsSweep_,
                    BaseBandStructure &innerBandStructure_,
                    BaseBandStructure &outerBandStructure_,
                    ElectronH0Wannier *electronH0_ = nullptr,
                    PhononH0 *phononH0_ = nullptr);
 
  // TODO we will need to override the simple scattering matrix version of this function
  // as this one will need to behave differently than the others.
  // we may want to output each kind of linewidths, etc, for testing?
  //void outputToJSON(const std::string &outFileName);
 
 // TODO check on the functions that symmetrize this matrix's components
 
  BaseBandStructure* getPhBandStructure();
  BaseBandStructure* getElBandStructure();
 
 protected:
 
  ElectronH0Wannier *electronH0;
  PhononH0 *phononH0;
 
  //int numElStates;
  int numPhStates;
 
  void phononOnlyA2Omega();
 
// TODO can we remove entirely this linewidth thing? it's inconvenient
  // implementation of the scattering matrix
  void builder(std::shared_ptr<VectorBTE> linewidth,
               std::vector<VectorBTE> &inPopulations,
               std::vector<VectorBTE> &outPopulations);
 
  int bteStateToWavevector(BteIndex& iMat, BaseBandStructure& bandStructure);
 
  std::vector<std::vector<std::tuple<std::vector<int>, int>>>
  getIteratorWavevectorPairs(const bool &rowMajor = 0);
 
  //void reweightQuadrants();
 
  // friend functions for adding scattering rates
  // see respective header files for more details
  friend void addPhPhScattering(BasePhScatteringMatrix &matrix, Context &context,
                  std::vector<VectorBTE> &inPopulations,
                  std::vector<VectorBTE> &outPopulations,
                  std::vector<std::tuple<std::vector<int>, int>> qPairIterator,
                  Eigen::MatrixXd &innerBose, Eigen::MatrixXd &outerBose,
                  BaseBandStructure &innerBandStructure,
                  BaseBandStructure &outerBandStructure,
                  PhononH0* phononH0,
                  Interaction3Ph &coupling3Ph,
                  VectorBTE *linewidth);
 
  friend void addIsotopeScattering(BasePhScatteringMatrix &matrix, Context &context,
                  std::vector<VectorBTE> &inPopulations,
                  std::vector<VectorBTE> &outPopulations, 
                  std::vector<std::tuple<std::vector<int>, int>> qPairIterator,
                  Eigen::MatrixXd &innerBose, Eigen::MatrixXd &outerBose,
                  BaseBandStructure &innerBandStructure,
                  BaseBandStructure &outerBandStructure,
                  VectorBTE *linewidth);
 
  friend void addPhElScattering(BasePhScatteringMatrix &matrix, Context &context,
                    std::vector<VectorBTE> &inPopulations,
                    std::vector<VectorBTE> &outPopulations,
                    BaseBandStructure &phBandStructure,
                    BaseBandStructure &elBandStructure,
                    StatisticsSweep& statisticsSweep, 
                    InteractionElPhWan &couplingElPhWan,
                    std::shared_ptr<VectorBTE> linewidth);
 
  friend void addElPhScattering(BaseElScatteringMatrix &matrix, Context &context,
                  std::vector<VectorBTE> &inPopulations,
                  std::vector<VectorBTE> &outPopulations,
                  std::vector<std::tuple<std::vector<int>, int>> kPairIterator,
                  Eigen::MatrixXd &innerFermi, Eigen::MatrixXd &outerBose,
                  BaseBandStructure &innerBandStructure,
                  BaseBandStructure &outerBandStructure,
                  PhononH0 &phononH0,
                  InteractionElPhWan &couplingElPhWan,
                  VectorBTE *linewidth);
 
  friend void addChargedImpurityScattering(BaseElScatteringMatrix &matrix, Context &context,
                  std::vector<VectorBTE> &inPopulations,
                  std::vector<VectorBTE> &outPopulations,
                  std::vector<std::tuple<std::vector<int>, int>> kPairIterator,
                  BaseBandStructure &innerBandStructure,
                  BaseBandStructure &outerBandStructure,
                  std::shared_ptr<VectorBTE> linewidth);
 
  friend void addDragTerm(CoupledScatteringMatrix &matrix, Context &context,
                  std::vector<std::tuple<std::vector<int>, int>> kqPairIterator,
                  const int& dragTermType,
                  InteractionElPhWan &couplingElPhWan,
                  BaseBandStructure &innerBandStructure,
                  BaseBandStructure &outerBandStructure);
 
  friend void phononElectronAcousticSumRule(CoupledScatteringMatrix &matrix,
                  Context& context,
                  BaseBandStructure& elBandStructure,
                  BaseBandStructure& phBandStructure);              
};
 
#endif