Miscellaneous Doxygen doc and comment cleanup
This commit is contained in:
parent
0540cf26d0
commit
94185c7fbd
5 changed files with 11 additions and 38 deletions
|
|
@ -24,14 +24,13 @@ class Interface :
|
|||
public:
|
||||
//! Constructor.
|
||||
/*!
|
||||
* Construct an Interface instance from a specification in an input file.
|
||||
* Construct an Interface instance from a specification in an input file.
|
||||
*
|
||||
* @param infile Cantera input file in CTI or CTML format.
|
||||
* @param id Identification string to distinguish between
|
||||
* multiple definitions within one input file.
|
||||
* @param otherPhases Neighboring phases that may participate in the
|
||||
* reactions on this interface. Don't include the
|
||||
* surface phase
|
||||
* @param infile Cantera input file in CTI or CTML format.
|
||||
* @param id Identification string to distinguish between multiple
|
||||
* definitions within one input file.
|
||||
* @param otherPhases Neighboring phases that may participate in the
|
||||
* reactions on this interface. Don't include the surface phase
|
||||
*/
|
||||
Interface(const std::string& infile, std::string id,
|
||||
std::vector<ThermoPhase*> otherPhases) :
|
||||
|
|
@ -52,10 +51,6 @@ public:
|
|||
m_ok = true;
|
||||
}
|
||||
|
||||
//! Copy Constructor
|
||||
/*!
|
||||
* @param ii Interface object to be copied.
|
||||
*/
|
||||
Interface(const Interface& ii) :
|
||||
SurfPhase(ii),
|
||||
InterfaceKinetics(ii),
|
||||
|
|
@ -63,10 +58,6 @@ public:
|
|||
m_r(ii.m_r) {
|
||||
}
|
||||
|
||||
//! Assignment operator
|
||||
/*!
|
||||
* @param right Interface object to be copied.
|
||||
*/
|
||||
Interface& operator=(const Interface& right) {
|
||||
if (this == &right) {
|
||||
return *this;
|
||||
|
|
@ -84,9 +75,6 @@ public:
|
|||
}
|
||||
|
||||
//! return whether the object has been instantiated
|
||||
/*!
|
||||
* @return Returns a bool.
|
||||
*/
|
||||
bool ready() const {
|
||||
return m_ok;
|
||||
}
|
||||
|
|
@ -95,8 +83,8 @@ protected:
|
|||
//! Flag indicating that the object has been instantiated
|
||||
bool m_ok;
|
||||
|
||||
//! XML_Node pointer to the XML File object that contains the Surface and the Interfacial Reaction object
|
||||
//! description
|
||||
//! XML_Node pointer to the XML File object that contains the Surface and
|
||||
//! the Interfacial Reaction object description
|
||||
XML_Node* m_r;
|
||||
};
|
||||
|
||||
|
|
|
|||
|
|
@ -14,6 +14,8 @@
|
|||
namespace Cantera
|
||||
{
|
||||
|
||||
//! @defgroup equilfunctions
|
||||
|
||||
//! A class for multiphase mixtures. The mixture can contain any
|
||||
//! number of phases of any type.
|
||||
/*!
|
||||
|
|
|
|||
|
|
@ -67,15 +67,9 @@ public:
|
|||
*/
|
||||
InterfaceKinetics(thermo_t* thermo = 0);
|
||||
|
||||
/// Destructor.
|
||||
virtual ~InterfaceKinetics();
|
||||
|
||||
//! Copy Constructor
|
||||
InterfaceKinetics(const InterfaceKinetics& right);
|
||||
|
||||
//! Assignment operator
|
||||
InterfaceKinetics& operator=(const InterfaceKinetics& right);
|
||||
|
||||
virtual Kinetics* duplMyselfAsKinetics(const std::vector<thermo_t*> & tpVector) const;
|
||||
|
||||
virtual int type() const;
|
||||
|
|
|
|||
|
|
@ -118,17 +118,8 @@ public:
|
|||
/// Default constructor.
|
||||
Kinetics();
|
||||
|
||||
/// Destructor.
|
||||
virtual ~Kinetics();
|
||||
|
||||
//!Copy Constructor for the Kinetics object.
|
||||
Kinetics(const Kinetics&);
|
||||
|
||||
//! Assignment operator
|
||||
/*!
|
||||
* @param right Reference to Kinetics object to be copied into the
|
||||
* current one.
|
||||
*/
|
||||
Kinetics& operator=(const Kinetics& right);
|
||||
|
||||
//! Duplication routine for objects which inherit from Kinetics
|
||||
|
|
|
|||
|
|
@ -479,9 +479,7 @@ int vcs_MultiPhaseEquil::equilibrate_TP(int estimateEquil,
|
|||
// view of the vprob object.
|
||||
m_vprob.prob_report(m_printLvl);
|
||||
|
||||
/*
|
||||
* Call the thermo Program
|
||||
*/
|
||||
//! Call the thermo Program
|
||||
int ip1 = m_printLvl;
|
||||
int ipr = std::max(0, m_printLvl-1);
|
||||
if (m_printLvl >= 3) {
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue