Cantera  2.5.1
EdgePhase.h
Go to the documentation of this file.
1 /**
2  * @file EdgePhase.h Declarations for the EdgePhase ThermoPhase object, which
3  * models the interface between two surfaces (see \ref thermoprops and
4  * \link Cantera::EdgePhase EdgePhase\endlink).
5  */
6 
7 // This file is part of Cantera. See License.txt in the top-level directory or
8 // at https://cantera.org/license.txt for license and copyright information.
9 
10 #ifndef CT_EDGEPHASE_H
11 #define CT_EDGEPHASE_H
12 
13 #include "SurfPhase.h"
14 
15 namespace Cantera
16 {
17 
18 //! A thermodynamic phase representing a one dimensional edge between two
19 //! surfaces.
20 /*!
21  * This thermodynamic function is largely a wrapper around the SurfPhase
22  * thermodynamic object.
23  *
24  * All of the equations and formulations carry through from SurfPhase to this
25  * EdgePhase object. It should be noted that dimensional quantities with
26  * dimensions including a length have their dimensions reduced by one.
27  *
28  * @ingroup thermoprops
29  */
30 class EdgePhase : public SurfPhase
31 {
32 public:
33  //! Constructor
34  /*!
35  * @param n0 Surface site density (kmol m-1).
36  */
37  EdgePhase(doublereal n0=1.0);
38 
39  virtual std::string type() const {
40  return "Edge";
41  }
42 
43  //! Set the Equation-of-State parameters by reading an XML Node Input
44  /*!
45  * The Equation-of-State data consists of one item, the site density.
46  *
47  * @param thermoData Reference to an XML_Node named thermo containing the
48  * equation-of-state data. The XML_Node is within the
49  * phase XML_Node describing the EdgePhase object.
50  *
51  * An example of the contents of the thermoData XML_Node is provided below.
52  * The units attribute is used to supply the units of the site density in
53  * any convenient form. Internally it is changed into MKS form.
54  *
55  * @code
56  * <thermo model="Edge">
57  * <site_density units="mol/cm"> 3e-15 </site_density>
58  * </thermo>
59  * @endcode
60  *
61  * @deprecated The XML input format is deprecated and will be removed in
62  * Cantera 3.0.
63  */
64  virtual void setParametersFromXML(const XML_Node& thermoData);
65 };
66 }
67 
68 #endif
Header for a simple thermodynamics model of a surface phase derived from ThermoPhase,...
A thermodynamic phase representing a one dimensional edge between two surfaces.
Definition: EdgePhase.h:31
virtual void setParametersFromXML(const XML_Node &thermoData)
Set the Equation-of-State parameters by reading an XML Node Input.
Definition: SurfPhase.cpp:353
EdgePhase(doublereal n0=1.0)
Constructor.
Definition: SurfPhase.cpp:348
virtual std::string type() const
String indicating the thermodynamic model implemented.
Definition: EdgePhase.h:39
A simple thermodynamic model for a surface phase, assuming an ideal solution model.
Definition: SurfPhase.h:143
Class XML_Node is a tree-based representation of the contents of an XML file.
Definition: xml.h:104
Namespace for the Cantera kernel.
Definition: AnyMap.cpp:264