Xyce  6.1
Xyce::Device::RateCalculator Class Referenceabstract

Abstract interface class for "rate calculator" strategy pattern. More...

#include <N_DEV_RateConstantCalculators.h>

Inheritance diagram for Xyce::Device::RateCalculator:

Public Member Functions

virtual double computeRateConstant (double T)=0
 return rate constant at given temperature More...
 
virtual double computeRateConstant (double T, std::vector< double > &concs, std::vector< double > &constant_vec)=0
 
virtual double rateConstantScaleFactor ()=0
 return current scale factor for rate constant More...
 
virtual void setScaleFactors (double C0, double t0, double x0)=0
 set concentration, time, and space scale factors (space scale factor is currently unused by any calculator) More...
 
virtual CalcType calcType ()=0
 return the type of this calculator More...
 
 RateCalculator ()
 
 RateCalculator (RateCalculator &right)
 
virtual RateCalculatorClone ()=0
 create a copy of this calculator More...
 
virtual ~RateCalculator ()
 
virtual void setBulkMaterial (std::string material)=0
 
virtual bool isBulkMaterialSet ()=0
 

Protected Attributes

bool bulkMaterialSet
 
std::string bulkMaterial
 

Detailed Description

Abstract interface class for "rate calculator" strategy pattern.

Each reaction in a reaction network has a rate constant calculator associated with it. The interface is defined by the RateCalculator class.

Definition at line 81 of file N_DEV_RateConstantCalculators.h.

Constructor & Destructor Documentation

Xyce::Device::RateCalculator::RateCalculator ( )
inline

Definition at line 89 of file N_DEV_RateConstantCalculators.h.

Xyce::Device::RateCalculator::RateCalculator ( RateCalculator right)
inline

Definition at line 90 of file N_DEV_RateConstantCalculators.h.

virtual Xyce::Device::RateCalculator::~RateCalculator ( )
inlinevirtual

Definition at line 92 of file N_DEV_RateConstantCalculators.h.

Member Function Documentation

virtual void Xyce::Device::RateCalculator::setScaleFactors ( double  C0,
double  t0,
double  x0 
)
pure virtual

Member Data Documentation

std::string Xyce::Device::RateCalculator::bulkMaterial
protected

Definition at line 98 of file N_DEV_RateConstantCalculators.h.

bool Xyce::Device::RateCalculator::bulkMaterialSet
protected

Definition at line 97 of file N_DEV_RateConstantCalculators.h.


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