Skip to content

Commit 0d7039f

Browse files
committed
add doxygen
1 parent 65f15b3 commit 0d7039f

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

src/reactions/unitTestUtilities/kineticReactionsTestUtilities.hpp

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -124,11 +124,21 @@ void computeReactionRatesTest( PARAMS_DATA const & params,
124124

125125

126126
//******************************************************************************
127+
128+
/**
129+
* POD struct for transferring data between host and device for computeSpeciesRatesTest.
130+
* @tparam numSpecies Number of species.
131+
*/
127132
template< int numSpecies >
128133
struct ComputeSpeciesRatesTestData
129134
{
135+
/// The species concentrations
130136
double speciesConcentration[numSpecies];
137+
138+
/// The species rates
131139
double speciesRates[numSpecies] = { 0.0 };
140+
141+
/// The species rates derivatives
132142
CArrayWrapper< double, numSpecies, numSpecies > speciesRatesDerivatives;
133143
};
134144

@@ -195,10 +205,18 @@ void computeSpeciesRatesTest( PARAMS_DATA const & params,
195205
}
196206

197207
//******************************************************************************
208+
209+
/**
210+
* POD struct for transferring data between host and device for timeStepTest.
211+
* @tparam numSpecies Number of species.
212+
*/
198213
template< int numSpecies >
199214
struct TimeStepTestData
200215
{
216+
/// The species concentrations
201217
double speciesConcentration[numSpecies];
218+
219+
/// The current time
202220
double time = 0.0;
203221
};
204222

0 commit comments

Comments
 (0)