Quaternion Struct Reference

Kynema-SGF API: kynema_sgf::vs::Quaternion Struct Reference
Kynema-SGF API v0.1.0
CFD solver for wind plant simulations
Loading...
Searching...
No Matches
kynema_sgf::vs::Quaternion Struct Reference

#include <quaternion.H>

Public Member Functions

Quaternionnormalize ()
 Normalize this quaternion in place.
Quaternion normalized () const
 Return a normalized copy without modifying this quaternion.
Quaternion conjugate () const
 Return the quaternion conjugate.

Public Attributes

amrex::Real w {1.0_rt}
amrex::Real x {0.0_rt}
amrex::Real y {0.0_rt}
amrex::Real z {0.0_rt}

Detailed Description

Scalar-first unit quaternion used to interpolate and compose rotations.

Member Function Documentation

◆ conjugate()

Quaternion kynema_sgf::vs::Quaternion::conjugate ( ) const
nodiscard

Return the quaternion conjugate.

◆ normalize()

Quaternion & kynema_sgf::vs::Quaternion::normalize ( )

Normalize this quaternion in place.

◆ normalized()

Quaternion kynema_sgf::vs::Quaternion::normalized ( ) const
nodiscard

Return a normalized copy without modifying this quaternion.

Member Data Documentation

◆ w

amrex::Real kynema_sgf::vs::Quaternion::w {1.0_rt}

◆ x

amrex::Real kynema_sgf::vs::Quaternion::x {0.0_rt}

◆ y

amrex::Real kynema_sgf::vs::Quaternion::y {0.0_rt}

◆ z

amrex::Real kynema_sgf::vs::Quaternion::z {0.0_rt}

The documentation for this struct was generated from the following files:
  • /home/runner/work/kynema-sgf/kynema-sgf/src/core/vs/quaternion.H
  • /home/runner/work/kynema-sgf/kynema-sgf/src/core/vs/quaternion.cpp