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

[Doc] Remove references to nonexistent source file 'importCTML.cpp'

Browse source
This commit is contained in:
Ray Speth 2014-06-20 18:43:51 +00:00
parent 7064fd1964
commit 147d630f48
33 changed files with 60 additions and 144 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
include/cantera/thermo/ConstDensityThermo.h
View file

@ -251,8 +251,6 @@ public:
* description, this method is called from ThermoPhase::initThermoXML(),
* which is called from importPhase(),
* just prior to returning from function importPhase().
*
* @see importCTML.cpp
*/
virtual void initThermo();
@ -299,9 +297,8 @@ public:
//! Set equation of state parameter values from XML entries.
/*!
*
* This method is called by function importPhase() in
* file importCTML.cpp when processing a phase definition in
* an input file. It should be overloaded in subclasses to set
* This method is called by function importPhase() when processing a phase
* definition in an input file. It should be overloaded in subclasses to set
* any parameters that are specific to that particular phase
* model. Note, this method is called before the phase is
* initialized with elements and/or species.

2
include/cantera/thermo/DebyeHuckel.h
View file

@ -1048,8 +1048,6 @@ public:
* Cascading call sequence downwards starting with Parent.
*
* @internal
*
* @see importCTML.cpp
*/
virtual void initThermo();

9
include/cantera/thermo/FixedChemPotSSTP.h
View file

@ -528,9 +528,7 @@ public:
* and subclasses that do not require initialization do not
* need to overload this method. When importing a CTML phase
* description, this method is called just prior to returning
* from function importPhase.
*
* @see importCTML.cpp
* from function importPhase().
*/
virtual void initThermo();
@ -560,9 +558,8 @@ public:
//! Set equation of state parameter values from XML entries.
/*!
* This method is called by function importPhase() in
* file importCTML.cpp when processing a phase definition in
* an input file. It should be overloaded in subclasses to set
* This method is called by function importPhase() when processing a phase
* definition in an input file. It should be overloaded in subclasses to set
* any parameters that are specific to that particular phase
* model. Note, this method is called before the phase is
* initialized with elements and/or species.

4
include/cantera/thermo/GibbsExcessVPSSTP.h
View file

@ -454,9 +454,7 @@ public:
* and subclasses that do not require initialization do not
* need to overload this method. When importing a CTML phase
* description, this method is called just prior to returning
* from function importPhase.
*
* @see importCTML.cpp
* from function importPhase().
*/
virtual void initThermo();

4
include/cantera/thermo/HMWSoln.h
View file

@ -1890,9 +1890,7 @@ public:
* and subclasses that do not require initialization do not
* need to overload this method. When importing a CTML phase
* description, this method is called just prior to returning
* from function importPhase.
*
* @see importCTML.cpp
* from function importPhase().
*/
virtual void initThermo();

2
include/cantera/thermo/IdealGasPhase.h
View file

@ -859,8 +859,6 @@ public:
* This method is called from ThermoPhase::initThermoXML(),
* which is called from importPhase(),
* just prior to returning from the function, importPhase().
*
* @see importCTML.cpp
*/
virtual void initThermo();

13
include/cantera/thermo/IdealSolnGasVPSS.h
View file

@ -281,18 +281,15 @@ public:
* The following methods are used in the process of constructing
* the phase and setting its parameters from a specification in an
* input file. They are not normally used in application programs.
* To see how they are used, see files importCTML.cpp and
* ThermoFactory.cpp.
* To see how they are used, see importPhase().
*/
//@{
//! Set equation of state parameter values from XML entries.
/*!
* This method is called by function importPhase in
* file importCTML.cpp when processing a phase definition in
* an input file. It should be overloaded in subclasses to set
* any parameters that are specific to that particular phase
* model.
* This method is called by function importPhase() when processing a phase
* definition in an input file. It should be overloaded in subclasses to
* set any parameters that are specific to that particular phase model.
*
* @param thermoNode An XML_Node object corresponding to
* the "thermo" entry for this phase in the input file.
@ -310,8 +307,6 @@ public:
* need to overload this method. When importing a CTML phase
* description, this method is called just prior to returning
* from function importPhase().
*
* @see importCTML.cpp
*/
virtual void initThermo();

