Skip to content

helper

AngleGridData dataclass

sin and cos of certain angles used in metric calculations.

Corresponds in the fortran code to sin_sg and cos_sg.

ContravariantGridData dataclass

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

DampingCoefficients dataclass

Terms used to compute damping coefficients.

DriverGridData dataclass

Terms used to Apply Physics changes to the Dycore.

Attributes:

Name Type Description
vlon1 Quantity

x-component of unit lon vector in eastward longitude direction
vlon2 Quantity

y-component of unit lon vector in eastward longitude direction
vlon3 Quantity

z-component of unit lon vector in eastward longitude direction
vlat1 Quantity

x-component of unit lat vector in northward latitude direction
vlat2 Quantity

y-component of unit lat vector in northward latitude direction
vlat3 Quantity

z-component of unit lat vector in northward latitude direction
edge_vect_w Quantity

factor to interpolate A to C grids at the western grid edge
edge_vect_e Quantity

factor to interpolate A to C grids at the easter grid edge
edge_vect_s Quantity

factor to interpolate A to C grids at the southern grid edge
edge_vect_n Quantity

factor to interpolate A to C grids at the northern grid edge
es1_1 Quantity

x-component of grid local unit vector in x-direction at cell edge
es1_2 Quantity

y-component of grid local unit vector in x-direction at cell edge
es1_3 Quantity

z-component of grid local unit vector in x-direction at cell edge
ew2_1 Quantity

x-component of grid local unit vector in y-direction at cell edge
ew2_2 Quantity

y-component of grid local unit vector in y-direction at cell edge
ew2_3 Quantity

z-component of grid local unit vector in y-direction at cell edge

GridData

ak property writable

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

area property

Gridcell area

area_64 property

Gridcell area (64-bit)

bk property writable

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

dx property

distance between cell corners in x-direction

dxa property

distance between centers of west and east edges of gridcell

dxc property

distance between gridcell centers in x-direction

dy property

distance between cell corners in y-direction

dya property

distance between centers of north and south edges of gridcell

dyc property

distance between gridcell centers in y-direction

fC property

Coriolis parameter at cell corners

fC_agrid property

Coriolis parameter at cell centers

lat property

latitude of cell corners

lat_agrid property

latitude on the A-grid (cell centers)

lon property

longitude of cell corners

lon_agrid property

longitude on the A-grid (cell centers)

p property

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

p_ref property

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

ptop property writable

pressure at top of atmosphere (Pa)

rarea property

1 / area

rdx property

1 / dx

rdxa property

1 / dxa

rdxc property

1 / dxc

rdy property

1 / dy

rdya property

1 / dya

rdyc property

1 / dyc

HorizontalGridData dataclass

Terms defining the horizontal grid.

VerticalGridData dataclass

Terms defining the vertical grid.

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

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)

ptop property

Top of atmosphere pressure (Pa)

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.