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

One executable step inside a split operator sequence. More...

#include <operator_split.h>

Collaboration diagram for SimSplitSubstep:

Public Attributes

const char * name
 
SimResult(* fn )(void *state, struct SimContext *ctx, struct SimOperator *container_or_self, size_t substep_index, double dt_sub, void *scratch, size_t scratch_size)
 Execute the substep.
 
const SimSplitAccessaccesses
 
size_t access_count
 
double dt_scale
 
bool barrier_after
 
double(* error_measure )(void *state)
 
uint64_t required_features
 

Detailed Description

One executable step inside a split operator sequence.

Member Data Documentation

◆ access_count

size_t SimSplitSubstep::access_count

Number of entries in accesses.

◆ accesses

const SimSplitAccess* SimSplitSubstep::accesses

Per-substep access declarations.

◆ barrier_after

bool SimSplitSubstep::barrier_after

Treat all ports as read/write for future ordering.

◆ dt_scale

double SimSplitSubstep::dt_scale

Positive scale applied to context dt; otherwise 1.0.

◆ error_measure

double(* SimSplitSubstep::error_measure) (void *state)

Optional error metric reported to the integrator.

◆ fn

SimResult(* SimSplitSubstep::fn) (void *state, struct SimContext *ctx, struct SimOperator *container_or_self, size_t substep_index, double dt_sub, void *scratch, size_t scratch_size)

Execute the substep.

Parameters
stateShared descriptor state pointer.
ctxActive simulation context.
container_or_selfOperator wrapper for the current substep.
substep_indexZero-based substep index.
dt_subContext timestep scaled by dt_scale.
scratchOptional per-thread scratch buffer, or NULL.
scratch_sizeSize of scratch in bytes.
Returns
SIM_RESULT_OK or an error propagated to context execution. Execute the substep callback.

◆ name

const char* SimSplitSubstep::name

Optional label for tooling.

◆ required_features

uint64_t SimSplitSubstep::required_features

Backend features required for this substep.


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