tboudreaux/libcomposition
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(composition): updated mass fracs in docs to more realistic values

Browse Source
This commit is contained in:
Emily Boudreaux
2025-03-24 13:20:24 -04:00
parent b17cdbf1bf
commit 0a70b9ea12
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
src/composition/public/composition.h
View File

@@ -49,16 +49,16 @@ namespace composition{
*
* @example Constructing a finalized composition with symbols and mass fractions:
* @code
* std::vector<std::string> symbols = {"H", "O"};
* std::vector<double> mass_fractions = {0.1, 0.9};
* std::vector<std::string> symbols = {"H", "He"};
* std::vector<double> mass_fractions = {0.7, 0.3};
* Composition comp(symbols, mass_fractions);
* @endcode
* @example Constructing a composition with symbols and finalizing it later:
* @code
* std::vector<std::string> symbols = {"H", "O"};
* std::vector<std::string> symbols = {"H", "He"};
* Composition comp(symbols);
* comp.setComposition("H", 0.1);
* comp.setComposition("O", 0.9);
* comp.setComposition("H", 0.7);
* comp.setComposition("He", 0.3);
* comp.finalize();
* @endcode
*/