uxarray.Grid.calculate_total_face_area

uxarray.Grid.calculate_total_face_area#

Grid.calculate_total_face_area(quadrature_rule='triangular', order=4, latitude_adjusted_area=False)#

Calculate the total surface area of all the faces in a mesh.

Equivalent to self.compute_face_areas(...).sum(); provided as a convenience. (Note: for HEALPix grids, when called with default arguments, this method actually returns self.face_areas.sum() instead, which respects HEALPix equal-area property.)

Additionally, raises a warning if the result is larger than the total area of a sphere (4 * pi * self.sphere_radius**2).

Parameters:
  • quadrature_rule (str, optional) – Quadrature rule to use, one of "triangular" or "gaussian". Defaults to "triangular". See compute_face_areas() for what these mean and the supported orders.

  • order (int, optional) – Order of the quadrature rule. Defaults to 4.

  • latitude_adjusted_area (bool, optional) – If True, corrects the area of faces that have edges lying along a line of constant latitude. Defaults to False.

Returns:

Sum of the area of all faces in the mesh.

Return type:

float