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

Configuration for scaling one compatible field into another. More...

#include <scale.h>

Public Attributes

size_t input_field
 
size_t output_field
 
double scale
 
bool accumulate
 
bool scale_by_dt
 

Detailed Description

Configuration for scaling one compatible field into another.

Member Data Documentation

◆ accumulate

bool SimScaleOperatorConfig::accumulate

Add into the destination when true; otherwise overwrite it.

◆ input_field

size_t SimScaleOperatorConfig::input_field

Source field index.

◆ output_field

size_t SimScaleOperatorConfig::output_field

Destination field index; layout and scalar kind must match input.

◆ scale

double SimScaleOperatorConfig::scale

Finite scalar multiplier; non-finite values normalize to 0.

◆ scale_by_dt

bool SimScaleOperatorConfig::scale_by_dt

Multiply scale by max(dt, 0) when true.


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