Class EddySignature

Class Documentation

class EddySignature

Data container for Eddy signature tensors.

Public Functions

void load(std::string file_name, bool print_var = false)

Load data from a *.mat file containing eddy signature data.

TODO overload with load(std::vector<std::string> file_names, bool print_var = false){} to load and average multiple signature files

Parameters
  • file_name: File name (including relative or absolute path)
  • print_var: Boolean, default true. Print variables as they are read in (not advised except for debugging!)

void save(std::string filename)

Save eddy signature data to a *.mat file.

Note
NOT IMPLEMENTED YET
Parameters
  • filename: File name (including relative or absolute path)

EddySignature operator+(const EddySignature &c) const

Define overloaded + (plus) operator for eddy signatures.

Return
A new EddySignature() with combined signatures of the two eddy types.
Parameters

EddySignature operator/(double denom) const

Define overloaded / (divide) operator for eddy signatures.

Return
A new EddySignature() whose signature (g, j) is element-wise divided by input denom.
Parameters
  • denom: A number to divide by

Public Members

std::string eddy_type

Eddy types used to create the results.

Eigen::VectorXd lambda

Mapped vertical coordinates used in the analysis (e.g. 1 x 50)

Eigen::ArrayXXd k1z

Wavenumber (wavenumber space for each vertical coord, e.g. 50 x 801)

Eigen::Tensor<double, 3> g

g (6 coefficients at each vertical coord and wavenumber, e.g 50 x 801 x 6)

Eigen::ArrayXXd j

J (6 coefficients at each vertical coord, e.g 50 x 6)