research/cantera
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

[1D] Fix docstrings for OneDim::eval and StFlow::eval

Browse source
This commit is contained in:
Ray Speth 2016-02-05 22:41:17 -05:00
parent d20ab891e8
commit 73246130fa
2 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
include/cantera/oneD/OneDim.h
View file

@ -162,7 +162,7 @@ public:
/**
* Evaluate the multi-domain residual function
*
* @param j if j > 0, only evaluate residual for points j-1, j,
* @param j if j != npos, only evaluate residual for points j-1, j,
* and j + 1; otherwise, evaluate at all grid points.
* @param x solution vector
* @param r on return, contains the residual vector

8
include/cantera/oneD/StFlow.h
View file

@ -268,10 +268,10 @@ public:
/*!
* Evaluate the residual function for axisymmetric stagnation flow. If
* jpt is less than zero, the residual function is evaluated at all grid
* points. If jpt >= 0, then the residual function is only evaluated at
* grid points jpt-1, jpt, and jpt+1. This option is used to efficiently
* evaluate the Jacobian numerically.
* j == npos, the residual function is evaluated at all grid points.
* Otherwise, the residual function is only evaluated at grid points
* j-1, j, and j+1. This option is used to efficiently evaluate the
* Jacobian numerically.
*/
virtual void eval(size_t j, doublereal* x, doublereal* r,
integer* mask, doublereal rdt);