Xyce  6.1
Xyce::Device::SimpleRateCalculator Class Reference

Class for trivial, constant rate constant (independent of temperature) More...

#include <N_DEV_RateConstantCalculators.h>

Inheritance diagram for Xyce::Device::SimpleRateCalculator:
Collaboration diagram for Xyce::Device::SimpleRateCalculator:

Public Member Functions

 SimpleRateCalculator (double k, double C0, double t0, double x0)
 
 SimpleRateCalculator (SimpleRateCalculator &right)
 
virtual SimpleRateCalculatorClone ()
 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

double K
 
double rk0
 

Additional Inherited Members

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

Detailed Description

Class for trivial, constant rate constant (independent of temperature)

This is the most basic rate calculator that returns a constant value provided in the reaction network input file.

Definition at line 106 of file N_DEV_RateConstantCalculators.h.

Constructor & Destructor Documentation

Xyce::Device::SimpleRateCalculator::SimpleRateCalculator ( double  k,
double  C0,
double  t0,
double  x0 
)

Definition at line 76 of file N_DEV_RateConstantCalculators.C.

Xyce::Device::SimpleRateCalculator::SimpleRateCalculator ( SimpleRateCalculator right)

Definition at line 92 of file N_DEV_RateConstantCalculators.C.

Member Function Documentation

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

return the type of this calculator

Implements Xyce::Device::RateCalculator.

Definition at line 119 of file N_DEV_RateConstantCalculators.h.

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

create a copy of this calculator

Implements Xyce::Device::RateCalculator.

Definition at line 107 of file N_DEV_RateConstantCalculators.C.

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

return rate constant at given temperature

Implements Xyce::Device::RateCalculator.

Definition at line 120 of file N_DEV_RateConstantCalculators.C.

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

Implements Xyce::Device::RateCalculator.

Definition at line 134 of file N_DEV_RateConstantCalculators.C.

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

Implements Xyce::Device::RateCalculator.

Definition at line 121 of file N_DEV_RateConstantCalculators.h.

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

return current scale factor for rate constant

Implements Xyce::Device::RateCalculator.

Definition at line 149 of file N_DEV_RateConstantCalculators.C.

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

Implements Xyce::Device::RateCalculator.

Definition at line 120 of file N_DEV_RateConstantCalculators.h.

virtual void Xyce::Device::SimpleRateCalculator::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 116 of file N_DEV_RateConstantCalculators.h.

Member Data Documentation

double Xyce::Device::SimpleRateCalculator::K
private

Definition at line 125 of file N_DEV_RateConstantCalculators.h.

std::string Xyce::Device::SimpleRateCalculator::myReactionName

Definition at line 121 of file N_DEV_RateConstantCalculators.h.

double Xyce::Device::SimpleRateCalculator::rk0
private

Definition at line 126 of file N_DEV_RateConstantCalculators.h.


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