| Cantera 3.0.0

Loading...
Searching...
No Matches
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 //! Construct and initialize an EdgePhase directly from an input file
34 /*!
35 * @param infile name of the input file. If blank, an empty phase will be created.
36 * @param id name of the phase id in the file.
37 * If this is blank, the first phase in the file is used.
38 */
39 explicit EdgePhase(const string& infile="", const string& id="");
40
41 string type() const override {
42 return "edge";
43 }
44};
45}
46
47#endif
SurfPhase.h
Header for a simple thermodynamics model of a surface phase derived from ThermoPhase,...
Cantera::EdgePhase
A thermodynamic phase representing a one dimensional edge between two surfaces.
Definition EdgePhase.h:31
Cantera::EdgePhase::type
string type() const override
String indicating the thermodynamic model implemented.
Definition EdgePhase.h:41
Cantera::SurfPhase
A simple thermodynamic model for a surface phase, assuming an ideal solution model.
Definition SurfPhase.h:98
Cantera
Namespace for the Cantera kernel.
Definition AnyMap.cpp:564