WVPrimaryFlowComponent

Orthogonal solution group

---

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.

Perhaps the most complicate part of the numerical implementation is the indexing—finding where each solution is represented numerically. In general, a solution will have some properties, e.g., (kMode,lMode,jMode,phi,A,omegasign) which will have a primary and conjugate part, each of which might be in two different matrices.

Topics

• Initialization
  • WVPrimaryFlowComponent create a new orthogonal solution group
• Properties
  • nModes return the number of unique modes of this type
  • qgpvFactorForA0 returns the qgpv multiplier for the A0 coefficient matrix.
• Masks
  • maskOfConjugateModesForCoefficientMatrix returns a mask indicating where the redundant (conjugate )solutions live in the requested coefficient matrix.
  • maskOfModesForCoefficientMatrix returns a mask indicating where solutions live in the requested coefficient matrix.
  • maskOfPrimaryModesForCoefficientMatrix returns a mask indicating where the primary (non-conjugate) solutions live in the requested coefficient matrix.
• Quadratic quantities
  • enstrophyFactorForA0 returns the enstrophy multiplier for the A0 coefficient matrix.
  • totalEnergyFactorForCoefficientMatrix returns the total energy multiplier for the coefficient matrix.
• Analytical solutions
  • solutionForModeAtIndex return the analytical solution for the mode at this index
• Index Gymnastics
  • isValidConjugateModeNumber returns a boolean indicating whether (k,l,j) is a valid mode number
  • isValidModeNumber returns a boolean indicating whether (k,l,j) is a valid mode number
  • isValidPrimaryModeNumber returns a boolean indicating whether (k,l,j) is a valid mode number

---