Struct RhsProgram 

pub struct RhsProgram { /* private fields */ }

A compiled right-hand side, possibly restricted to one operator’s terms and writes (API_SPEC §5.8). Made by rhs_program.

Built once and immutable: Send + Sync, and cheap to clone (every clone shares one program). Evaluate it concurrently with one RhsWorkspace per thread; a call never starts a thread of its own.

Implementations

impl RhsProgram

pub fn compiler(&self) -> Compiler

The compiler this program was built with.

pub fn writes(&self) -> &[String]

The variables the program writes (u), in flat-layout order.

pub fn aux(&self) -> &[String]

The states the program reads but does not write (aux), in flat-layout order.

pub fn layout(&self) -> &TileLayout

The whole-domain layout of u and aux.

pub fn n_states(&self) -> usize

The length of u (and of du).

pub fn state_layout(&self) -> &[StateBlock]

u’s blocks in flat order, each column-major (first index fastest): the u half of Self::layout.

pub fn parameters(&self) -> &[ParamSlot]

The parameters p holds, in its order: the order the program’s tape reads them in (sorted flattened names).

pub fn parameter_vector( &self, overrides: &HashMap<String, f64>, ) -> Result<Vec<f64>, SimulateError>

The parameter vector with overrides applied over the declared defaults. Strict: a key naming no parameter, or a parameter with neither an override nor a default, is an error naming it.

pub fn forcing_slots(&self) -> &[ForcingSlot]

The buffers a ForcingSet for this program holds, in its order.

pub fn default_forcing(&self) -> ForcingSet

The Problem’s forcing when the program was built: provider data, a caller’s array, or the declared default, and for an array-parameter slot the parameter’s value. Every call returns the same set (the same buffers and epoch). A slot none of these fills holds NaN.

pub fn default_state(&self) -> (Vec<f64>, Vec<f64>)

The declared default of every state cell, as (u, aux) in this program’s whole-domain layout (NaN where none is declared).

pub fn flattened(&self) -> &FlattenedSystem

The flattened system this program was compiled from.

pub fn select(&self, sel: &RhsSelection) -> Result<RhsProgram, SimulateError>

The program for one operator: the summands of each D(x) whose provenance is in sel.terms, writing only sel.writes (API_SPEC §5.8). range_selection_writes_incomplete when writes omits a variable a kept summand writes. It takes the same forcing sets.

pub fn halo(&self, dec: &Decomposition) -> Result<HaloReport, SimulateError>

How far the owned output reaches into each state along each decomposed or face index set of dec (RFC U3 §3). native only.

pub fn tile( &self, dec: &Decomposition, bx: &TileBox, ) -> Result<TileProgram, SimulateError>

This program restricted to one tile of dec (RFC U3 §4). native only.

pub fn lanes( &self, kind: LaneKind, capacity: usize, ) -> Result<LaneProgram, SimulateError>

This program over a run-time list of at most capacity cells or columns (RFC U3 §6). native only.

pub fn new_workspace(&self) -> RhsWorkspace

Buffers for Self::eval_into.

pub fn eval_into( &self, u: &[f64], aux: &[f64], p: &[f64], t: f64, forcing: &ForcingSet, du: &mut [f64], ws: &mut RhsWorkspace, ) -> Result<(), RhsError>

Evaluate the program over the whole domain: du = f(u, aux, p, t) in Self::layout, reading forcing. Every element of du is written (zero for a state with no D equation). This is the reference every tile and lane of the program is bitwise against.

The result depends only on the program and the arguments’ values: not on the thread, the workspace’s history, or any other call.

Trait Implementations

impl Clone for RhsProgram

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RhsProgram

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

Formats the value using the given formatter.