cantera/include/cantera/IncompressibleSolid.h
Ray Speth fbf93bf270 [Doc] Add Doxygen docstrings for wrapper classes
Without at least a basic docstring, these classes are excluded from the Doxygen
documentation.
2015-10-07 13:54:47 -04:00

40 lines
902 B
C++

//! @file IncompressibleSolid.h
#ifndef CXX_INCOMPRESSIBLE
#define CXX_INCOMPRESSIBLE
#include "thermo/ConstDensityThermo.h"
#include "kinetics/importKinetics.h"
namespace Cantera
{
//! Wrapper for ConstDensityThermo with constructor from file
class IncompressibleSolid : public ConstDensityThermo
{
public:
IncompressibleSolid(const std::string& infile,
std::string id="") : m_ok(false), m_r(0)
{
m_r = get_XML_File(infile);
if (id == "-") {
id = "";
}
m_ok = buildSolutionFromXML(*m_r, id, "phase", this, 0);
if (!m_ok) throw CanteraError("IncompressibleSolid",
"buildSolutionFromXML returned false");
}
bool operator!() {
return !m_ok;
}
bool ready() const {
return m_ok;
}
protected:
bool m_ok;
XML_Node* m_r;
};
}
#endif