Skip to content

Commit fed4292

Browse files
committed
add doxygen
1 parent 5ea2a5b commit fed4292

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

src/reactions/reactionsSystems/KineticReactions.hpp

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,23 @@ class KineticReactions
8787
reactionRatesDerivatives );
8888
}
8989

90+
/**
91+
* @brief Compute the reaction rates for a given set of species concentrations and surface area.
92+
* @tparam PARAMS_DATA The type of the parameters data.
93+
* @tparam ARRAY_1D_TO_CONST The type of the array of species concentrations
94+
* @tparam ARRAY_1D_SA The type of the array of surface area.
95+
* @tparam ARRAY_1D The type of the array of reaction rates.
96+
* @tparam ARRAY_2D The type of the array of reaction rates derivatives.
97+
* @param temperature The temperature of the system.
98+
* @param params The parameters data.
99+
* @param speciesConcentration The array of species concentrations.
100+
* @param surfaceArea The array of surface area.
101+
* @param reactionRates The array of reaction rates.
102+
* @param reactionRatesDerivatives The array of reaction rates derivatives.
103+
* @details
104+
* This function computes the reaction rates for a given set of reactions, taking into account
105+
* the surface area of the reactions. If CALCULATE_DERIVATIVES is true, it also computes the derivatives of the reaction rates with respect to the species concentrations.
106+
*/
90107
template< typename PARAMS_DATA,
91108
typename ARRAY_1D_TO_CONST,
92109
typename ARRAY_1D_SA,

0 commit comments

Comments
 (0)