WVFlowComponent

Describe one family of orthogonal wave-vortex solutions.

---

Overview

Each degree-of-freedom in the model is associated with an analytical solution to the equations of motion. This class groups together solutions of a particular type and provides a mapping between their analytical solutions and their numerical representation.

Component masks identify the coefficient locations occupied by the family. This indexing is an important part of the abstraction: one analytical mode, identified by horizontal mode numbers, vertical mode, amplitude, and phase, may require a primary coefficient and a Hermitian conjugate stored at different locations or even in different members of Ap, Am, and A0.

Primary components provide that mapping between mode numbers, WVOrthogonalSolution objects, and coefficient locations. They also define the degrees of freedom carried by each mode. Diagnostic or total components may combine those masks without introducing a new independent solution family.

Topics

• Create a flow component
  • WVFlowComponent create a new orthogonal solution group
• Inspect a flow component
  • abbreviatedName abbreviated name
  • name of the flow feature
  • shortName name of the flow feature
  • wvt reference to the wave vortex transform
• Inspect component modes
  • Masks and validity
    • maskA0 returns a mask indicating where solutions live in the A0 matrix.
    • maskAm returns a mask indicating where solutions live in the Am matrix.
    • maskAp returns a mask indicating where solutions live in the Ap matrix.

Developer Topics

These items document internal implementation details and are not part of the primary public API.

• Flow-component internals
  • contains
  • hasPVComponent
  • hasWaveComponent
  • plus
  • randomAmplitudes returns random amplitude for a valid flow state
  • randomAmplitudesWithSpectrum initialize with coefficients following a specified spectrum

---