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

Doxygen update

Browse source 
Doxygen is currently broken. This commit starts to fix some issues.
This commit is contained in:
Harry Moffat 2013-02-01 18:59:17 +00:00
parent ab3f5e0a63
commit 8793fc3bcb
6 changed files with 1651 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
bin/make_doxygen Normal file
View file

@ -0,0 +1,9 @@
#!/bin/sh
#
#
CUR=`pwd`
CANTERA_SRC_ROOT=${CANTERA_SRC_ROOT:="$CUR"}
cd $CANTERA_SRC_ROOT
# doxygen doc/doxygen/Doxyfile
doxygen doc/doxygen/Doxyfile.tested

43
bin/view_doxygen Executable file
View file

@ -0,0 +1,43 @@
#!/bin/sh
#
#
location='build'
CUR=`pwd`
# echo $CUR
CANTERA_SRC_ROOT=${CANTERA_SRC_ROOT:="$CUR"}
echo hhh = $CANTERA_SRC_ROOT
CANTERA_INSTALL_DIR=${CANTERA_INSTALL_ROOT:="$CUR"}
if test $# -gt 0
then
locat=$1
echo locat = $locat
if [ $locat == 'install' ]
then
location='install'
fi
if [ $locat == 'build' ]
then
location='build'
fi
fi
startpg=$CANTERA_SRC_ROOT/build/docs/doxygen/html/index.html
if [ $location == 'build' ]
then
startpg=$CANTERA_SRC_ROOT/build/docs/doxygen/html/index.html
elif [ $location == 'install' ]
then
startpg=$CANTERA_INSTALL_DIR/share/cantera/doc/doxygen/html/index.html
fi
#
#
firefox $startpg &
exit 0;

1582
doc/doxygen/Doxyfile.tested Normal file
View file

File diff suppressed because it is too large Load diff

30
doc/doxygen/thermoprops.dox
View file

