The default_variables module.

This module implements functions to return default variable lists for subfilter.subfilter.

New at 0.5

1. Relocated to subfilter.utils.

Detailed Module Contents

The entire module is documented below.

Created on Mon Aug 2 12:09:37 2021.

@author: Peter Clark

subfilter.utils.default_variables.get_default_variable_list()

Provide default variable list.

Returns

Return type

var_list.

The default is:

var_list = [
       "u",
       "v",
       "w",
       "th",
       "th_v",
       "th_L",
       "q_vapour",
       "q_cloud_liquid_mass",
       "q_total"]

@author: Peter Clark

subfilter.utils.default_variables.get_default_variable_pair_list()

Provide default variable pair list.

Returns

list

Return type

list of lists of pairs strings representing variable names.

The default is:

var_list = [
        ["u","u"],
        ["u","v"],
        ["u","w"],
        ["v","v"],
        ["v","w"],
        ["w","w"],
        ["u","th"],
        ["v","th"],
        ["w","th"],
        ["u","th_v"],
        ["v","th_v"],
        ["w","th_v"],
        ["u","th_L"],
        ["v","th_L"],
        ["w","th_L"],
        ["u","q_vapour"],
        ["v","q_vapour"],
        ["w","q_vapour"],
        ["u","q_cloud_liquid_mass"],
        ["v","q_cloud_liquid_mass"],
        ["w","q_cloud_liquid_mass"],
        ["u","q_total"],
        ["v","q_total"],
        ["w","q_total"],
        ["th_L","th_L"],
        ["th_L","q_total"],
        ["q_total","q_total"],
        ["th_L","q_vapour"],
        ["th_L","q_cloud_liquid_mass"],
      ]

@author: Peter Clark