4
include/cantera/thermo/IonsFromNeutralVPSSTP.h
View file

@ -538,9 +538,7 @@ public:
* and subclasses that do not require initialization do not
* need to overload this method. When importing a CTML phase
* description, this method is called just prior to returning
* from function importPhase.
*
* @see importCTML.cpp
* from function importPhase().
*/
virtual void initThermo();

7
include/cantera/thermo/LatticePhase.h
View file

@ -763,8 +763,6 @@ public:
* This method is called from ThermoPhase::initThermoXML(),
* which is called from importPhase(),
* just prior to returning from the function, importPhase().
*
* @see importCTML.cpp
*/
virtual void initThermo();
@ -820,9 +818,8 @@ public:
//! Set equation of state parameter values from XML entries.
/*!
* This method is called by function importPhase() in
* file importCTML.cpp when processing a phase definition in
* an input file. It should be overloaded in subclasses to set
* This method is called by function importPhase() when processing a phase
* definition in an input file. It should be overloaded in subclasses to set
* any parameters that are specific to that particular phase
* model. Note, this method is called before the phase is
* initialized with elements and/or species.

7
include/cantera/thermo/LatticeSolidPhase.h
View file

@ -586,8 +586,6 @@ public:
* description, this method is called from ThermoPhase::initThermoXML(),
* which is called from importPhase(),
* just prior to returning from function importPhase().
*
* @see importCTML.cpp
*/
virtual void initThermo();
@ -604,9 +602,8 @@ public:
//! Set equation of state parameter values from XML entries.
/*!
* This method is called by function importPhase() in
* file importCTML.cpp when processing a phase definition in
* an input file. It should be overloaded in subclasses to set
* This method is called by function importPhase() when processing a phase
* definition in an input file. It should be overloaded in subclasses to set
* any parameters that are specific to that particular phase
* model. Note, this method is called before the phase is
* initialized with elements and/or species.

7
include/cantera/thermo/MargulesVPSSTP.h
View file

@ -492,8 +492,7 @@ public:
/// The following methods are used in the process of constructing
/// the phase and setting its parameters from a specification in an
/// input file. They are not normally used in application programs.
/// To see how they are used, see files importCTML.cpp and
/// ThermoFactory.cpp.
/// To see how they are used, see importPhase()
/// @{
/*!
@ -505,9 +504,7 @@ public:
* and subclasses that do not require initialization do not
* need to overload this method. When importing a CTML phase
* description, this method is called just prior to returning
* from function importPhase.
*
* @see importCTML.cpp
* from function importPhase().
*/
virtual void initThermo();

9
include/cantera/thermo/MetalSHEelectrons.h
View file

@ -442,9 +442,7 @@ public:
* and subclasses that do not require initialization do not
* need to overload this method. When importing a CTML phase
* description, this method is called just prior to returning
* from function importPhase.setParameters
*
* @see importCTML.cpp
* from function importPhase().
*/
virtual void initThermo();
@ -482,9 +480,8 @@ public:
//! Set equation of state parameter values from XML entries.
/*!
* This method is called by function importPhase() in
* file importCTML.cpp when processing a phase definition in
* an input file. It should be overloaded in subclasses to set
* This method is called by function importPhase() when processing a phase
* definition in an input file. It should be overloaded in subclasses to set
* any parameters that are specific to that particular phase
* model. Note, this method is called before the phase is
* initialized with elements and/or species.

9
include/cantera/thermo/MineralEQ3.h
View file

@ -362,9 +362,7 @@ public:
* and subclasses that do not require initialization do not
* need to overload this method. When importing a CTML phase
* description, this method is called just prior to returning
* from function importPhase.
*
* @see importCTML.cpp
* from function importPhase().
*/
virtual void initThermo();
@ -414,9 +412,8 @@ public:
//! Set equation of state parameter values from XML entries.
/*!
* This method is called by function importPhase() in
* file importCTML.cpp when processing a phase definition in
* an input file. It should be overloaded in subclasses to set
* This method is called by function importPhase() when processing a phase
* definition in an input file. It should be overloaded in subclasses to set
* any parameters that are specific to that particular phase
* model. Note, this method is called before the phase is
* initialized with elements and/or species.

7
include/cantera/thermo/MixedSolventElectrolyte.h
View file

@ -482,8 +482,7 @@ public:
/// The following methods are used in the process of constructing
/// the phase and setting its parameters from a specification in an
/// input file. They are not normally used in application programs.
/// To see how they are used, see files importCTML.cpp and
/// ThermoFactory.cpp.
/// To see how they are used, see importPhase().
/// @{
/*!
@ -495,9 +494,7 @@ public:
* and subclasses that do not require initialization do not
* need to overload this method. When importing a CTML phase
* description, this method is called just prior to returning
* from function importPhase.
*
* @see importCTML.cpp
* from function importPhase().
*/
virtual void initThermo();

