Skip to content

generation

MetricTerms

a11 property

0.5*z22/sin_sg5

a12 property

0.5*z21/sin_sg5

a21 property

0.5*z12/sin_sg5

a22 property

0.5*z11/sin_sg5

agrid_lon_lat property

The longitudes and latitudes of the cell centers.

ak property

The ak coefficient used to calculate the pressure at a given k-level:

pk = ak + (bk * ps)

area property

The area of each a-grid cell.

area64 property

The area of each a-grid cell, at 64-bit precision.

area_c property

The area of each c-grid cell.

bk property

The bk coefficient used to calculate the pressure at a given k-level:

pk = ak + (bk * ps)

cos_sg1 property

Cosine of the angle at point 1 of the 'supergrid' within each grid cell:

9---4---8
|       |
1   5   3
|       |
6---2---7

cos_sg2 property

Cosine of the angle at point 2 of the 'supergrid' within each grid cell:

9---4---8
|       |
1   5   3
|       |
6---2---7

cos_sg3 property

Cosine of the angle at point 3 of the 'supergrid' within each grid cell:

9---4---8
|       |
1   5   3
|       |
6---2---7

cos_sg4 property

Cosine of the angle at point 4 of the 'supergrid' within each grid cell:

9---4---8
|       |
1   5   3
|       |
6---2---7

cos_sg5 property

Cosine of the angle at point 5 of the 'supergrid' within each grid cell:

9---4---8
|       |
1   5   3
|       |
6---2---7

The inner product of ec1 and ec2 for point 5

cos_sg6 property

Cosine of the angle at point 6 of the 'supergrid' within each grid cell:

9---4---8
|       |
1   5   3
|       |
6---2---7

cos_sg7 property

Cosine of the angle at point 7 of the 'supergrid' within each grid cell:

9---4---8
|       |
1   5   3
|       |
6---2---7

cos_sg8 property

Cosine of the angle at point 8 of the 'supergrid' within each grid cell:

9---4---8
|       |
1   5   3
|       |
6---2---7

cos_sg9 property

Cosine of the angle at point 9 of the 'supergrid' within each grid cell:

9---4---8
|       |
1   5   3
|       |
6---2---7

cosa property

Cosine of angle between coordinate lines at the cell corners.

Averaged to ensure consistent answers.

cosa_s property

as cosa but defined at cell centers

Averaged to ensure consistent answers.

cosa_u property

Cosine of angle between coordinate lines at the left and right cell edges.

Averaged to ensure consistent answers.

cosa_v property

Cosine of angle between coordinate lines at the top and bottom cell edges.

Averaged to ensure consistent answers.

da_max property

Fhe maximum agrid cell area across all ranks.

Ff mpi is not present and the communicator is a DummyComm this will be the maximum on the local rank.

da_max_c property

The maximum cgrid cell area across all ranks.

If mpi is not present and the communicator is a DummyComm this will be the maximum on the local rank.

da_min property

The minimum agrid cell area across all ranks.

If mpi is not present and the communicator is a DummyComm this will be the minimum on the local rank.

da_min_c property

The minimum cgrid cell area across all ranks.

If mpi is not present and the communicator is a DummyComm this will be the minimum on the local rank.

del6_u property

sina_v * dx/dyc

del6_v property

sina_u * dy/dxc

dgrid_lon_lat property

The longitudes and latitudes of the cell corners.

divg_u property

sina_v * dyc/dx

divg_v property

sina_u * dxc/dy

dx property

The distance between grid corners along the x-direction.

dxa property

The with of each grid cell along the x-direction.

dxc property

The distance between cell centers along the x-direction.

dy property

The distance between grid corners along the y-direction.

dya property

The with of each grid cell along the y-direction.

dyc property

The distance between cell centers along the y-direction.

ec1 property

Cartesian components of the local unit vector in the x-direction at the cell centers.

3d array whose last dimension is length 3 and indicates cartesian x/y/z value.

ec2 property

Cartesian components of the local unit vector in the y-direction at the cell centers.

3d array whose last dimension is length 3 and indicates cartesian x/y/z value.

edge_e property

Factor to interpolate scalars from a to c grid at the eastern grid edge.

edge_n property

Factor to interpolate scalars from a to c grid at the northern grid edge.

edge_s property

Factor to interpolate scalars from a to c grid at the southern grid edge.

edge_vect_e property

Factor to interpolate vectors from a to c grid at the eastern grid edge repeated in x and y to be used in stencils.

edge_vect_e_1d property

Factor to interpolate vectors from a to c grid at the eastern grid edge.

edge_vect_n property

Factor to interpolate vectors from a to c grid at the northern grid edge.

edge_vect_s property

Factor to interpolate vectors from a to c grid at the southern grid edge.

edge_vect_w property

Factor to interpolate vectors from a to c grid at the western grid edge repeated in x and y to be used in stencils.

