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

[Doc] Update docstring for Kinetics::checkDuplicates

Browse source
This commit is contained in:
Ray Speth 2017-01-23 16:56:03 -05:00
parent c982f50421
commit 2678b57d58
1 changed files with 8 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
include/cantera/kinetics/Kinetics.h
View file

@ -846,12 +846,15 @@ public:
return true;
}
//! Check for duplicate reactions.
//! Check for unmarked duplicate reactions and unmatched marked duplicates
/**
* If `throw_err` is true, then an exception will be thrown if any unmarked
* duplicate reactions are found. Otherwise, the indices of the first pair
* of duplicate reactions found will be returned. If no duplicate reactions
* are found, returns `(npos, npos)`.
* If `throw_err` is true, then an exception will be thrown if either any
* unmarked duplicate reactions are found, or if any marked duplicate
* reactions do not have a matching duplicate reaction. If `throw_err` is
* false, the indices of the first pair of duplicate reactions found will be
* returned, or the index of the unmatched duplicate will be returned as
* both elements of the pair. If no unmarked duplicates or unmatched marked
* duplicate reactions are found, returns `(npos, npos)`.
*/
virtual std::pair<size_t, size_t> checkDuplicates(bool throw_err=true) const;