JSim 2026.06.01-p(1)
Loading...
Searching...
No Matches
frcsim::RigidBody::AerodynamicGeometry Struct Reference

Geometric metadata used to estimate drag reference area. More...

#include <rigid_body.hpp>

Public Types

enum class  Shape { kCustom , kSphere , kBox , kCylinder }
 Primitive shape model used for reference-area estimation. More...

Public Attributes

Shape shape {Shape::kCustom}
 Selected shape model.
double reference_area_m2 {0.0}
 Explicit area override in square meters.
double radius_m {0.0}
 Sphere/cylinder radius in meters.
Vector3 box_dimensions_m {0.0, 0.0, 0.0}
 Box dimensions (x, y, z) in meters.
double cylinder_length_m {0.0}
 Cylinder length in meters along cylinder_axis_local.
Vector3 cylinder_axis_local {0.0, 0.0, 1.0}
 Cylinder principal axis expressed in local body coordinates.

Detailed Description

Geometric metadata used to estimate drag reference area.

Area estimation can be explicit (via reference_area_m2) or inferred from a primitive shape. Inferred area depends on velocity direction and orientation for non-spherical shapes.

Member Enumeration Documentation

◆ Shape

Primitive shape model used for reference-area estimation.

Enumerator
kCustom 

Use only explicit caller-provided area (no shape inference).

kSphere 

Sphere model parameterized by radius_m.

kBox 

Box model parameterized by box_dimensions_m.

kCylinder 

Cylinder model parameterized by radius, length, and axis.

Member Data Documentation

◆ box_dimensions_m

Vector3 frcsim::RigidBody::AerodynamicGeometry::box_dimensions_m {0.0, 0.0, 0.0}

Box dimensions (x, y, z) in meters.

◆ cylinder_axis_local

Vector3 frcsim::RigidBody::AerodynamicGeometry::cylinder_axis_local {0.0, 0.0, 1.0}

Cylinder principal axis expressed in local body coordinates.

◆ cylinder_length_m

double frcsim::RigidBody::AerodynamicGeometry::cylinder_length_m {0.0}

Cylinder length in meters along cylinder_axis_local.

◆ radius_m

double frcsim::RigidBody::AerodynamicGeometry::radius_m {0.0}

Sphere/cylinder radius in meters.

◆ reference_area_m2

double frcsim::RigidBody::AerodynamicGeometry::reference_area_m2 {0.0}

Explicit area override in square meters.

When > 0, this value bypasses shape-based area estimation.

◆ shape

Shape frcsim::RigidBody::AerodynamicGeometry::shape {Shape::kCustom}

Selected shape model.


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