5
include/cantera/thermo/MixtureFugacityTP.h
View file

@ -552,8 +552,7 @@ public:
* The following methods are used in the process of constructing
* the phase and setting its parameters from a specification in an
* input file. They are not normally used in application programs.
* To see how they are used, see files importCTML.cpp and
* ThermoFactory.cpp.
* To see how they are used, see importPhase().
*/
//@{
@ -580,8 +579,6 @@ public:
* initThermoXML() for the phase. Therefore, it's the correct
* place for initializing vectors which have lengths equal to the
* number of species.
*
* @see importCTML.cpp
*/
virtual void initThermo();

11
include/cantera/thermo/MolalityVPSSTP.h
View file

@ -588,11 +588,9 @@ public:
//! Set equation of state parameter values from XML entries.
/*!
* This method is called by function importPhase() in
* file importCTML.cpp when processing a phase definition in
* an input file. It should be overloaded in subclasses to set
* any parameters that are specific to that particular phase
* model.
* This method is called by function importPhase() when processing a phase
* definition in an input file. It should be overloaded in subclasses to set
* any parameters that are specific to that particular phase model.
*
* The MolalityVPSSTP object defines a new method for setting
* the concentrations of a phase. The new method is defined by a
@ -619,8 +617,7 @@ public:
/// The following methods are used in the process of constructing
/// the phase and setting its parameters from a specification in an
/// input file. They are not normally used in application programs.
/// To see how they are used, see files importCTML.cpp and
/// ThermoFactory.cpp.
/// To see how they are used, see importPhase().
//@{
virtual void initThermo();

7
include/cantera/thermo/MolarityIonicVPSSTP.h
View file

@ -236,8 +236,7 @@ public:
/// The following methods are used in the process of constructing
/// the phase and setting its parameters from a specification in an
/// input file. They are not normally used in application programs.
/// To see how they are used, see files importCTML.cpp and
/// ThermoFactory.cpp.
/// To see how they are used, see importPhase().
/// @{
/*!
@ -249,9 +248,7 @@ public:
* and subclasses that do not require initialization do not
* need to overload this method. When importing a CTML phase
* description, this method is called just prior to returning
* from function importPhase.
*
* @see importCTML.cpp
* from function importPhase().
*/
virtual void initThermo();

7
include/cantera/thermo/PhaseCombo_Interaction.h
View file

@ -568,8 +568,7 @@ public:
/// The following methods are used in the process of constructing
/// the phase and setting its parameters from a specification in an
/// input file. They are not normally used in application programs.
/// To see how they are used, see files importCTML.cpp and
/// ThermoFactory.cpp.
/// To see how they are used, see importPhase().
/// @{
/*!
@ -581,9 +580,7 @@ public:
* and subclasses that do not require initialization do not
* need to overload this method. When importing a CTML phase
* description, this method is called just prior to returning
* from function importPhase.
*
* @see importCTML.cpp
* from function importPhase().
*/
virtual void initThermo();

7
include/cantera/thermo/PseudoBinaryVPSSTP.h
View file

@ -148,8 +148,7 @@ public:
/// The following methods are used in the process of constructing
/// the phase and setting its parameters from a specification in an
/// input file. They are not normally used in application programs.
/// To see how they are used, see files importCTML.cpp and
/// ThermoFactory.cpp.
/// To see how they are used, see importPhase().
/*!
* @internal Initialize. This method is provided to allow
@ -160,9 +159,7 @@ public:
* and subclasses that do not require initialization do not
* need to overload this method. When importing a CTML phase
* description, this method is called just prior to returning
* from function importPhase.
*
* @see importCTML.cpp
* from function importPhase().
*/
virtual void initThermo();

