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

Options controlling synthesized pole fields. More...

#include <sim_world.h>

Public Attributes

double origin_x
 
double origin_y
 
double spacing_x
 
double spacing_y
 
double plane_z
 
double softening
 

Detailed Description

Options controlling synthesized pole fields.

Member Data Documentation

◆ origin_x

double SimPoleFieldOptions::origin_x

World-space x origin for sample 0.

◆ origin_y

double SimPoleFieldOptions::origin_y

World-space y origin for row 0.

◆ plane_z

double SimPoleFieldOptions::plane_z

Fixed z coordinate used when sampling 2D fields.

◆ softening

double SimPoleFieldOptions::softening

Positive denominator softening near pole singularities.

◆ spacing_x

double SimPoleFieldOptions::spacing_x

World-space x spacing between adjacent columns.

◆ spacing_y

double SimPoleFieldOptions::spacing_y

World-space y spacing between adjacent rows.


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