py_utils.core.rag.Edge Class Reference

Collaboration diagram for py_utils.core.rag.Edge:

Public Member Functions
	spec (self)
None	__post_init__ (self)
str	__repr__ (self)

Public Attributes
	partner_population

Static Public Attributes
EdgeClass	edge_class
str	label
Population	population
str	kernel
Optional	partner_population = None
Optional	product_population = None
Optional	gas_species = None
Dict	meta = field(default_factory=dict)

Detailed Description

One admissible reaction-edge *family* in the RAG (paper Section 3.2).

An ``Edge`` is parameterised over the size axis: it represents the
whole family of elementary reactions of one :class:`EdgeClass` acting
on one population (or population pair).  The graph walker applies the
edge's kernel vectorised over n, so a single ``Edge`` stands for
O(N) scalar reactions.

Attributes
----------
edge_class : EdgeClass
    Which of the ten elementary classes this family belongs to.
label : str
    Human-readable identifier, unique within a RAG (diagnostics).
population : Population
    The population the (surviving) cluster belongs to.
kernel : str
    Key into the host rate-kernel library ``k``.  The kernel supplies
    the size-resolved rate; the abstract core never evaluates it.
partner_population : Population, optional
    The second precursor population for binary classes
    (COALESCENCE: same polarity; ANNIHILATION: opposite polarity).
product_population : Population, optional
    The product population for INTER_POPULATION edges (p' != p).
gas_species : int, optional
    Index into the host gas list, for SOLUTE_TRAPPING edges.
meta : dict
    Free-form host annotations (e.g. emission channel, sink kind).

Definition at line 38 of file rag.py.

Member Function Documentation

__post_init__()

None py_utils.core.rag.Edge.__post_init__

(

self

)

Definition at line 83 of file rag.py.

__repr__()

str py_utils.core.rag.Edge.__repr__

(

self

)

Definition at line 118 of file rag.py.

spec()

py_utils.core.rag.Edge.spec

(

self

)

The host-independent stoichiometric contract for this edge.

Definition at line 79 of file rag.py.

Member Data Documentation

edge_class

EdgeClass py_utils.core.rag.Edge.edge_class

static

Definition at line 69 of file rag.py.

gas_species

Optional py_utils.core.rag.Edge.gas_species = None

static

Definition at line 75 of file rag.py.

kernel

str py_utils.core.rag.Edge.kernel

static

Definition at line 72 of file rag.py.

label

str py_utils.core.rag.Edge.label

static

Definition at line 70 of file rag.py.

meta

Dict py_utils.core.rag.Edge.meta = field(default_factory=dict)

static

Definition at line 76 of file rag.py.

partner_population [1/2]

Optional py_utils.core.rag.Edge.partner_population = None

static

Definition at line 73 of file rag.py.

partner_population [2/2]

py_utils.core.rag.Edge.partner_population

Definition at line 87 of file rag.py.

population

Population py_utils.core.rag.Edge.population

static

Definition at line 71 of file rag.py.

product_population

Optional py_utils.core.rag.Edge.product_population = None

static

Definition at line 74 of file rag.py.

---

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

• radcluster_code/py_utils/core/rag.py