SimContext: Construct a SimContext

View source: R/contexts.R

SimContextR Documentation

Construct a SimContext

Description

Captures invariant simulation-level metadata for one Engine run. Created once by load_model() / Engine$run() in v2 mode and passed to every bundle callback that accepts a sim_ctx argument.

Usage

SimContext(
  run_id,
  time_spec,
  model_id = NULL,
  scenario_id = NULL,
  horizon = NULL
)

Arguments

run_id

Character scalar; unique identifier for this simulation run.

time_spec

A time_spec object (from time_spec()). Resolved from the model schema.

model_id

Optional character scalar identifying the model.

scenario_id

Optional character scalar labelling an experimental condition.

horizon

Optional numeric scalar declaring the simulation horizon.

Value

A list of class "SimContext".


fluxCore documentation built on Sept. 22, 2026, 5:07 p.m.