WVGeostrophicComponent

Geostrophic solution group

Declaration

classdef WVGeostrophicComponent < WVPrimaryFlowComponent

FlowConstituentGroup WVGeostrophicFlowGroup WVInternalGravityWaveFlowGroup WVRigidLidFlowGroup OrthogonalSolutionGroup

Create a flow component
- WVGeostrophicComponent
Inspect a flow component
- degreesOfFreedomPerMode
- nModes return the number of unique modes of this type
Work with component modes
- geostrophicSolution return a real-valued analytical solution of the geostrophic mode
- normalizeGeostrophicModeProperties returns properties of a geostrophic solution relative to the primary mode number
- solutionForModeAtIndex return the analytical solution at this index
Inspect component modes
- Masks and validity
  - 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
  - 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.
Compute component energy
- totalEnergyFactorForCoefficientMatrix returns the total energy multiplier for the coefficient matrix.

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