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

Added doxygen comments.

Browse source
This commit is contained in:
Harry Moffat 2009-05-31 16:24:35 +00:00
parent e44b49ecae
commit 1e056e1274
1 changed files with 16 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
Cantera/src/oneD/Domain1D.h
View file

@ -277,10 +277,13 @@ namespace Cantera {
eval(-1,x,r,mask,0.0);
}
/**
* Evaluate the residual function at point j. If j < 0,
* evaluate the residual function at all points.
*/
//! Evaluate the residual function at point j. If j < 0,
//! evaluate the residual function at all points.
/*!
* @param j Grid point j
* @param x Soln vector. This is the input.
* @param r residual this is the output.
*/
virtual void eval(int j, doublereal* x, doublereal* r,
integer* mask, doublereal rdt=0.0);
@ -492,8 +495,17 @@ namespace Cantera {
OneDim* m_container;
int m_index;
int m_type;
//! Starting location within the solution vector for unknowns
//! that correspond to this domain
/*!
* Remember there may be multiple domains associated with
* this problem
*/
int m_iloc;
int m_jstart;
Domain1D *m_left, *m_right;
std::string m_id, m_desc;
Refiner* m_refiner;