WVTransform

Represents the state of the ocean in terms of energetically orthogonal wave and geostrophic (vortex) solutions

---

Declaration

classdef WVTransform < handle

Overview

The WVTransform subclasses encapsulate data representing the state of the ocean at a given instant in time. What makes the WVTransform subclasses special is that the state of the ocean is represented as energetically independent waves and geostrophic motions (vortices). These classes can be queried for any ocean state variable including \(u\), \(v\), \(w\), \(\rho\), \(p\), but also Ertel PV, relative vorticity, or custom defined state variables.

The WVTransform is an abstract class and as such you must instatiate one of the concrete subclasses,

• WVTransformConstantStratification
• WVTransformHydrostatic
• WVTransformSingleMode

Topics

• Initialization
  • waveVortexTransformFromFile Initialize a WVTransform instance from an existing file
  • waveVortexTransformWithDoubleResolution create a new WVTransform with double resolution
• Domain attributes
• Initial Conditions
  • addRandomFlow add randomized flow to the existing state
  • addUVEta add \((u,v,\eta)\) to the existing values
  • initFromNetCDFFile initialize the flow from a NetCDF file
  • initWithRandomFlow initialize with a random flow state
  • initWithUVEta initialize with fluid variables \((u,v,\eta)\)
  • initWithUVRho initialize with fluid variables \((u,v,\rho)\)
  • Waves
    • removeAll removes all energy from the model
• Energetics
  • summarizeEnergyContent displays a summary of the energy content of the fluid
  • summarizeModeEnergy List the most energetic modes
• Internal
  • WVTransform initialize a WVTransform instance
  • addToVariableCache add variable to internal cache, in case it is needed again
  • clearVariableCacheOfApAmA0DependentVariables clear the internal cache
  • clearVariableCacheOfTimeDependentVariables clear the internal cache of variables that claim to be time dependent
  • defaultMethodAnnotations return array of WVAnnotations to annotate the methods
  • defaultOperations return array of WVOperation instances initialized by default
  • fetchFromVariableCache retrieve a set of variables from the internal cache
  • performOperation computes (runs) the operation
  • performOperationWithName computes (runs) the operation
• Flow components
  • addFlowComponent add a flow component
  • addPrimaryFlowComponent add a primary flow component, automatically added to the flow
  • flowComponentWithName retrieve a WVFlowComponent by name
  • primaryFlowComponentWithName retrieve a WVPrimaryFlowComponent by name
• Utility function
  • spectralVariableWithResolution create a new variable with different resolution
  • Metadata
    • addOperation add a WVOperation
    • flowComponentNames retrieve the names of all available variables
    • forcingNames retrieve the names of all available variables. This preserves
    • operationWithName retrieve a WVOperation by name
    • primaryFlowComponentNames retrieve the names of all available variables
    • removeOperation remove an existing WVOperation
• Write to file
  • concatenateVariablesAlongTimeDimension Concatenate variables along the time dimension
  • createNetCDFFileForTimeStepOutput Output the WVTransform to file with variable time dimension
  • writeToFile Write this instance to NetCDF file.
• Operations
  • Transformations
    • convertFromWavenumberToFrequency Summary
    • transformUVEtaToWaveVortex transform fluid variables \((u,v,\eta)\) to wave-vortex coefficients \((A_+,A_-,A_0)\).
    • transformWaveVortexToUVWEta transform wave-vortex coefficients \((A_+,A_-,A_0)\) to fluid variables \((u,v,\eta)\).
• Nonlinear flux and energy transfers
  • energyFluxFromNonlinearFlux converts nonlinear flux into energy flux
  • enstrophyFluxFromNonlinearFlux converts nonlinear flux into enstrophy flux
  • nonlinearFluxForFlowComponents returns the flux of each coefficient as determined by the nonlinear flux operation
  • nonlinearFluxWithGradientMasks returns the flux of each coefficient as determined by the nonlinear flux operation
  • nonlinearFluxWithMask returns the flux of each coefficient as determined by the nonlinear flux
• Developer
  • propertyAnnotationsForTransform return array of CAPropertyAnnotations for the WVTransform
• State Variables
  • variableAtPositionWithName Primary method for accessing the dynamical variables on the at any
  • variableWithName Primary method for accessing the dynamical variables
• Other
  • A0 geostrophic coefficients at reference time t0 (m)
  • A0_KE_factor
  • A0_PE_factor
  • A0_Psi_factor
  • A0_QGPV_factor
  • A0_TE_factor
  • A0_TZ_factor
  • Am negative wave coefficients at reference time t0 (m/s)
  • Ap positive wave coefficients at reference time t0 (m/s)
  • Apm_TE_factor
  • addForcing
  • classDefinedOperationForKnownVariable This is one of two functions that returns operations for computing
  • flowComponentNameMap
  • flowComponents
  • forcing
  • forcingNameMap
  • forcingType
  • forcingWithName
  • hasClosure
  • hasForcingWithName
  • hasMeanPressureDifference checks if there is a non-zero mean pressure difference between the top and bottom of the fluid
  • hasPVComponent
  • hasVariableWithName
  • hasWaveComponent
  • initForcingFromNetCDFFile forcingGroupName = join( [string(class(self)),”forcing”],”-“);
  • isHydrostatic
  • nFluxedComponents
  • nonlinearFlux
  • operationForKnownVariable This is one of two functions that returns operations for computing
  • operationNameMap
  • operationVariableNameMap
  • optimizedTransformsForFlowComponent returns optimized transforms that avoid unnecessary computation
  • primaryFlowComponentNameMap
  • primaryFlowComponents
  • propertyAnnotationForKnownVariable This is one of two functions that returns operations for computing
  • removeAllForcing
  • removeForcing
  • restoreForcingAmplitudes
  • rk4NonlinearFlux
  • rk4NonlinearFluxForFlowComponents
  • setForcing
  • spatialDimensionNames
  • spatialFluxForcing
  • spectralAmplitudeForcing
  • spectralDimensionNames
  • spectralFluxForcing
  • summarizeDegreesOfFreedom
  • summarizeFlowComponents
  • summarizeForcing
  • summarizeVariables
  • t
  • t0
  • timeDependentVariablesNameMap
  • totalEnergy
  • totalEnergyOfFlowComponent
  • totalEnergySpatiallyIntegrated
  • totalFlowComponent
  • transformFromSpatialDomainWithFg Required for transformUVEtaToWaveVortex
  • transformFromSpatialDomainWithGg
  • transformToSpatialDomainWithF Required for transformWaveVortexToUVEta
  • transformToSpatialDomainWithFAllDerivatives
  • transformToSpatialDomainWithG
  • transformToSpatialDomainWithGAllDerivatives
  • updateDependentVariablesNameMap
  • variableCache
  • variableNames
  • version
  • waveVortexTransformWithResolution
  • wvCoefficientDependentVariablesNameMap

---