pycsa.core.physics

Classes

ideal_pmf(**kwarg)

Helper class to compute the idealised pseudo-momentum fluxes under one setting.
class pycsa.core.physics.ideal_pmf(**kwarg)

Helper class to compute the idealised pseudo-momentum fluxes under one setting.

__init__(**kwarg)

Sets up the default values

Parameters:

**kwarg (any) – user-defined values to replace the default background wind (U zonal, V meridional), Earth’s radius (AE), and Brunt-Väisälä frequency (N)

compute_uw_pmf(analysis, summed=True)

Computation method

Parameters:

  • analysis (pycsa.data.results.analysis) – instance of the analysis class.

  • summed (bool, optional) – by default True, i.e., returns the scalar sum of the spectrum. Otherwise, returns the per-mode array uw_pmf (2-D, shaped like the kks/lls wavenumber meshgrids).

Returns:

depends on the value of summed

Return type:

array-like or float