Skip to content

helper

DampingCoefficients dataclass

Terms used to compute damping coefficients.

divg_u instance-attribute

divg_v instance-attribute

del6_u instance-attribute

del6_v instance-attribute

da_min instance-attribute

da_min_c instance-attribute

__init__(divg_u, divg_v, del6_u, del6_v, da_min, da_min_c)

new_from_metric_terms(metric_terms) classmethod

HorizontalGridData dataclass

Terms defining the horizontal grid.

lon instance-attribute

lat instance-attribute

lon_agrid instance-attribute

lat_agrid instance-attribute

area instance-attribute

area_64 instance-attribute

rarea instance-attribute

rarea_c instance-attribute

dx instance-attribute

dy instance-attribute

dxc instance-attribute

dyc instance-attribute

dxa instance-attribute

dya instance-attribute

rdx instance-attribute

rdy instance-attribute

rdxc instance-attribute

rdyc instance-attribute

rdxa instance-attribute

rdya instance-attribute

ee1 instance-attribute

ee2 instance-attribute

es1 instance-attribute

ew2 instance-attribute

a11 instance-attribute

a12 instance-attribute

a21 instance-attribute

a22 instance-attribute

edge_w instance-attribute

edge_e instance-attribute

edge_s instance-attribute

edge_n instance-attribute

__init__(lon, lat, lon_agrid, lat_agrid, area, area_64, rarea, rarea_c, dx, dy, dxc, dyc, dxa, dya, rdx, rdy, rdxc, rdyc, rdxa, rdya, ee1, ee2, es1, ew2, a11, a12, a21, a22, edge_w, edge_e, edge_s, edge_n)

new_from_metric_terms(metric_terms) classmethod

VerticalGridData dataclass

Terms defining the vertical grid.

Eulerian vertical grid is defined by p = ak + bk * p_ref.

ak instance-attribute

bk instance-attribute

Reference pressure (Pa) used to define pressure at vertical interfaces, where p = ak + bk * p_ref.

p_ref property

Reference pressure (Pa)

p_interface property

p property

dp property

ptop property

Top of atmosphere pressure (Pa)

__init__(ak, bk)

new_from_metric_terms(metric_terms) classmethod

from_restart(restart_path, quantity_factory) classmethod

ContravariantGridData dataclass

Grid variables used for converting vectors from covariant to contravariant components.

cosa instance-attribute

cosa_u instance-attribute

cosa_v instance-attribute

cosa_s instance-attribute

sina_u instance-attribute

sina_v instance-attribute

rsina instance-attribute

rsin_u instance-attribute

rsin_v instance-attribute

rsin2 instance-attribute

__init__(cosa, cosa_u, cosa_v, cosa_s, sina_u, sina_v, rsina, rsin_u, rsin_v, rsin2)

new_from_metric_terms(metric_terms) classmethod

AngleGridData dataclass

sin and cos of certain angles used in metric calculations.

Corresponds in the fortran code to sin_sg and cos_sg.

sin_sg1 instance-attribute

sin_sg2 instance-attribute

sin_sg3 instance-attribute

sin_sg4 instance-attribute

sin_sg5 instance-attribute

sin_sg6 instance-attribute

sin_sg7 instance-attribute

sin_sg8 instance-attribute

sin_sg9 instance-attribute

cos_sg1 instance-attribute

cos_sg2 instance-attribute

cos_sg3 instance-attribute

cos_sg4 instance-attribute

cos_sg5 instance-attribute

cos_sg6 instance-attribute

cos_sg7 instance-attribute

cos_sg8 instance-attribute

cos_sg9 instance-attribute

__init__(sin_sg1, sin_sg2, sin_sg3, sin_sg4, sin_sg5, sin_sg6, sin_sg7, sin_sg8, sin_sg9, cos_sg1, cos_sg2, cos_sg3, cos_sg4, cos_sg5, cos_sg6, cos_sg7, cos_sg8, cos_sg9)

new_from_metric_terms(metric_terms) classmethod

GridData

lon property

longitude of cell corners

lat property

latitude of cell corners

lon_agrid property

longitude on the A-grid (cell centers)

lat_agrid property

latitude on the A-grid (cell centers)

fC property

Coriolis parameter at cell corners

fC_agrid property

Coriolis parameter at cell centers

area property

Gridcell area

area_64 property

