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

[Thermo] Correct docstring for ThermoPhase::initThermoFile

Browse source
This commit is contained in:
Ray Speth 2016-06-24 23:14:17 -04:00
parent b0bf17dbc6
commit a338610934
1 changed files with 5 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
include/cantera/thermo/ThermoPhase.h
View file

@ -1440,20 +1440,14 @@ public:
/**
* @internal
* Initialization of a ThermoPhase object using an ctml file.
* Initialize a ThermoPhase object using a ctml file.
*
* This routine is a precursor to initThermoXML(XML_Node*) routine, which
* does most of the work. Here we read extra information about the XML
* description of a phase. Regular information about elements and species
* and their reference state thermodynamic information have already been
* read at this point. For example, we do not need to call this function for
* ideal gas equations of state.
* Used to implement constructors for derived classes which take a
* a CTML filename and phase name as arguments.
*
* @param inputFile XML file containing the description of the phase
*
* @param id Optional parameter identifying the name of the phase. If none
* is given, the first XML phase element encountered will be
* used.
* @param id Optional parameter identifying the name of the phase. If
* blank, the first XML phase element encountered will be used.
*/
virtual void initThermoFile(const std::string& inputFile,
const std::string& id);