Oakfield API Documentation 1.0.0
Numerical core APIs
Loading...
Searching...
No Matches
SimRuntimeLoopProgress Struct Reference

Snapshot of caller-owned loop progress and declared budgets. More...

#include <sim_runtime_state.h>

Public Attributes

bool active
 
SimRuntimeLoopProgressKind kind
 
uint64_t steps_completed
 
uint64_t checks_completed
 
uint64_t step_chunk
 
uint64_t step_budget
 
uint64_t check_budget
 
double sim_time_advanced
 
double wall_time_ms
 
double sim_time_budget
 
double wall_time_budget
 
double requested_dt
 
size_t trace_limit
 
bool has_step_chunk
 
bool has_step_budget
 
bool has_check_budget
 
bool has_sim_time_budget
 
bool has_wall_time_budget
 
bool has_requested_dt
 
bool has_trace_limit
 

Detailed Description

Snapshot of caller-owned loop progress and declared budgets.

Member Data Documentation

◆ active

bool SimRuntimeLoopProgress::active

True while a caller-owned loop is active.

◆ check_budget

uint64_t SimRuntimeLoopProgress::check_budget

Total allowed loop checks.

◆ checks_completed

uint64_t SimRuntimeLoopProgress::checks_completed

Number of loop-budget checks performed.

◆ has_check_budget

bool SimRuntimeLoopProgress::has_check_budget

True when check_budget is meaningful.

◆ has_requested_dt

bool SimRuntimeLoopProgress::has_requested_dt

True when requested_dt is meaningful.

◆ has_sim_time_budget

bool SimRuntimeLoopProgress::has_sim_time_budget

True when sim_time_budget is meaningful.

◆ has_step_budget

bool SimRuntimeLoopProgress::has_step_budget

True when step_budget is meaningful.

◆ has_step_chunk

bool SimRuntimeLoopProgress::has_step_chunk

True when step_chunk is meaningful.

◆ has_trace_limit

bool SimRuntimeLoopProgress::has_trace_limit

True when trace_limit is meaningful.

◆ has_wall_time_budget

bool SimRuntimeLoopProgress::has_wall_time_budget

True when wall_time_budget is meaningful.

◆ kind

SimRuntimeLoopProgressKind SimRuntimeLoopProgress::kind

Active bounded-loop family.

◆ requested_dt

double SimRuntimeLoopProgress::requested_dt

Requested dt used by the loop.

◆ sim_time_advanced

double SimRuntimeLoopProgress::sim_time_advanced

Simulation time advanced by the loop.

◆ sim_time_budget

double SimRuntimeLoopProgress::sim_time_budget

Simulation-time budget in seconds.

◆ step_budget

uint64_t SimRuntimeLoopProgress::step_budget

Total allowed steps.

◆ step_chunk

uint64_t SimRuntimeLoopProgress::step_chunk

Declared per-iteration step chunk.

◆ steps_completed

uint64_t SimRuntimeLoopProgress::steps_completed

Number of completed simulation steps.

◆ trace_limit

size_t SimRuntimeLoopProgress::trace_limit

Maximum retained trace entries.

◆ wall_time_budget

double SimRuntimeLoopProgress::wall_time_budget

Wall-clock budget in milliseconds.

◆ wall_time_ms

double SimRuntimeLoopProgress::wall_time_ms

Wall-clock time consumed by the loop.


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