Gridcell area (64-bit)

rarea property

1 / area

rarea_c property

dx property

distance between cell corners in x-direction

dy property

distance between cell corners in y-direction

dxc property

distance between gridcell centers in x-direction

dyc property

distance between gridcell centers in y-direction

dxa property

distance between centers of west and east edges of gridcell

dya property

distance between centers of north and south edges of gridcell

rdx property

1 / dx

rdy property

1 / dy

rdxc property

1 / dxc

rdyc property

1 / dyc

rdxa property

1 / dxa

rdya property

1 / dya

ee1 property

ee2 property

es1 property

ew2 property

a11 property

a12 property

a21 property

a22 property

edge_w property

edge_e property

edge_s property

edge_n property

p_ref property

reference pressure (Pa) used to define pressure at vertical interfaces, where p = ak + bk * p_ref

p property

Reference pressure profile for Eulerian grid, defined at cell centers.

ak property writable

constant used to define pressure at vertical interfaces, where p = ak + bk * p_ref

bk property writable

constant used to define pressure at vertical interfaces, where p = ak + bk * p_ref

ks property writable

ptop property writable

pressure at top of atmosphere (Pa)

dp_ref property

cosa property

cosa_u property

cosa_v property

cosa_s property

sina_u property

sina_v property

rsina property

rsin_u property

rsin_v property

rsin2 property

sin_sg1 property

sin_sg2 property

sin_sg3 property

sin_sg4 property

sin_sg5 property

sin_sg6 property

sin_sg7 property

sin_sg8 property

sin_sg9 property

cos_sg1 property

cos_sg2 property

cos_sg3 property

cos_sg4 property

cos_sg5 property

cos_sg6 property

cos_sg7 property

cos_sg8 property

cos_sg9 property

__init__(horizontal_data, vertical_data, contravariant_data, angle_data, fc=None, fc_agrid=None)

new_from_metric_terms(metric_terms) classmethod

DriverGridData dataclass

Terms used to Apply Physics changes to the Dycore. Attributes: vlon1: x-component of unit lon vector in eastward longitude direction vlon2: y-component of unit lon vector in eastward longitude direction vlon3: z-component of unit lon vector in eastward longitude direction vlat1: x-component of unit lat vector in northward latitude direction vlat2: y-component of unit lat vector in northward latitude direction vlat3: z-component of unit lat vector in northward latitude direction edge_vect_w: factor to interpolate A to C grids at the western grid edge edge_vect_e: factor to interpolate A to C grids at the easter grid edge edge_vect_s: factor to interpolate A to C grids at the southern grid edge edge_vect_n: factor to interpolate A to C grids at the northern grid edge es1_1: x-component of grid local unit vector in x-direction at cell edge es1_2: y-component of grid local unit vector in x-direction at cell edge es1_3: z-component of grid local unit vector in x-direction at cell edge ew2_1: x-component of grid local unit vector in y-direction at cell edge ew2_2: y-component of grid local unit vector in y-direction at cell edge ew2_3: z-component of grid local unit vector in y-direction at cell edge

vlon1 instance-attribute

vlon2 instance-attribute

vlon3 instance-attribute

vlat1 instance-attribute

vlat2 instance-attribute

vlat3 instance-attribute

edge_vect_w instance-attribute

edge_vect_e instance-attribute

edge_vect_s instance-attribute

edge_vect_n instance-attribute

es1_1 instance-attribute

es1_2 instance-attribute

es1_3 instance-attribute

ew2_1 instance-attribute

ew2_2 instance-attribute

ew2_3 instance-attribute

grid_type instance-attribute

__init__(vlon1, vlon2, vlon3, vlat1, vlat2, vlat3, edge_vect_w, edge_vect_e, edge_vect_s, edge_vect_n, es1_1, es1_2, es1_3, ew2_1, ew2_2, ew2_3, grid_type)

new_from_metric_terms(metric_terms) classmethod

new_from_grid_variables(vlon, vlat, edge_vect_n, edge_vect_s, edge_vect_e, edge_vect_w, es1, ew2, grid_type=0) classmethod

split_quantity_along_last_dim(quantity)

Split a quantity along the last dimension into a list of quantities.

Parameters:

Name Type Description Default
quantity Quantity

Quantity to split.

 required

Returns:

Type Description
list[Quantity]

list[Quantity]: List of quantities.