7
include/cantera/thermo/PureFluidPhase.h
View file

@ -476,16 +476,13 @@ public:
* description, this method is called from ThermoPhase::initThermoXML(),
* which is called from importPhase(),
* just prior to returning from function importPhase().
*
* @see importCTML.cpp
*/
virtual void initThermo();
//! Set equation of state parameter values from XML entries.
/*!
* This method is called by function importPhase() in
* file importCTML.cpp when processing a phase definition in
* an input file. It should be overloaded in subclasses to set
* This method is called by function importPhase() when processing a phase
* definition in an input file. It should be overloaded in subclasses to set
* any parameters that are specific to that particular phase
* model. Note, this method is called before the phase is
* initialized with elements and/or species.

7
include/cantera/thermo/RedlichKisterVPSSTP.h
View file

@ -478,8 +478,7 @@ public:
/// The following methods are used in the process of constructing
/// the phase and setting its parameters from a specification in an
/// input file. They are not normally used in application programs.
/// To see how they are used, see files importCTML.cpp and
/// ThermoFactory.cpp.
/// To see how they are used, see importPhase().
/*!
* @internal Initialize. This method is provided to allow
@ -490,9 +489,7 @@ public:
* and subclasses that do not require initialization do not
* need to overload this method. When importing a CTML phase
* description, this method is called just prior to returning
* from function importPhase.
*
* @see importCTML.cpp
* from function importPhase().
*/
virtual void initThermo();

13
include/cantera/thermo/RedlichKwongMFTP.h
View file

@ -385,18 +385,15 @@ public:
* The following methods are used in the process of constructing
* the phase and setting its parameters from a specification in an
* input file. They are not normally used in application programs.
* To see how they are used, see files importCTML.cpp and
* ThermoFactory.cpp.
* To see how they are used, see importPhase().
*/
//@{
//! Set equation of state parameter values from XML entries.
/*!
* This method is called by function importPhase in
* file importCTML.cpp when processing a phase definition in
* an input file. It should be overloaded in subclasses to set
* any parameters that are specific to that particular phase
* model.
* This method is called by function importPhase() when processing a phase
* definition in an input file. It should be overloaded in subclasses to set
* any parameters that are specific to that particular phase model.
*
* @param thermoNode An XML_Node object corresponding to
* the "thermo" entry for this phase in the input file.
@ -414,8 +411,6 @@ public:
* need to overload this method. When importing a CTML phase
* description, this method is called just prior to returning
* from function importPhase().
*
* @see importCTML.cpp
*/
virtual void initThermo();

2
include/cantera/thermo/SingleSpeciesTP.h
View file

@ -468,8 +468,6 @@ public:
*
* This version sets the mole fraction vector to x[0] = 1.0, and then
* calls the ThermoPhase::initThermo() function.
*
* @see importCTML.cpp
*/
virtual void initThermo();

9
include/cantera/thermo/StoichSubstanceSSTP.h
View file

@ -422,9 +422,7 @@ public:
* and subclasses that do not require initialization do not
* need to overload this method. When importing a CTML phase
* description, this method is called just prior to returning
* from function importPhase.
*
* @see importCTML.cpp
* from function importPhase().
*/
virtual void initThermo();
@ -456,9 +454,8 @@ public:
//! Set equation of state parameter values from XML entries.
/*!
* This method is called by function importPhase() in
* file importCTML.cpp when processing a phase definition in
* an input file. It should be overloaded in subclasses to set
* This method is called by function importPhase() when processing a phase
* definition in an input file. It should be overloaded in subclasses to set
* any parameters that are specific to that particular phase
* model. Note, this method is called before the phase is
* initialized with elements and/or species.

2
include/cantera/thermo/SurfPhase.h
View file

@ -396,8 +396,6 @@ public:
* description, this method is called from ThermoPhase::initThermoXML(),
* which is called from importPhase(),
* just prior to returning from function importPhase().
*
* @see importCTML.cpp
*/
virtual void initThermo();

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

