Cantera  3.1.0a1
SpeciesNode Class Reference

Nodes in reaction path graphs. More...

#include <ReactionPath.h>

Detailed Description

Nodes in reaction path graphs.

Definition at line 26 of file ReactionPath.h.

Public Member Functions

 SpeciesNode ()=default
 Default constructor. More...
 
virtual ~SpeciesNode ()=default
 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...
 
double outflow ()
 
double inflow ()
 
double 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 = npos
 Species number. More...
 
string name
 Label on graph. More...
 
double value = 0.0
 May be used to set node appearance. More...
 
bool visible = false
 Visible on graph;. More...
 

Protected Attributes

double m_in = 0.0
 
double m_out = 0.0
 
vector< Path * > m_paths
 

Constructor & Destructor Documentation

◆ SpeciesNode()

SpeciesNode ( )
default

Default constructor.

◆ ~SpeciesNode()

virtual ~SpeciesNode ( )
virtualdefault

Destructor.

Member Function Documentation

◆ nPaths()

int nPaths ( ) const
inline

Total number of paths to or from this node.

Definition at line 55 of file ReactionPath.h.

◆ addPath()

void addPath ( Path *  path)

add a path to or from this node

Definition at line 22 of file ReactionPath.cpp.

Member Data Documentation

◆ number

size_t number = npos

Species number.

Definition at line 36 of file ReactionPath.h.

◆ name

string name

Label on graph.

Definition at line 37 of file ReactionPath.h.

◆ value

double value = 0.0

May be used to set node appearance.

Definition at line 38 of file ReactionPath.h.

◆ visible

bool visible = false

Visible on graph;.

Definition at line 39 of file ReactionPath.h.


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