Species::Reaction::Outcome Struct Reference

Possible outcomes of a reaction. More...

#include <species.h>

Collaboration diagram for Species::Reaction::Outcome:

[legend]

List of all members.

Public Member Functions
	Outcome ()
	Outcome (int ip0, int ip1, REAL a, REAL p, REAL h)
void	Products (int ip0, int ip1)
int	Product (int i)
void	Time (REAL t)
REAL	Time ()
void	ActivationEnergy (REAL a)
REAL	ActivationEnergy ()
void	Probability (REAL r)
REAL	Probability ()
void	Enthalpy (REAL h)
REAL	Enthalpy ()
Public Attributes
int	product [2]
	two indexes of the products of a reaction
REAL	activationEnergy
REAL	probability
REAL	enthalpy
REAL	time
Outcome *	next
	linked list of outcomes

---

Detailed Description

Possible outcomes of a reaction.

Definition at line 37 of file species.h.

---

Constructor & Destructor Documentation

Species::Reaction::Outcome::Outcome

(

)

[inline]

Definition at line 44 of file species.h.

References enthalpy, next, probability, product, time, and VOIDSPECIE.

Species::Reaction::Outcome::Outcome	(	int	ip0,
		int	ip1,
		REAL	a,
		REAL	p,
		REAL	h
	)			[inline]

Parameters:

ip0	index of the first reaction product
ip1	index of the second reaction product
a	activation energy
p	outcome probability
h	enthalpy of reaction

Definition at line 49 of file species.h.

References activationEnergy, enthalpy, next, Species::nspecies, probability, product, and time.

---

Member Function Documentation

REAL Species::Reaction::Outcome::ActivationEnergy

(

)

[inline]

Definition at line 120 of file species.h.

References activationEnergy.

void Species::Reaction::Outcome::ActivationEnergy

(

REAL

a

)

[inline]

Definition at line 119 of file species.h.

References activationEnergy.

Referenced by Domain::interact().

REAL Species::Reaction::Outcome::Enthalpy

(

)

[inline]

Definition at line 124 of file species.h.

References enthalpy.

void Species::Reaction::Outcome::Enthalpy

(

REAL

h

)

[inline]

Definition at line 123 of file species.h.

References enthalpy.

Referenced by Domain::boundary(), Domain::Domain(), and Domain::interact().

REAL Species::Reaction::Outcome::Probability

(

)

[inline]

Definition at line 122 of file species.h.

References probability.

void Species::Reaction::Outcome::Probability

(

REAL

r

)

[inline]

Definition at line 121 of file species.h.

References probability.

Referenced by Domain::boundary(), Domain::Domain(), and Domain::interact().

int Species::Reaction::Outcome::Product

(

int

i

)

[inline]

Definition at line 110 of file species.h.

References product.

Referenced by Domain::boundary(), Domain::Domain(), and Domain::interact().

void Species::Reaction::Outcome::Products	(	int	ip0,
		int	ip1
	)			[inline]

Definition at line 98 of file species.h.

References product.

REAL Species::Reaction::Outcome::Time

(

)

[inline]

Definition at line 118 of file species.h.

References time.

void Species::Reaction::Outcome::Time

(

REAL

t

)

[inline]

Definition at line 117 of file species.h.

References time.

Referenced by Domain::boundary().

---

Member Data Documentation

REAL Species::Reaction::Outcome::activationEnergy

Definition at line 39 of file species.h.

Referenced by ActivationEnergy(), and Outcome().

REAL Species::Reaction::Outcome::enthalpy

Definition at line 39 of file species.h.

Referenced by Enthalpy(), and Outcome().

Outcome* Species::Reaction::Outcome::next

linked list of outcomes

Definition at line 43 of file species.h.

Referenced by Species::Reaction::Add(), Species::Reaction::Erase(), Species::Reaction::Next(), and Outcome().

REAL Species::Reaction::Outcome::probability

Definition at line 39 of file species.h.

Referenced by Outcome(), and Probability().

int Species::Reaction::Outcome::product[2]

two indexes of the products of a reaction

Definition at line 38 of file species.h.

Referenced by Outcome(), Product(), and Products().

REAL Species::Reaction::Outcome::time

time of reaction: used primarily for surface reactions, where there is a time delay between species adsorption on the surface and product formation.

Definition at line 39 of file species.h.

Referenced by Outcome(), and Time().

---

The documentation for this struct was generated from the following file:

• species.h