WVTransformHydrostatic

A class for disentangling hydrostatic waves and vortices in variable stratification

Declaration

classdef WVTransformHydrostatic < WVTransform

Overview

To initialization an instance of the WVTransformHydrostatic class you must specific the domain size, the number of grid points and either the density profile or the stratification profile.

  N0 = 3*2*pi/3600;
  L_gm = 1300;
  N2 = @(z) N0*N0*exp(2*z/L_gm);
  wvt = WVTransformHydrostatic([100e3, 100e3, 4000],[64, 64, 65], N2=N2,latitude=30);

Topics

Initialization
- WVTransformHydrostatic create a wave-vortex transform for variable stratification
Primary flow components
- geostrophicComponent returns the geostrophic flow component
- waveComponent returns the internal gravity wave flow component
- inertialComponent returns the inertial oscillation flow component
- mdaComponent returns the mean density anomaly component
Stratification
- effectiveVerticalGridResolution returns the effective vertical grid resolution in meters
- Validation
  - isDensityInValidRange checks if the density field is a valid adiabatic re-arrangement of the base state
Initial conditions
- Waves
  - addGMSpectrum add waves following a Garrett-Munk spectrum
  - addWaveModes add amplitudes of the given wave modes
  - addWavesWithFrequencySpectrum add waves with a specified frequency spectrum
  - initWavesWithFrequencySpectrum initialize with waves of a specified frequency spectrum
  - initWithAlternativeSpectrum initialize with an alternative formulation of the GM spectrum in the wavenumber domain.
  - initWithGMSpectrum initialize the wave field following a Garrett-Munk spectrum
  - initWithWaveModes initialize with the given wave modes
  - removeAllWaves removes all wave from the model, including inertial oscillations
  - setWaveModes set amplitudes of the given wave modes
- Geostrophic Motions
  - initWithGeostrophicStreamfunction initialize with a geostrophic streamfunction
  - setGeostrophicStreamfunction set a geostrophic streamfunction
  - addGeostrophicStreamfunction add a geostrophic streamfunction to existing geostrophic motions
  - setGeostrophicModes set amplitudes of the given geostrophic modes
  - addGeostrophicModes add amplitudes of the given geostrophic modes
  - removeAllGeostrophicMotions remove all geostrophic motions
- Inertial Oscillations
  - addInertialMotions add inertial motions to existing inertial motions
  - initWithInertialMotions initialize with inertial motions
  - removeAllInertialMotions remove all inertial motions
  - setInertialMotions set inertial motions
- Mean density anomaly
  - addMeanDensityAnomaly add inertial motions to existing inertial motions
  - initWithMeanDensityAnomaly initialize with inertial motions
  - removeAllMeanDensityAnomaly remove all mean density anomalies
  - setMeanDensityAnomaly set inertial motions
Operations
- Grid transformation
  - transformFromDFTGridToWVGrid convert from DFT to WV grid
  - transformFromWVGridToDFTGrid convert from a WV to DFT grid
- Fourier transformation
  - transformFromSpatialDomainToDFTGrid transform from \((x,y,z)\) to \((k,l,z)\) on the DFT grid
  - transformToSpatialDomainFromDFTGrid transform from \((k,l,z)\) on the DFT grid to \((x,y,z)\)
  - transformToSpatialDomainFromDFTGridAtPosition transform from \((k,l)\) on the DFT grid to \((x,y)\) at any position
- Transformations
  - transformToKLAxes transforms in the spectral domain from (j,kl) to (kAxis,lAxis,j)
  - transformToOmegaAxis transforms in the from (j,kRadial) to omegaAxis
  - transformToPseudoRadialWavenumber transforms in the from (j,kRadial) to kPseudoRadial
  - transformToPseudoRadialWavenumberA0 transforms in the from (j,kRadial) to kPseudoRadial
  - transformToPseudoRadialWavenumberApm transforms in the from (j,kRadial) to kPseudoRadial
  - transformToRadialWavenumber transforms in the spectral domain from (j,kl) to (j,kRadial)
