Cantera  2.4.0
Public Member Functions | Public Attributes | Protected Attributes | List of all members
SpeciesNode Class Reference

Nodes in reaction path graphs. More...

#include <ReactionPath.h>

Public Member Functions

 SpeciesNode ()
 Default constructor. More...
 
virtual ~SpeciesNode ()
 Destructor. More...
 
int nPaths () const
 Total number of paths to or from this node. More...
 
void addPath (Path *path)
 add a path to or from this node More...
 
doublereal outflow ()
 
doublereal inflow ()
 
doublereal netOutflow ()
 
void printPaths ()
 
References.

Return a reference to a path object connecting this node to another node.

Path * path (int n)
 
const Path * path (int n) const
 

Public Attributes

size_t number
 Species number. More...
 
std::string name
 Label on graph. More...
 
doublereal value
 May be used to set node appearance. More...
 
bool visible
 Visible on graph;. More...
 

Protected Attributes

doublereal m_in
 
doublereal m_out
 
std::vector< Path * > m_paths
 

Detailed Description

Nodes in reaction path graphs.

Definition at line 26 of file ReactionPath.h.

Constructor & Destructor Documentation

◆ SpeciesNode()

SpeciesNode ( )
inline

Default constructor.

Definition at line 30 of file ReactionPath.h.

◆ ~SpeciesNode()

virtual ~SpeciesNode ( )
inlinevirtual

Destructor.

Definition at line 34 of file ReactionPath.h.

Member Function Documentation

◆ nPaths()

int nPaths ( ) const
inline

Total number of paths to or from this node.

Definition at line 57 of file ReactionPath.h.

◆ addPath()

void addPath ( Path *  path)

add a path to or from this node

Definition at line 17 of file ReactionPath.cpp.

Member Data Documentation

◆ number

size_t number

Species number.

Definition at line 37 of file ReactionPath.h.

◆ name

std::string name

Label on graph.

Definition at line 38 of file ReactionPath.h.

Referenced by ReactionPathDiagram::exportToDot().

◆ value

doublereal value

May be used to set node appearance.

Definition at line 39 of file ReactionPath.h.

◆ visible

bool visible

Visible on graph;.

Definition at line 40 of file ReactionPath.h.

Referenced by ReactionPathDiagram::exportToDot().


The documentation for this class was generated from the following files: