template<class RateType, class DataType>
class Cantera::StickingRate< RateType, DataType >
A class template for interface sticking rate specifications. 
Definition at line 463 of file InterfaceRate.h.
|  | 
|  | StickingRate (const AnyMap &node, const UnitStack &rate_units) | 
|  | Constructor based on AnyMap content. 
 | 
|  | 
|  | StickingRate (const AnyMap &node) | 
|  | 
| unique_ptr< MultiRateBase > | newMultiRate () const override | 
|  | 
| const string | type () const override | 
|  | Identifier of reaction rate type. 
 | 
|  | 
| void | setRateUnits (const UnitStack &rate_units) override | 
|  | 
| void | setParameters (const AnyMap &node, const UnitStack &rate_units) override | 
|  | 
| void | getParameters (AnyMap &node) const override | 
|  | 
| void | setContext (const Reaction &rxn, const Kinetics &kin) override | 
|  | 
| void | validate (const string &equation, const Kinetics &kin) override | 
|  | 
| void | updateFromStruct (const DataType &shared_data) | 
|  | Update reaction rate parameters. 
 | 
|  | 
| double | evalFromStruct (const DataType &shared_data) const | 
|  | Evaluate reaction rate. 
 | 
|  | 
| double | ddTScaledFromStruct (const DataType &shared_data) const | 
|  | Evaluate derivative of reaction rate with respect to temperature divided by reaction rate. 
 | 
|  | 
| double | preExponentialFactor () const override | 
|  | 
| double | activationEnergy () const override | 
|  | 
| void | setStickingParameters (const AnyMap &node) | 
|  | Perform object setup based on AnyMap node information. 
 | 
|  | 
| void | getStickingParameters (AnyMap &node) const | 
|  | Store parameters needed to reconstruct an identical object. 
 | 
|  | 
| bool | motzWiseCorrection () const | 
|  | Get flag indicating whether sticking rate uses the correction factor developed by Motz & Wise for reactions with high (near-unity) sticking coefficients. 
 | 
|  | 
| void | setMotzWiseCorrection (bool motz_wise) | 
|  | Set flag for Motz & Wise correction factor. 
 | 
|  | 
| string | stickingSpecies () const | 
|  | Get sticking species. 
 | 
|  | 
| void | setStickingSpecies (const string &stickingSpecies) | 
|  | Set sticking species. 
 | 
|  | 
| double | stickingOrder () | 
|  | Get exponent applied to site density (sticking order) 
 | 
|  | 
| void | setStickingOrder (double order) | 
|  | Set exponent applied to site density (sticking order) 
 | 
|  | 
| double | stickingWeight () | 
|  | Get the molecular weight of the sticking species. 
 | 
|  | 
| void | setStickingWeight (double weight) | 
|  | Set the molecular weight of the sticking species. 
 | 
|  | 
| void | setContext (const Reaction &rxn, const Kinetics &kin) | 
|  | Build rate-specific parameters based on Reaction and Kinetics context. 
 | 
|  | 
| void | setParameters (const AnyMap &node) | 
|  | Perform object setup based on AnyMap node information. 
 | 
|  | 
| void | getParameters (AnyMap &node) const | 
|  | Store parameters needed to reconstruct an identical object. 
 | 
|  | 
| void | setCoverageDependencies (const AnyMap &dependencies, const UnitSystem &units=UnitSystem()) | 
|  | Set coverage dependencies based on AnyMap node information. 
 | 
|  | 
| void | getCoverageDependencies (AnyMap &dependencies) const | 
|  | Store parameters needed to reconstruct coverage dependencies. 
 | 
|  | 
| virtual void | addCoverageDependence (const string &sp, double a, double m, const vector< double > &e) | 
|  | Add a coverage dependency for species sp, with exponential dependence a, power-law exponent m, and activation energy dependence e, where e is in Kelvin, that is, energy divided by the molar gas constant. 
 | 
|  | 
| bool | exchangeCurrentDensityFormulation () | 
|  | Boolean indicating whether rate uses exchange current density formulation. 
 | 
|  | 
| void | setContext (const Reaction &rxn, const Kinetics &kin) | 
|  | Build rate-specific parameters based on Reaction and Kinetics context. 
 | 
|  | 
| void | setSpecies (const vector< string > &species) | 
|  | Set association with an ordered list of all species associated with a given Kineticsobject.
 | 
|  | 
| void | updateFromStruct (const InterfaceData &shared_data) | 
|  | Update reaction rate parameters. 
 | 
|  | 
| double | voltageCorrection () const | 
|  | Calculate modifications for the forward reaction rate for interfacial charge transfer reactions. 
 | 
|  | 
| bool | usesElectrochemistry () | 
|  | Boolean indicating whether rate uses electrochemistry. 
 | 
|  | 
| double | beta () const | 
|  | Return the charge transfer beta parameter. 
 | 
|  | 
| double | siteDensity () const | 
|  | Return site density [kmol/m^2]. 
 | 
|  | 
| void | setSiteDensity (double siteDensity) | 
|  | Set site density [kmol/m^2]. 
 | 
|  | 
|  | 
| bool | m_motzWise | 
|  | boolean indicating whether Motz & Wise correction is used 
 | 
|  | 
| bool | m_explicitMotzWise | 
|  | Correction cannot be overriden by default. 
 | 
|  | 
| string | m_stickingSpecies | 
|  | string identifying sticking species 
 | 
|  | 
| bool | m_explicitSpecies | 
|  | Boolean flag. 
 | 
|  | 
| double | m_surfaceOrder | 
|  | exponent applied to site density term 
 | 
|  | 
| double | m_multiplier | 
|  | multiplicative factor in rate expression 
 | 
|  | 
| double | m_factor | 
|  | cached factor 
 | 
|  | 
| double | m_siteDensity | 
|  | Site density [kmol/m^2]. 
 | 
|  | 
| double | m_acov | 
|  | Coverage contribution to pre-exponential factor. 
 | 
|  | 
| double | m_ecov | 
|  | Coverage contribution to activation energy. 
 | 
|  | 
| double | m_mcov | 
|  | Coverage term in reaction rate. 
 | 
|  | 
| bool | m_chargeTransfer | 
|  | Boolean indicating use of electrochemistry. 
 | 
|  | 
| bool | m_exchangeCurrentDensityFormulation | 
|  | 
| double | m_beta | 
|  | Electrochemistry only. 
 | 
|  | 
| double | m_deltaPotential_RT | 
|  | Normalized electric potential energy change. 
 | 
|  | 
| double | m_deltaGibbs0_RT | 
|  | Normalized standard state Gibbs free energy change. 
 | 
|  | 
| double | m_prodStandardConcentrations | 
|  | Products of standard concentrations. 
 | 
|  | 
| map< size_t, size_t > | m_indices | 
|  | Map from coverage dependencies stored in this object to the index of the coverage species in the Kinetics object. 
 | 
|  | 
| vector< string > | m_cov | 
|  | Vector holding names of coverage species. 
 | 
|  | 
| vector< double > | m_ac | 
|  | Vector holding coverage-specific exponential dependence. 
 | 
|  | 
| vector< vector< double > > | m_ec | 
|  | Vector holding coverage-specific activation energy dependence as a 5-membered array of polynomial coefficients starting from 0th-order to 4th-order coefficients. 
 | 
|  | 
| vector< bool > | m_lindep | 
|  | Vector holding boolean for linear dependence. 
 | 
|  | 
| vector< double > | m_mc | 
|  | Vector holding coverage-specific power-law exponents. 
 | 
|  |