Domain attributes
- Spatial grid
  - Lx length of the x-dimension
  - Ly length of the y-dimension
  - Lz length of the z-dimension
  - Nx number of grid points in the x-dimension
  - Ny number of grid points in the y-dimension
  - fastTransform fast transform object
  - x dimension
  - y dimension
- DFT grid
  - Nk_dft length of the k-wavenumber dimension on the DFT grid
  - Nl_dft length of the l-wavenumber dimension on the DFT grid
  - conjugateDimension assumed conjugate dimension
  - kMode_dft k mode-number on the DFT grid
  - k_dft k wavenumber dimension on the DFT grid
  - lMode_dft l mode-number on the DFT grid
  - l_dft l wavenumber dimension on the DFT grid
- WV grid
  - Nkl length of the combined kl-wavenumber dimension on the WV grid
  - dftConjugateIndex index into the DFT grid of the conjugate of each WV mode
  - dftConjugateIndices2D index into the DFT grid of the conjugate of each WV mode
  - dftPrimaryIndex index into the DFT grid of each WV mode
  - dftPrimaryIndices2D index into the DFT grid of each WV mode
  - dk wavenumber spacing of the \(k\) axis
  - dl wavenumber spacing of the \(l\) axis
  - k wavenumber dimension on the WV grid
  - kMode_wv k mode number on the WV grid
  - kRadial radial (k,l) wavenumber on the WV grid
  - kl wavenumber dimension
  - l wavenumber dimension on the WV grid
  - lMode_wv l mode number on the WV grid
  - shouldAntialias whether the WV grid includes quadratically aliased wavenumbers
  - shouldExcludeNyquist whether the WV grid includes Nyquist wavenumbers
  - shouldExludeConjugates whether the WV grid includes wavenumbers that are Hermitian conjugates
  - wvConjugateIndex index into the WV mode that matches the dftConjugateIndices
