Skip to content

Commit 1c005f9

Browse files
anthony-walkeranthony-walker
committed
More doxygen fixes
1 parent b4fac3a commit 1c005f9

File tree

3 files changed

+95
-82
lines changed

3 files changed

+95
-82
lines changed

‎include/cantera/zeroD/FlowDevice.h

Lines changed: 31 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -115,40 +115,47 @@ class FlowDevice
115115
m_time = time;
116116
}
117117

118-
/*! Build the Jacobian terms specific to the flow device for the given connected reactor.
119-
* @param r a pointer to the calling reactor
120-
* @param jacVector a vector of triplets to be added to the jacobian for the reactor
121-
* @warning This function is an experimental part of the %Cantera API and may be changed
122-
* or removed without notice.
123-
* @since New in %Cantera 3.0.
124-
*/
118+
//! Build the Jacobian terms specific to the flow device for the given connected
119+
//! reactor.
120+
//! @param r a pointer to the calling reactor
121+
//! @param jacVector a vector of triplets to be added to the jacobian for the
122+
//! reactor
123+
//! @warning This function is an experimental part of the %Cantera API and may be
124+
//! changed
125+
//! or removed without notice.
126+
//! @since New in %Cantera 3.0.
127+
//!
125128
virtual void buildReactorJacobian(ReactorBase* r, vector<Eigen::Triplet<double>>& jacVector) {
126129
throw NotImplementedError(type() + "::buildReactorJacobian");
127130
}
128131

129-
/*! Build the Jacobian terms specific to the flow device for the network. These terms
130-
* will be adjusted to the networks indexing system outside of the reactor.
131-
* @param jacVector a vector of triplets to be added to the jacobian for the reactor
132-
* @warning This function is an experimental part of the %Cantera API and may be changed
133-
* or removed without notice.
134-
* @since New in %Cantera 3.0.
135-
*/
132+
//! Build the Jacobian terms specific to the flow device for the network. These
133+
//! terms
134+
//! will be adjusted to the networks indexing system outside of the reactor.
135+
//! @param jacVector a vector of triplets to be added to the jacobian for the
136+
//! reactor
137+
//! @warning This function is an experimental part of the %Cantera API and may be
138+
//! changed
139+
//! or removed without notice.
140+
//! @since New in %Cantera 3.0.
141+
//!
136142
virtual void buildNetworkJacobian(vector<Eigen::Triplet<double>>& jacVector) {
137143
throw NotImplementedError(type() + "::buildNetworkJacobian");
138144
}
139145

140-
/*! Specify the jacobian terms have been calculated and should not be recalculated.
141-
* @warning This function is an experimental part of the %Cantera API and may be changed
142-
* or removed without notice.
143-
* @since New in %Cantera 3.0.
144-
*/
146+
//! Specify the jacobian terms have been calculated and should not be recalculated.
147+
//! @warning This function is an experimental part of the %Cantera API and may be
148+
//! changed
149+
//! or removed without notice.
150+
//! @since New in %Cantera 3.0.
151+
//!
145152
void jacobianCalculated() { m_jac_calculated = true; };
146153

147-
/*! Specify that jacobian terms have not been calculated and should be recalculated.
148-
* @warning This function is an experimental part of the %Cantera API and may be changed
149-
* or removed without notice.
150-
* @since New in %Cantera 3.0.
151-
*/
154+
//! Specify that jacobian terms have not been calculated and should be recalculated.
155+
//! @warning This function is an experimental part of the %Cantera API and may be changed
156+
//! or removed without notice.
157+
//! @since New in %Cantera 3.0.
158+
//!
152159
void jacobianNotCalculated() { m_jac_calculated = false; };
153160

154161
protected:

‎include/cantera/zeroD/ReactorBase.h

Lines changed: 32 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -248,48 +248,50 @@ class ReactorBase
248248
//! Set the ReactorNet that this reactor belongs to.
249249
void setNetwork(ReactorNet* net);
250250

251-
/*! Calculate the derivative of temperature with respect to the temperature in the
252-
* heat transfer equation based on the reactor specific equation of state.
253-
* This function should also transform the state of the derivative to that
254-
* appropriate for the jacobian's state/
255-
* @warning This function is an experimental part of the %Cantera API and may be changed
256-
* or removed without notice.
257-
* @since New in %Cantera 3.0.
258-
*/
251+
//! Calculate the derivative of temperature with respect to the temperature in the
252+
//! heat transfer equation based on the reactor specific equation of state.
253+
//! This function should also transform the state of the derivative to that
254+
//! appropriate for the jacobian's state/
255+
//! @warning This function is an experimental part of the %Cantera API and may be changed
256+
//! or removed without notice.
257+
//! @since New in %Cantera 3.0.
258+
//!
259259
virtual double temperatureDerivative() {
260260
throw NotImplementedError("Reactor::temperatureDerivative");
261261
}
262262

263-
/*! Calculate the derivative of temperature with respect to the temperature in the
264-
* heat transfer radiation equation based on the reactor specific equation of state.
265-
* This function should also transform the state of the derivative to that
266-
* appropriate for the jacobian's state/
267-
* @warning This function is an experimental part of the %Cantera API and may be changed
268-
* or removed without notice.
269-
* @since New in %Cantera 3.0.
270-
*/
263+
//! Calculate the derivative of temperature with respect to the temperature in the
264+
//! heat transfer radiation equation based on the reactor specific equation of
265+
//! state.
266+
//! This function should also transform the state of the derivative to that
267+
//! appropriate for the jacobian's state/
268+
//! @warning This function is an experimental part of the %Cantera API and may be
269+
//! changed
270+
//! or removed without notice.
271+
//! @since New in %Cantera 3.0.
272+
//!
271273
virtual double temperatureRadiationDerivative() {
272274
throw NotImplementedError("Reactor::temperatureRadiationDerivative");
273275
}
274276

