WireCell::Gen::BirksRecombination Class Reference

#include <RecombinationModels.h>

Inheritance diagram for WireCell::Gen::BirksRecombination:

Public Member Functions
	BirksRecombination (double Efield=500 *units::volt/units::cm, double A3t=0.8, double k3t=0.0486 *units::gram/(units::MeV *units::cm2)*(units::kilovolt/units::cm), double rho=1.396 *units::gram/units::cm3, double Wi=23.6 *units::eV/(-1 *units::eplus))
virtual	~BirksRecombination ()
virtual double	operator() (double dE, double dX=0.0)
virtual void	configure (const WireCell::Configuration &config)
	Accept a configuration. More...
virtual WireCell::Configuration	default_configuration () const
	Optional, override to return a hard-coded default configuration. More...
Public Member Functions inherited from WireCell::IRecombinationModel
virtual	~IRecombinationModel ()
Public Member Functions inherited from WireCell::IComponent< IRecombinationModel >
virtual	~IComponent ()
Public Member Functions inherited from WireCell::Interface
virtual	~Interface ()
Public Member Functions inherited from WireCell::IConfigurable
virtual	~IConfigurable ()
Public Member Functions inherited from WireCell::IComponent< IConfigurable >
virtual	~IComponent ()

Private Attributes
double	m_a3t
double	m_k3t
double	m_efield
double	m_rho
double	m_wi

Additional Inherited Members
Public Types inherited from WireCell::IComponent< IRecombinationModel >
typedef std::shared_ptr< IRecombinationModel >	pointer
	Access subclass facet by pointer. More...
typedef std::vector< pointer >	vector
	Vector of shared pointers. More...
Public Types inherited from WireCell::Interface
typedef std::shared_ptr< Interface >	pointer
Public Types inherited from WireCell::IComponent< IConfigurable >
typedef std::shared_ptr< IConfigurable >	pointer
	Access subclass facet by pointer. More...
typedef std::vector< pointer >	vector
	Vector of shared pointers. More...

Detailed Description

Birks model, R = a/(1+b*dE/dX), dQ = (R/Wi)*dE a = A3t, b=k3t/(Efield*rho) as defined in: http://lar.bnl.gov/properties/pass.html#recombination

Definition at line 28 of file RecombinationModels.h.

Constructor & Destructor Documentation

Gen::BirksRecombination::BirksRecombination	(	double	Efield = 500*units::volt/units::cm,
		double	A3t = 0.8,
		double	k3t = 0.0486*units::gram/(units::MeV*units::cm2)*(units::kilovolt/units::cm),
		double	rho = 1.396*units::gram/units::cm3,
		double	Wi = 23.6*units::eV/(-1*units::eplus)
	)

Definition at line 50 of file RecombinationModels.cxx.

    : m_a3t(A3t), m_k3t(k3t), m_efield(Efield), m_rho(rho), m_wi(Wi)
{
}

Gen::BirksRecombination::~BirksRecombination ( )

virtual

Definition at line 54 of file RecombinationModels.cxx.

{
}

Member Function Documentation

void Gen::BirksRecombination::configure ( const WireCell::Configuration &  config )

virtual

Accept a configuration.

Implements WireCell::IConfigurable.

Definition at line 62 of file RecombinationModels.cxx.

{
    m_a3t = get(config, "A3t", m_a3t);
    m_k3t = get(config, "k3t", m_k3t);
    m_efield = get(config, "Efield", m_efield);
    m_rho = get(config, "rho", m_rho);
    m_wi = get(config, "Wi", m_wi);
}

WireCell::Configuration Gen::BirksRecombination::default_configuration ( ) const

virtual

Optional, override to return a hard-coded default configuration.

Reimplemented from WireCell::IConfigurable.

Definition at line 70 of file RecombinationModels.cxx.

{
    Configuration cfg;
    cfg["A3t"] = m_a3t;
    cfg["k3t"] = m_k3t;
    cfg["Efield"] = m_efield;
    cfg["rho"] = m_rho;
    cfg["Wi"] = m_wi;
    return cfg;
}

double Gen::BirksRecombination::operator() ( double  dE, double  dX = 0.0  )

virtual

Implements WireCell::IRecombinationModel.

Definition at line 57 of file RecombinationModels.cxx.

{
    const double R = m_a3t / (1 + (dE/dX)*m_k3t/(m_efield*m_rho));
    return R*dE/m_wi;
}

Member Data Documentation

double WireCell::Gen::BirksRecombination::m_a3t

private

Definition at line 29 of file RecombinationModels.h.

double WireCell::Gen::BirksRecombination::m_efield

private

Definition at line 29 of file RecombinationModels.h.

double WireCell::Gen::BirksRecombination::m_k3t

private

Definition at line 29 of file RecombinationModels.h.

double WireCell::Gen::BirksRecombination::m_rho

private

Definition at line 29 of file RecombinationModels.h.

double WireCell::Gen::BirksRecombination::m_wi

private

Definition at line 29 of file RecombinationModels.h.

---

The documentation for this class was generated from the following files:

• wire-cell-build/gen/inc/WireCellGen/RecombinationModels.h
• wire-cell-build/gen/src/RecombinationModels.cxx