Utility function
- degreesOfFreedomForComplexMatrix a matrix with the number of degrees-of-freedom at each entry
- degreesOfFreedomForRealMatrix a matrix with the number of degrees-of-freedom at each entry
- indicesOfFourierConjugates a matrix of linear indices of the conjugate
- isHermitian Check if the matrix is Hermitian. Report errors.
- setConjugateToUnity set the conjugate of the wavenumber (iK,iL) to 1
Properties
- effectiveHorizontalGridResolution returns the effective grid resolution in meters
Energetics
- geostrophicEnergy total energy of the geostrophic flow
- inertialEnergy total energy of the inertial flow
- mdaEnergy total energy of the mean density anomaly
- geostrophicKineticEnergy kinetic energy of the geostrophic flow
- waveEnergy total energy of the geostrophic flow
- geostrophicPotentialEnergy potential energy of the geostrophic flow
Index gymnastics
- indexFromKLModeNumber return the linear index into k_wv and l_wv from a mode number
- indexFromModeNumber return the linear index into a spectral matrix given (k,l,j)
- indicesFromDFTGridToWVGrid indices to convert from DFT to WV grid
- indicesFromWVGridToDFTGrid indices to convert from WV to DFT grid
- indicesFromWVGridToFFTWGrid indices to convert from WV to DFT grid
- isValidConjugateKLModeNumber return a boolean indicating whether (k,l) is a valid conjugate WV mode number
- isValidConjugateModeNumber returns a boolean indicating whether (k,l,j) is a valid conjugate mode number
- isValidKLModeNumber return a boolean indicating whether (k,l) is a valid WV mode number
- isValidModeNumber returns a boolean indicating whether (k,l,j) is a valid mode number
- isValidPrimaryKLModeNumber return a boolean indicating whether (k,l) is a valid primary (non-conjugate) WV mode number
- isValidPrimaryModeNumber returns a boolean indicating whether (k,l,j) is a valid primary (non-conjugate) mode number
- klModeNumberFromIndex return mode number from a linear index into a WV matrix
- primaryKLModeNumberFromKLModeNumber takes any valid WV mode number and returns the primary mode number
Masks
- maskForAliasedModes returns a mask with locations of modes that will alias with a quadratic multiplication.
- maskForConjugateFourierCoefficients a mask indicate the components that are redundant conjugates
- maskForNyquistModes returns a mask with locations of modes that are not fully resolved
Developer
- propertyAnnotationsForGeometry return array of CAPropertyAnnotations initialized by default
Internal
- quadraturePointsForStratifiedFlow return the quadrature points for a given stratification
- verticalProjectionOperatorsWithRigidLid return the normalized projection operators with prefactors
Other
- A0N
- A0Z
- ApmD
- ApmN
- FMatrix
- Feta
- FinvMatrix
- Fu
- Fv
- GMatrix
- GinvMatrix
- J
- K
- K2
- Kh
- L
- Lr2
- N2
- N2Function
- NA0
- NAm
- NAp
- Nj
- Nz
- Omega
- P0 Preconditioner for F, size(P)=[Nj 1]. Fu = uhat, (PF)u = Puhat, so ubar==Puhat
- PA0
- PF0 size(PF,PG)=[Nj x Nz]
- PF0inv Transformation matrices
- Q0 Preconditioner for G, size(Q)=[Nj 1]. Geta = etahat, (QG)eta = Qetahat, so etabar==Qetahat.
- QG0
- QG0inv
- UA0
- UAm
- UAp
- VA0
- VAm
- VAp
- WAm
- WAp
- X
- Y
- Z
- beta
- boussinesqTransform
- chebfunForZArray
- classRequiredPropertyNames
- crossSpectrumWithFgTransform
- crossSpectrumWithGgTransform
- dLnN2
- diffX
- diffY
- diffZF
- diffZG
- effectiveJMax
- enstrophyFluxFromF0
- exactPotentialEnstrophy
- exactTotalEnergy
- f
- fluxAtTimeCellArray y0 is a 3x1 cell array
- fluxForForcing
- g
- geometryFromFile
- geometryFromGroup
- h_0 [Nj 1]
- h_pm
- iOmega
- inertialPeriod
- j
- kAxis
- kPseudoRadial
- kljGrid
- lAxis
- latitude
- maxFg
- maxFw
- modeNumberFromIndex
- namesOfRequiredPropertiesForGeometry
- namesOfRequiredPropertiesForRotatingFPlane
- namesOfRequiredPropertiesForTransform
- namesOfTransformVariables
- newNonrequiredPropertyNames
- newRequiredPropertyNames
- planetaryRadius
- propertyAnnotationsForRotatingFPlane
- qgpvFluxFromF0
- requiredPropertiesForGeometryFromGroup
- requiredPropertiesForRotatingFPlaneFromGroup
- requiredPropertiesForTransformFromGroup
- rho0 , dLnN2
- rhoFunction eta_true operation needs rhoFunction
- rho_nm0
- rk4FluxForForcing
- rotationRate
- spatialFluxForForcingWithName
- spatialMatrixSize
- spectralMatrixSize
- spectrumWithFgTransform
- spectrumWithGgTransform
- sumFluxDictionary
- throwErrorIfDensityViolation checks if the proposed coefficients are a valid adiabatic re-arrangement of the base state
- totalEnstrophy
- totalEnstrophySpatiallyIntegrated
- transformFromGroup
- transformFromSpatialDomainWithFio
- transformFromSpatialDomainWithFourier
- transformToSpatialDomainWithFourier
- transformToSpatialDomainWithFourierAtPosition
- transformWithG_wg
- verticalModes
- verticalProjectionOperatorsWithFreeSurface
- volumeIntegral
- waveCoefficientsAtTimeT
- waveVortexTransformWithExplicitAntialiasing
- xyzGrid
- z
- z_int