edge_vect_w_1d property

Factor to interpolate vectors from a to c grid at the western grid edge.

edge_w property

Factor to interpolate scalars from a to c grid at the western grid edge.

ee1 property

Cartesian components of the local unit vetcor in the x-direation at the cell corners.

3d array whose last dimension is length 3 and indicates cartesian x/y/z value.

ee2 property

Cartesian components of the local unit vetcor in the y-direation at the cell corners.

3d array whose last dimension is length 3 and indicates cartesian x/y/z value.

es1 property

Cartesian components of the local unit vetcor in the x-direation at the top/bottom cell edges.

3d array whose last dimension is length 3 and indicates cartesian x/y/z value.

es2 property

Cartesian components of the local unit vetcor in the y-direation at the top/bottom cell edges.

3d array whose last dimension is length 3 and indicates cartesian x/y/z value.

ew1 property

Cartesian components of the local unit vector in the x-direction at the left/right cell edges.

3d array whose last dimension is length 3 and indicates cartesian x/y/z value.

ew2 property

Cartesian components of the local unit vector in the y-direction at the left/right cell edges.

3d array whose last dimension is length 3 and indicates cartesian x/y/z value.

ks property

Number of levels where the vertical coordinate is purely pressure-based.

l2c_u property

Angular momentum correction for converting u-winds from lat/lon to cartesian coordinates.

l2c_v property

Angular momentum correction for converting v-winds from lat/lon to cartesian coordinates.

ptop property

The pressure of the top of atmosphere level.

rarea cached property

1/cell area

rarea_c cached property

1/cgrid cell area

rdx cached property

1/dx

rdxa cached property

1/dxa

rdxc cached property

1/dxc

rdy cached property

1/dy

rdya cached property

1/dya

rdyc cached property

1/dyc

rsin2 property

1/sin_sg5**2, defined as the inverse-squrared as it is only used as such

rsin_u property

1/sina_u**2, defined as the inverse-squrared as it is only used as such

rsin_v property

1/sina_v**2, defined as the inverse-squrared as it is only used as such

rsina property

1/sina**2, defined as the inverse-squrared as it is only used as such

sin_sg1 property

Sine of the angle at point 1 of the 'supergrid' within each grid cell:

9---4---8
|       |
1   5   3
|       |
6---2---7

sin_sg2 property

Sine of the angle at point 2 of the 'supergrid' within each grid cell:

9---4---8
|       |
1   5   3
|       |
6---2---7

sin_sg3 property

Sine of the angle at point 3 of the 'supergrid' within each grid cell:

9---4---8
|       |
1   5   3
|       |
6---2---7

sin_sg4 property

Sine of the angle at point 4 of the 'supergrid' within each grid cell:

9---4---8
|       |
1   5   3
|       |
6---2---7

sin_sg5 property

Sine of the angle at point 5 of the 'supergrid' within each grid cell:

9---4---8
|       |
1   5   3
|       |
6---2---7

For the center point this is one minus the inner product of ec1 and ec2 squared

sin_sg6 property

Sine of the angle at point 6 of the 'supergrid' within each grid cell:

9---4---8
|       |
1   5   3
|       |
6---2---7

sin_sg7 property

Sine of the angle at point 7 of the 'supergrid' within each grid cell:

9---4---8
|       |
1   5   3
|       |
6---2---7

sin_sg8 property

Sine of the angle at point 8 of the 'supergrid' within each grid cell:

``` 9---4---8 | | 1 5 3 | | 6---2---7

sin_sg9 property

Sine of the angle at point 9 of the 'supergrid' within each grid cell:

9---4---8
|       |
1   5   3
|       |
6---2---7

sina property

Sine of angle between coordinate lines at the cell corners.

Averaged to ensure consistent answers.

sina_u property

Sine of angle between coordinate lines at the left and right cell edges.

Averaged to ensure consistent answers.

sina_v property

Sine of angle between coordinate lines at the top and bottom cell edges.

Averaged to ensure consistent answers.

vlat property

Unit vector in northward latitude direction.

3d array whose last dimension is length 3 and indicates x/y/z value.

vlon property

Unit vector in eastward longitude direction.

3d array whose last dimension is length 3 and indicates x/y/z value.

z11 property

Vector product of horizontal component of the cell-center vector with the unit longitude vector.

z12 property

Vector product of horizontal component of the cell-center vector with the unit latitude vector.

z21 property

Vector product of vertical component of the cell-center vector with the unit longitude vector.

z22 property

Vector product of vertical component of the cell-center vector with the unit latitude vector.

from_external(x, y, quantity_factory, communicator, grid_type, eta_file=None) classmethod

Generates a metric terms object, using input from data contained in an externally generated tile file.

quantity_cast_to_model_float(quantity_factory, qty_64)

Copy & cast from 64-bit float to model precision if need be.