MJVWaveformCrystal.hh

Go to the documentation of this file.

//---------------------------------------------------------------------------//
//bb0nubb0nubb0nubb0nubb0nubb0nubb0nubb0nubb0nubb0nubb0nubb0nubb0nubb0nubb0nu//
//                                                                           //
//                         MAJORANA Simulation                               //
//                                                                           //
//      This code implementation is the intellectual property of the         //
//      MAJORANA Collaboration. It is based on Geant4, an intellectual       //
//      property of the RD44 GEANT4 collaboration.                           //
//                                                                           //
//                        *********************                              //
//                                                                           //
//    Neither the authors of this software system, nor their employing       //
//    institutes, nor the agencies providing financial support for this      //
//    work  make  any representation or  warranty, express or implied,       //
//    regarding this software system or assume any liability for its use.    //
//    By copying, distributing or modifying the Program (or any work based   //
//    on on the Program) you indicate your acceptance of this statement,     //
//    and all its terms.                                                     //
//                                                                           //
//bb0nubb0nubb0nubb0nubb0nubb0nubb0nubb0nubb0nubb0nubb0nubb0nubb0nubb0nubb0nu//
//---------------------------------------------------------------------------//
// Begin description of class here
// End class description
//
// 
// --------------------------------------------------------------------------//
// --------------------------------------------------------------------------//

#ifndef _MJVWAVEFORMCRYSTAL_HH
#define _MJVWAVEFORMCRYSTAL_HH

//---------------------------------------------------------------------------//

// CLHEP stuff.
#include <CLHEP/Units/SystemOfUnits.h>
#include <CLHEP/Vector/ThreeVector.h>

//---------------------------------------------------------------------------//
class MJWaveformChargePoint;
class MJVWaveformSegment;

class MJVWaveformCrystal
{
public:

  //default constructor
  MJVWaveformCrystal();

  //copy constructor
  MJVWaveformCrystal(const MJVWaveformCrystal &);

  //destructor
  virtual ~MJVWaveformCrystal();

  //public interface
  void AddChargePoint(MJWaveformChargePoint *chgpt);

  // The following virtual methods are to be overridden in more detailed 
  // simulations. They only include the most basic physics.

  virtual void Construct() = 0;
  virtual HepDouble   ConvertEnergyLossToCharge(HepDouble eloss);

  virtual Hep3Vector ConvertGridpointToCoordinate(HepInt *location) = 0;
  virtual void ConvertCoordinateToGridpoint(const Hep3Vector *coord, 
                                            HepInt *loc) = 0;

  virtual void GenerateSignal();

  virtual void GetDriftFieldVector(const Hep3Vector *pos,Hep3Vector *efield)=0;

  virtual HepDouble  GetInitialGridPointSigma();

  virtual Hep3Vector GetHoleVelocity(const Hep3Vector *position);

  virtual Hep3Vector GetElectronVelocity(const Hep3Vector *position);

  virtual HepBoolean InDeadLayer(const Hep3Vector *position) { return false; }

  void ResetAllSegmentWaveforms();

  virtual void SetConstants(void);

  virtual HepBoolean OutsideCrystal(Hep3Vector *pos) { return false; }
  
  // Setters, getters.

  HepBoolean           DiffusionOn() { return fDiffusionOn; }
  HepDouble            GetBiasVoltage() { return fBiasVoltage; }
  HepDouble            GetDielectricConstant() { return fDielectricConstant; }
  virtual HepDouble    GetDielectricConstant(Hep3Vector *pos) 
                       { return fDielectricConstant; }
  HepDouble            GetDiffusionConstant() { return fDiffusionConstant; }
  virtual HepDouble    GetDiffusionConstant(Hep3Vector *pos) 
                       { return fDiffusionConstant; }
  HepInt               GetDiffusionStepInterval() 
                       { return fDiffusionStepInterval; }
  MJVWaveformSegment   *GetFirstSegment() {return fFirstSegment; }
  HepDouble            GetGridPointSize() { return fGridPointSize; }
  MJVWaveformCrystal   *GetNextCrystal() { return fNextCrystal; }
  MJVWaveformCrystal   *GetPreviousCrystal() { return fPreviousCrystal; }
  HepDouble            GetSpaceChargeDensity() { return fSpaceChargeDensity; }
  virtual HepDouble    GetSpaceChargeDensity(Hep3Vector *pos) 
                       { return fSpaceChargeDensity; }
  HepDouble            GetTimeStep() { return fTimeStep; }
  HepInt               GetTrappingStepInterval(){return fTrappingStepInterval;}
  void                 SetBiasVoltage(HepDouble voltage) 
                       { fBiasVoltage = voltage; }
  void                 SetGridPointSize(HepDouble sz) { fGridPointSize = sz; }
  void                 SetNextCrystal(MJVWaveformCrystal *xtal)
                       { fNextCrystal = xtal; }
  void                 SetPreviousCrystal(MJVWaveformCrystal *xtal)
                       { fPreviousCrystal = xtal;}
  HepBoolean           TrappingOn() { return fTrappingOn; }

  //protected members
protected:

  void AddSegment(MJVWaveformSegment *seg);
  void DeleteChargePoints();

  //private  members
private:

  HepDouble                 fDielectricConstant;
  HepDouble                 fDiffusionConstant;
  HepBoolean                fDiffusionOn;
  HepInt                    fDiffusionStepInterval;
  HepDouble                 fGridPointSize;
  HepDouble                 fSpaceChargeDensity;
  HepDouble                 fTimeStep;
  HepInt                    fTrappingStepInterval;
  HepBoolean                fTrappingOn;
  HepDouble                 fBiasVoltage;

  // Pointers to linked list of charge points in crystal.
  MJWaveformChargePoint      *fFirstChargePoint;
  MJWaveformChargePoint      *fLastChargePoint;
  HepInt                     fNumberOfChargePoints;

  // Pointers to linked list of active charge points in crystal.
  MJWaveformChargePoint      *fFirstActiveChargePoint;
  MJWaveformChargePoint      *fLastActiveChargePoint;

  // Pointers to linked list of segment objects in crystal.
  MJVWaveformSegment         *fFirstSegment;
  MJVWaveformSegment         *fLastSegment;
  HepInt                     fNumberOfSegments;

  // Pointers to previous and next crystal in the linked list of crystals
  // processed during waveform simulations
  MJVWaveformCrystal   *fNextCrystal;
  MJVWaveformCrystal   *fPreviousCrystal;

  // Basic Physical Constants. Can be replaced in derived class.  
  HepDouble kmu_0_e;    // mu_0 (mobility) for electrons
  HepDouble kmu_0_h;    // mu_0 (mobility) for holes
  HepDouble kbeta_e;    // beta factor for electrons.
  HepDouble kbeta_h;    // beta factor for holes.
  HepDouble keps_0_e;   // epsilon_0 for electrons.
  HepDouble keps_0_h;   // epsilon_0 for holes.

  void DeleteSegments();

};

#endif

---