From 14bf2b1ee22509273618b5406a79cd612d0ed08b Mon Sep 17 00:00:00 2001 From: Harry Moffat Date: Mon, 10 Jan 2011 23:22:19 +0000 Subject: [PATCH] Started putting these files into the standard form. Started eliminating doxygen errors. --- Cantera/src/kinetics/GasKinetics.cpp | 48 ++++++++++++++++++++++++++++ Cantera/src/kinetics/GasKinetics.h | 39 ++++++++-------------- 2 files changed, 61 insertions(+), 26 deletions(-) diff --git a/Cantera/src/kinetics/GasKinetics.cpp b/Cantera/src/kinetics/GasKinetics.cpp index 805ddf598..8e976f096 100644 --- a/Cantera/src/kinetics/GasKinetics.cpp +++ b/Cantera/src/kinetics/GasKinetics.cpp @@ -427,6 +427,54 @@ namespace Cantera { m_rxnstoich->getReactionDelta(m_ii, &m_grt[0], deltaS); } + //==================================================================================================================== + // Return the species net production rates + /* + * Species net production rates [kmol/m^3/s]. Return the species + * net production rates (creation - destruction) in array + * wdot, which must be dimensioned at least as large as the + * total number of species. + * + * @param net Array of species production rates. + * units kmol m-3 s-1 + */ + void GasKinetics::getNetProductionRates(doublereal* net) { + updateROP(); + m_rxnstoich->getNetProductionRates(m_kk, &m_kdata->m_ropnet[0], net); + } + //==================================================================================================================== + // Return the species creation rates + /* + * Species creation rates [kmol/m^3]. Return the species + * creation rates in array cdot, which must be + * dimensioned at least as large as the total number of + * species. + * + * @param cdot Array of species production rates. + * units kmol m-3 s-1 + */ + void GasKinetics::getCreationRates(doublereal* cdot) { + updateROP(); + m_rxnstoich->getCreationRates(m_kk, &m_kdata->m_ropf[0], &m_kdata->m_ropr[0], cdot); + } + //==================================================================================================================== + // Return a vector of the species destruction rates + /* + * Species destruction rates [kmol/m^3]. Return the species + * destruction rates in array ddot, which must be + * dimensioned at least as large as the total number of + * species. + * + * + * @param ddot Array of species destruction rates. + * units kmol m-3 s-1 + * + */ + void GasKinetics::getDestructionRates(doublereal* ddot) { + updateROP(); + m_rxnstoich->getDestructionRates(m_kk, &m_kdata->m_ropf[0], &m_kdata->m_ropr[0], ddot); + } + //==================================================================================================================== void GasKinetics::processFalloffReactions() { int i; diff --git a/Cantera/src/kinetics/GasKinetics.h b/Cantera/src/kinetics/GasKinetics.h index 84fc551af..ce81edd0f 100644 --- a/Cantera/src/kinetics/GasKinetics.h +++ b/Cantera/src/kinetics/GasKinetics.h @@ -273,46 +273,33 @@ namespace Cantera { * @param net Array of species production rates. * units kmol m-3 s-1 */ - virtual void getNetProductionRates(doublereal* net) { - updateROP(); - //#ifdef HWMECH - //get_wdot(&m_kdata->m_ropnet[0], net); - //#else - m_rxnstoich->getNetProductionRates(m_kk, - &m_kdata->m_ropnet[0], net); - //#endif - } + virtual void getNetProductionRates(doublereal* net); - /** + //! Return the species creation rates + /*! * Species creation rates [kmol/m^3]. Return the species * creation rates in array cdot, which must be * dimensioned at least as large as the total number of * species. * + * @param cdot Array of species creation rates. + * units kmol m-3 s-1 */ - virtual void getCreationRates(doublereal* cdot) { - updateROP(); - m_rxnstoich->getCreationRates(m_kk, &m_kdata->m_ropf[0], - &m_kdata->m_ropr[0], cdot); - } + virtual void getCreationRates(doublereal* cdot); - /** + //! Return a vector of the species destruction rates + /*! * Species destruction rates [kmol/m^3]. Return the species * destruction rates in array ddot, which must be * dimensioned at least as large as the total number of * species. * + * + * @param ddot Array of species destruction rates. + * units kmol m-3 s-1 + * */ - virtual void getDestructionRates(doublereal* ddot) { - updateROP(); - m_rxnstoich->getDestructionRates(m_kk, &m_kdata->m_ropf[0], - &m_kdata->m_ropr[0], ddot); - // fill(ddot, ddot + m_kk, 0.0); - //m_revProductStoich.incrementSpecies( - // m_kdata->m_ropr.begin(), ddot); - //m_reactantStoich.incrementSpecies( - // m_kdata->m_ropf.begin(), ddot); - } + virtual void getDestructionRates(doublereal* ddot); //@} /**