275-
/*! Calculate the derivative of T with respect to the ith species in the heat
276-
* transfer equation based on the reactor specific equation of state.
277-
* @param index index of the species the derivative is with respect too
278-
* @warning This function is an experimental part of the %Cantera API and may be changed
279-
* or removed without notice.
280-
* @since New in %Cantera 3.0.
281-
*/
277+
//! Calculate the derivative of T with respect to the ith species in the heat
278+
//! transfer equation based on the reactor specific equation of state.
279+
//! @param index index of the species the derivative is with respect too
280+
//! @warning This function is an experimental part of the %Cantera API and may be changed
281+
//! or removed without notice.
282+
//! @since New in %Cantera 3.0.
283+
//!
282284
virtual double moleDerivative(size_t index) {
283285
throw NotImplementedError("Reactor::moleDerivative");
284286
}
285287

286-
/*! Calculate the derivative of T with respect to the ith species in the heat
287-
* transfer radiation equation based on the reactor specific equation of state.
288-
* @param index index of the species the derivative is with respect too
289-
* @warning This function is an experimental part of the %Cantera API and may be changed
290-
* or removed without notice.
291-
* @since New in %Cantera 3.0.
292-
*/
288+
//! Calculate the derivative of T with respect to the ith species in the heat
289+
//! transfer radiation equation based on the reactor specific equation of state.
290+
//! @param index index of the species the derivative is with respect too
291+
//! @warning This function is an experimental part of the %Cantera API and may be changed
292+
//! or removed without notice.
293+
//! @since New in %Cantera 3.0.
294+
//!
293295
virtual double moleRadiationDerivative(size_t index) {
294296
throw NotImplementedError("Reactor::moleRadiationDerivative");
295297
}

‎include/cantera/zeroD/Wall.h

Lines changed: 32 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -116,44 +116,48 @@ class WallBase
116116
m_time = time;
117117
}
118118

119-
/*! Build the Jacobian terms specific to the flow device for the given connected reactor.
120-
* @param r a pointer to the calling reactor
121-
* @param jacVector a vector of triplets to be added to the jacobian for the reactor
122-
* @warning This function is an experimental part of the %Cantera API and may be
123-
* changed
124-
* or removed without notice.
125-
* @since New in %Cantera 3.0.
126-
*/
119+
//! Build the Jacobian terms specific to the flow device for the given connected
120+
//! reactor.
121+
//! @param r a pointer to the calling reactor
122+
//! @param jacVector a vector of triplets to be added to the jacobian for the
123+
//! reactor
124+
//! @warning This function is an experimental part of the %Cantera API and may be
125+
//! changed
126+
//! or removed without notice.
127+
//! @since New in %Cantera 3.0.
128+
//!
127129
virtual void buildReactorJacobian(ReactorBase* r, vector<Eigen::Triplet<double>>& jacVector) {
128130
throw NotImplementedError("WallBase::buildReactorJacobian");
129131
}
130132

131-
/*! Build the Jacobian terms specific to the flow device for the network. These terms
132-
* will be adjusted to the networks indexing system outside of the reactor.
133-
* @param jacVector a vector of triplets to be added to the jacobian for the reactor
134-
* @warning This function is an experimental part of the %Cantera API and may be
135-
* changed
136-
* or removed without notice.
137-
* @since New in %Cantera 3.0.
138-
*/
133+
//! Build the Jacobian terms specific to the flow device for the network. These
134+
//! terms
135+
//! will be adjusted to the networks indexing system outside of the reactor.
136+
//! @param jacVector a vector of triplets to be added to the jacobian for the
137+
//! reactor
138+
//! @warning This function is an experimental part of the %Cantera API and may be
139+
//! changed
140+
//! or removed without notice.
141+
//! @since New in %Cantera 3.0.
142+
//!
139143
virtual void buildNetworkJacobian(vector<Eigen::Triplet<double>>& jacVector) {
140144
throw NotImplementedError("WallBase::buildNetworkJacobian");
141145
}
142146

143-
/*! Specify the jacobian terms have been calculated and should not be recalculated.
144-
* @warning This function is an experimental part of the %Cantera API and may be
145-
* changed
146-
* or removed without notice.
147-
* @since New in %Cantera 3.0.
148-
*/
147+
//! Specify the jacobian terms have been calculated and should not be recalculated.
148+
//! @warning This function is an experimental part of the %Cantera API and may be
149+
//! changed
150+
//! or removed without notice.
151+
//! @since New in %Cantera 3.0.
152+
//!
149153
void jacobianCalculated() { m_jac_calculated = true; };
150154

151-
/*! Specify that jacobian terms have not been calculated and should be recalculated.
152-
* @warning This function is an experimental part of the %Cantera API and may be
153-
* changed
154-
* or removed without notice.
155-
* @since New in %Cantera 3.0.
156-
*/
155+
//! Specify that jacobian terms have not been calculated and should be recalculated.
156+
//! @warning This function is an experimental part of the %Cantera API and may be
157+
//! changed
158+
//! or removed without notice.
159+
//! @since New in %Cantera 3.0.
160+
//!
157161
void jacobianNotCalculated() { m_jac_calculated = false; };
158162

159163
protected:

0 commit comments

Comments
 (0)