Xyce  6.1
Xyce::Device::ComplexMultiplierRateCalculator Class Reference

#include <N_DEV_RateConstantCalculators.h>

Inheritance diagram for Xyce::Device::ComplexMultiplierRateCalculator:
Collaboration diagram for Xyce::Device::ComplexMultiplierRateCalculator:

Public Member Functions

 ComplexMultiplierRateCalculator (std::vector< Specie > &VariableSpecies, std::vector< Specie > &ConstantSpecies, std::vector< std::pair< int, double > > &Reactants, double C0, double t0, double x0, double multiplier)
 
 ComplexMultiplierRateCalculator (ComplexMultiplierRateCalculator &right)
 
virtual ComplexMultiplierRateCalculatorClone ()
 create a copy of this calculator More...
 
virtual double computeRateConstant (double T)
 return rate constant at given temperature More...
 
virtual double computeRateConstant (double T, std::vector< double > &concs, std::vector< double > &constant_vec)
 
virtual double rateConstantScaleFactor ()
 return current scale factor for rate constant More...
 
virtual void setScaleFactors (double C0, double t0, double x0)
 set concentration, time, and space scale factors (space scale factor is currently unused by any calculator) More...
 
virtual CalcType calcType ()
 return the type of this calculator More...
 
virtual void setBulkMaterial (std::string material)
 
virtual bool isBulkMaterialSet ()
 
- Public Member Functions inherited from Xyce::Device::RateCalculator
 RateCalculator ()
 
 RateCalculator (RateCalculator &right)
 
virtual ~RateCalculator ()
 

Public Attributes

std::string myReactionName
 

Private Attributes

SpecieSpecie1
 
SpecieSpecie2
 
double reaction_distance_factor
 
bool Tdep
 
double rk0
 
bool coulombAttraction
 
double chargeNumberProduct
 
double multiplier
 

Additional Inherited Members

- Protected Attributes inherited from Xyce::Device::RateCalculator
bool bulkMaterialSet
 
std::string bulkMaterial
 

Detailed Description

Definition at line 270 of file N_DEV_RateConstantCalculators.h.

Constructor & Destructor Documentation

Xyce::Device::ComplexMultiplierRateCalculator::ComplexMultiplierRateCalculator ( std::vector< Specie > &  VariableSpecies,
std::vector< Specie > &  ConstantSpecies,
std::vector< std::pair< int, double > > &  Reactants,
double  C0,
double  t0,
double  x0,
double  multiplier 
)

Definition at line 643 of file N_DEV_RateConstantCalculators.C.

Xyce::Device::ComplexMultiplierRateCalculator::ComplexMultiplierRateCalculator ( ComplexMultiplierRateCalculator right)

Definition at line 733 of file N_DEV_RateConstantCalculators.C.

Member Function Documentation

virtual CalcType Xyce::Device::ComplexMultiplierRateCalculator::calcType ( )
inlinevirtual

return the type of this calculator

Implements Xyce::Device::RateCalculator.

Definition at line 286 of file N_DEV_RateConstantCalculators.h.

ComplexMultiplierRateCalculator * Xyce::Device::ComplexMultiplierRateCalculator::Clone ( )
virtual

create a copy of this calculator

Implements Xyce::Device::RateCalculator.

Definition at line 751 of file N_DEV_RateConstantCalculators.C.

double Xyce::Device::ComplexMultiplierRateCalculator::computeRateConstant ( double  T)
virtual

return rate constant at given temperature

Implements Xyce::Device::RateCalculator.

Definition at line 764 of file N_DEV_RateConstantCalculators.C.

double Xyce::Device::ComplexMultiplierRateCalculator::computeRateConstant ( double  T,
std::vector< double > &  concs,
std::vector< double > &  constant_vec 
)
virtual

Implements Xyce::Device::RateCalculator.

Definition at line 784 of file N_DEV_RateConstantCalculators.C.

virtual bool Xyce::Device::ComplexMultiplierRateCalculator::isBulkMaterialSet ( )
inlinevirtual

Implements Xyce::Device::RateCalculator.

Definition at line 288 of file N_DEV_RateConstantCalculators.h.

double Xyce::Device::ComplexMultiplierRateCalculator::rateConstantScaleFactor ( )
virtual

return current scale factor for rate constant

Implements Xyce::Device::RateCalculator.

Definition at line 805 of file N_DEV_RateConstantCalculators.C.

virtual void Xyce::Device::ComplexMultiplierRateCalculator::setBulkMaterial ( std::string  material)
inlinevirtual

Implements Xyce::Device::RateCalculator.

Definition at line 287 of file N_DEV_RateConstantCalculators.h.

virtual void Xyce::Device::ComplexMultiplierRateCalculator::setScaleFactors ( double  C0,
double  t0,
double  x0 
)
inlinevirtual

set concentration, time, and space scale factors (space scale factor is currently unused by any calculator)

Implements Xyce::Device::RateCalculator.

Definition at line 284 of file N_DEV_RateConstantCalculators.h.

Member Data Documentation

double Xyce::Device::ComplexMultiplierRateCalculator::chargeNumberProduct
private

Definition at line 297 of file N_DEV_RateConstantCalculators.h.

bool Xyce::Device::ComplexMultiplierRateCalculator::coulombAttraction
private

Definition at line 296 of file N_DEV_RateConstantCalculators.h.

double Xyce::Device::ComplexMultiplierRateCalculator::multiplier
private

Definition at line 298 of file N_DEV_RateConstantCalculators.h.

std::string Xyce::Device::ComplexMultiplierRateCalculator::myReactionName

Definition at line 288 of file N_DEV_RateConstantCalculators.h.

double Xyce::Device::ComplexMultiplierRateCalculator::reaction_distance_factor
private

Definition at line 293 of file N_DEV_RateConstantCalculators.h.

double Xyce::Device::ComplexMultiplierRateCalculator::rk0
private

Definition at line 295 of file N_DEV_RateConstantCalculators.h.

Specie* Xyce::Device::ComplexMultiplierRateCalculator::Specie1
private

Definition at line 292 of file N_DEV_RateConstantCalculators.h.

Specie * Xyce::Device::ComplexMultiplierRateCalculator::Specie2
private

Definition at line 292 of file N_DEV_RateConstantCalculators.h.

bool Xyce::Device::ComplexMultiplierRateCalculator::Tdep
private

Definition at line 294 of file N_DEV_RateConstantCalculators.h.


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