Struct Channel 

pub struct Channel { /* private fields */ }

A named reaction graph whose edges are particles and whose vertices are production or decay processes.

Implementations

impl Channel

pub fn new(name: impl Into<String>) -> Self

Construct an empty channel with the supplied name.

pub fn name(&self) -> &str

Return the channel name.

pub fn edge(&mut self, name: impl Into<String>) -> EdgeHandle<'_>

Create or edit a named particle edge.

Panics

Panics only if the internal edge map fails to return an entry that was just inserted.

pub fn vertex(&mut self, name: impl Into<String>) -> VertexHandle<'_>

Create or edit a named interaction vertex.

pub fn get_vertex(&self, name: &str) -> LadduPhysicsResult<VertexView<'_>>

Retrieve a vertex view which evaluates quantities in that vertex’s rest frame.

Errors

Returns LadduPhysicsError when name does not identify a vertex in this channel.

pub fn edges(&self) -> impl Iterator<Item = &Edge>

Iterate over particle edges in insertion order.

pub fn vertices(&self) -> impl Iterator<Item = &Vertex>

Iterate over interaction vertices in insertion order.

pub fn initial_edges(&self) -> impl Iterator<Item = &Edge>

Iterate over edges consumed by the graph but not produced by any vertex.

pub fn validate(&self) -> LadduPhysicsResult<()>

Validate all channel vertices.

Consumers such as event generators call this automatically.

Errors

Returns LadduPhysicsError when a vertex references missing or duplicate edges, the reaction graph is inconsistent, or an initial edge lacks a valid momentum source.

pub fn properties( &self, edge: &str, ) -> LadduPhysicsResult<Option<&ParticleProperties>>

Return the optional particle properties attached to an edge.

Errors

Returns LadduPhysicsError when edge is not in this channel.

pub fn particle(&self, edge: &str) -> LadduPhysicsResult<&ParticleProperties>

Return the particle definition attached to an edge.

Errors

Returns LadduPhysicsError when edge is unknown or has no particle properties.

pub fn p4(&self, edge: &str) -> LadduPhysicsResult<Vec4>

Construct the symbolic four-momentum of an edge.

When no explicit expression is attached, momentum conservation is used to infer a uniquely missing momentum at a connected vertex.

Errors

Returns LadduPhysicsError when the edge is unknown or its momentum cannot be uniquely resolved from the channel.

pub fn vec3(&self, edge: &str) -> LadduPhysicsResult<Vec3>

Construct the symbolic three-momentum of an edge.

Errors

Returns LadduPhysicsError when the edge’s four-momentum cannot be resolved.

pub fn mass(&self, edge: &str) -> LadduPhysicsResult<Expr>

Construct the invariant-mass expression for an edge.

Errors

Returns LadduPhysicsError when the edge’s four-momentum cannot be resolved.

pub fn s(&self, edge: &str) -> LadduPhysicsResult<Expr>

Construct the invariant mass squared of an edge.

Errors

Returns LadduPhysicsError when the edge’s four-momentum cannot be resolved.

Trait Implementations

impl Clone for Channel

fn clone(&self) -> Channel

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Channel

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Channel

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Channel

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.