@ -180,90 +180,90 @@
*
* <TABLE>
* <TR>
* <TD> \link ThermoPhase::setState_TPX() setState_TPX()\endlink </TD>
* <TD> \link Cantera::ThermoPhase::setState_TPX() setState_TPX()\endlink </TD>
* <TD> Sets the temperature, mole fractions and then the pressure
* of the phase. </TD>
* </TR>
* <TR>
* <TD> \link ThermoPhase::setState_TPY() setState_TPY()\endlink </TD>
* <TD> \link Cantera::ThermoPhase::setState_TPY() setState_TPY()\endlink </TD>
* <TD> Set the temperature, mass fractions and then the pressure
* of the phase. </TD>
* </TR>
* <TR>
* <TD> \link MolalityVPSSTP::setState_TPM() setState_TPM()\endlink </TD>
* <TD> \link Cantera::MolalityVPSSTP::setState_TPM() setState_TPM()\endlink </TD>
* <TD> Set the temperature, solute molalities, and then the
* pressure of the phase. Only from %ThermoPhase objects which
* inherit from MolalityVPSSTP
* </TD>
* </TR>
* <TR>
* <TD> \link ThermoPhase::setState_TP() setState_TP()\endlink </TD>
* <TD> \link Cantera::ThermoPhase::setState_TP() setState_TP()\endlink </TD>
* <TD> Set the temperature, and then the pressure
* of the phase. The mole fractions are assumed fixed.
* </TD>
* </TR>
* <TR>
* <TD> \link ThermoPhase::setState_PX() setState_PX()\endlink </TD>
* <TD> \link Cantera::ThermoPhase::setState_PX() setState_PX()\endlink </TD>
* <TD> Set the mole fractions and then the pressure
* of the phase. The temperature is assumed fixed.
* </TD>
* </TR>
* <TR>
* <TD> \link ThermoPhase::setState_PY() setState_PY()\endlink </TD>
* <TD> \link Cantera::ThermoPhase::setState_PY() setState_PY()\endlink </TD>
* <TD> Set the mass fractions and then the pressure
* of the phase. The temperature is assumed fixed.
* </TD>
* </TR>
* <TR>
* <TD> \link ThermoPhase::setState_HP() setState_HP()\endlink </TD>
* <TD> \link Cantera::ThermoPhase::setState_HP() setState_HP()\endlink </TD>
* <TD> Set the total specific enthalpy and the pressure
* of the phase using an iterative process.
* The mole fractions are assumed fixed
* </TD>
* </TR>
* <TR>
* <TD> \link ThermoPhase::setState_UV() setState_UV()\endlink </TD>
* <TD> \link Cantera::ThermoPhase::setState_UV() setState_UV()\endlink </TD>
* <TD> Set the total specific internal energy and the pressure
* of the phase using an iterative process.
* The mole fractions are assumed fixed.
* </TD>
* </TR>
* <TR>
* <TD> \link ThermoPhase::setState_SP() setState_SP()\endlink </TD>
* <TD> \link Cantera::ThermoPhase::setState_SP setState_SP()\endlink </TD>
* <TD> Set the total specific internal energy and the pressure
* of the phase using an iterative process.
* The mole fractions are assumed fixed.
* </TD>
* </TR>
* <TR>
* <TD> \link ThermoPhase::setState_SV() setState_SV()\endlink </TD>
* <TD> \link Cantera::ThermoPhase::setState_SV setState_SV()\endlink </TD>
* <TD> Set the total specific entropy and the total specific
* molar volume of the phase using an iterative process.
* The mole fractions are assumed fixed.
* </TD>
* </TR>
* <TR>
* <TD> \link Phase::setConcentrations() setConcentrations()\endlink </TD>
* <TD> \link Cantera::Phase::setConcentrations setConcentrations()\endlink </TD>
* <TD> Set the concentrations of all the species in the
* phase. Note this implicitly specifies the pressure and
* density of the phase. The temperature is assumed fixed.
* </TD>
* </TR>
* <TR>
* <TD> \link Phase::setDensity() setDensity()\endlink </TD>
* <TD> \link Cantera::Phase::setDensity setDensity()\endlink </TD>
* <TD> Set the total density of the phase. The temperature and
* mole fractions are assumed fixed. Note this implicitly
* sets the pressure of the phase.
* </TD>
* </TR>
* <TR>
* <TD> \link Phase::setTemperature() setTemperature()\endlink </TD>
* <TD> \link Cantera::Phase::setTemperature() setTemperature()\endlink </TD>
* <TD> Set the temperature of the phase. The density and
* the mole fractions of the phase are fixed.
* </TD>
* </TR>
* <TR>
* <TD> \link ThermoPhase::setToEquilState() setToEquilState()\endlink </TD>
* <TD> \link Cantera::ThermoPhase::setToEquilState() setToEquilState()\endlink </TD>
* <TD> Sets the mole fractions of the phase to their
* equilibrium values assuming fixed temperature and
* total density.
@ -493,7 +493,7 @@
* standard state properties of the species within the phase.
* If only a reference state is needed
* then a call to
* \link #newSpeciesThermoMgr(std::vector<XML_Node*> spData_nodes, SpeciesThermoFactory* f=0, bool opt=false) newSpeciesThermoMgr()\endlink
* \link #Cantera::newSpeciesThermoMgr(std::vector<XML_Node*> spData_nodes, SpeciesThermoFactory* f=0, bool opt=false) newSpeciesThermoMgr()\endlink
* is made in order
* pick a manager, i.e., a derivative of the SpeciesThermo
* object, to use.

2
include/cantera/equil/MultiPhase.h
View file

@ -225,7 +225,7 @@ public:
*
* @return Reference to the %ThermoPhase object for the phase
*/
ThermoPhase& phase(size_t n);
thermo_t& phase(size_t n);
//! Check that the specified phase index is in range
//! Throws an exception if m is greater than nPhases()

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

@ -2,8 +2,7 @@
* @file ThermoPhase.h
* Header file for class ThermoPhase, the base class for phases with
* thermodynamic properties, and the text for the Module thermoprops
* (see \ref thermoprops and class \link Cantera::ThermoPhase
* ThermoPhase\endlink).
* (see \ref thermoprops and class \link Cantera::ThermoPhase ThermoPhase\endlink).
*/
// Copyright 2002 California Institute of Technology