@ -1264,8 +1264,7 @@ public:
* The following methods are used in the process of constructing
* the phase and setting its parameters from a specification in an
* input file. They are not normally used in application programs.
* To see how they are used,
* see files importCTML.cpp and ThermoFactory.cpp.
* To see how they are used, see importPhase().
*/
//@{
@ -1292,7 +1291,7 @@ public:
* constructing solution properties. It is meant for internal
* use, and some classes derived from ThermoPhase may not use
* any species thermodynamic property manager. This method is
* called by function importPhase() in importCTML.cpp.
* called by function importPhase().
*
* @param spthermo input pointer to the species thermodynamic property
* manager.
@ -1380,8 +1379,6 @@ public:
* description, this method is called from ThermoPhase::initThermoXML(),
* which is called from importPhase(),
* just prior to returning from function importPhase().
*
* @see importCTML.cpp
*/
virtual void initThermo();
@ -1417,9 +1414,8 @@ public:
//! Set equation of state parameter values from XML entries.
/*!
* This method is called by function importPhase() in
* file importCTML.cpp when processing a phase definition in
* an input file. It should be overloaded in subclasses to set
* This method is called by function importPhase() when processing a phase
* definition in an input file. It should be overloaded in subclasses to set
* any parameters that are specific to that particular phase
* model. Note, this method is called before the phase is
* initialized with elements and/or species.

4
include/cantera/thermo/VPSSMgr.h
View file

@ -631,7 +631,7 @@ public:
* The following methods are used in the process of constructing the phase
* and setting its parameters from a specification in an input file. They
* are not normally used in application programs. To see how they are
* used, see files importCTML.cpp and ThermoFactory.cpp.
* used, see importPhase().
*/
//@{
@ -644,8 +644,6 @@ public:
* subclasses that do not require initialization do not need to overload
* this method. When importing a CTML phase description, this method is
* called just prior to returning from function importPhase().
*
* @see importCTML.cpp
*/
virtual void initThermo();

2
include/cantera/thermo/VPSSMgr_General.h
View file

@ -87,7 +87,7 @@ protected:
* The following methods are used in the process of constructing the phase
* and setting its parameters from a specification in an input file. They
* are not normally used in application programs. To see how they are
* used, see files importCTML.cpp and ThermoFactory.cpp.
* used, see #importPhase.
*/
//@{
virtual void initThermo();

2
include/cantera/thermo/VPSSMgr_IdealGas.h
View file

@ -67,7 +67,7 @@ public:
* The following methods are used in the process of constructing the phase
* and setting its parameters from a specification in an input file. They
* are not normally used in application programs. To see how they are
* used, see files importCTML.cpp and ThermoFactory.cpp.
* used, see importPhase().
*/
//@{
virtual void initThermoXML(XML_Node& phaseNode, const std::string& id);

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

@ -87,8 +87,7 @@ public:
* The following methods are used in the process of constructing
* the phase and setting its parameters from a specification in an
* input file. They are not normally used in application programs.
* To see how they are used, see files importCTML.cpp and
* ThermoFactory.cpp.
* To see how they are used, see importPhase().
*/
//@{

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

@ -110,8 +110,7 @@ public:
* The following methods are used in the process of constructing
* the phase and setting its parameters from a specification in an
* input file. They are not normally used in application programs.
* To see how they are used, see files importCTML.cpp and
* ThermoFactory.cpp.
* To see how they are used, see importPhase().
*/
//@{
virtual void initThermo();

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

@ -465,8 +465,7 @@ public:
* The following methods are used in the process of constructing
* the phase and setting its parameters from a specification in an
* input file. They are not normally used in application programs.
* To see how they are used, see files importCTML.cpp and
* ThermoFactory.cpp.
* To see how they are used, see importPhase().
*/
//@{

7
include/cantera/thermo/WaterSSTP.h
View file

@ -417,16 +417,13 @@ public:
* description, this method is called from ThermoPhase::initThermoXML(),
* which is called from importPhase(),
* just prior to returning from function importPhase().
*
* @see importCTML.cpp
*/
virtual void initThermo();
//! Set equation of state parameter values from XML entries.
/*!
* This method is called by function importPhase() in
* file importCTML.cpp when processing a phase definition in
* an input file. It should be overloaded in subclasses to set
* This method is called by function importPhase() when processing a phase
* definition in an input file. It should be overloaded in subclasses to set
* any parameters that are specific to that particular phase
* model. Note, this method is called before the phase is
* initialized with elements and/or species.