Dimensions

InvertedTruncatedCone

Calculates the volume and surface area of an inverted truncated cone.

Useful for calculating the A and H morphometry parameters for simple water bodies. Assumes only the height (i.e., depth), side slope, and surface radius of the water body are known.

Attributes:

Name	Type	Description
height	Union[float, int]	Height of the water body from the base to surface in metres.
surface_radius	Union[float, int]	Surface radius of the water body in metres.
num_vals	int	The number of values to be returned by the get_volumes(), get_surface_areas(), and get_heights() methods. num_vals should be the same as the bsn_vals parameter from the &morphometry block and be >= 2.
side_slope	Union[float, int]	Side slope of water body - the rise over run (metre/metre).
surface_elevation	float	Elevation at the water body surface. Shifts the values returned by get_heights() up or down.

get_heights()

Calculates heights.

Returns a list of heights (m) from base to surface. The number of heights is determined by the num_vals attribute. Heights can be adjusted for different surface elevations by increasing or decreasing the surface_elevation attribute.

Returns:

Name	Type	Description
heights	list	Heights (m) from base to surface.

get_surface_areas()

Calculates surface areas.

Returns a list of surface areas (m^2) that correspond with the heights returned by get_heights(). The length of the list is determined by the num_vals attribute. Surface areas are returned as a list of floats where the first item is the area at the bottom of the water body and the last is the area at the surface.

Returns:

Name	Type	Description
surface_areas	list	Surface areas of water body (m^2).

get_volumes()

Calculates volumes

Returns a list of volumes (m^3) that correspond with the heights returned by get_heights(). The length of the list equals the num_vals attribute. Volumes are returned as a list where the first item is the volume at the bottom of the water body and the last is the volume at the surface.

Returns:

Name	Type	Description
volume	list	The water body volumes (m^3).

InvertedTruncatedPyramid

Calculates the volume and surface area of an inverted truncated pyramid.

Useful for calculating the A and H morphometry parameters for simple water bodies such as reservoirs. Assumes only the height (i.e., depth), side slope, surface length, and surface width of the water body are known.

Attributes:

Name	Type	Description
height	Union[float, int]	Height of water body from the base to surface in metres.
surface_length	Union[float, int]	Surface length of the water body in metres.
surface_width	Union[float, int]	Surface width of the water body in metres.
num_vals	int	The number of values to be returned by the get_volumes(), get_surface_areas(), and get_heights() methods. num_vals should be the same as the bsn_vals parameter from the &morphometry block and be >= 2.
side_slope	Union[float, int]	Side slope of water body - the rise over run (metre/metre).
surface_elevation	float	Elevation at the water body surface. Shifts the values returned by get_heights() up or down.

get_heights()

Calculates heights.

Returns a list of heights (m) from base to surface. The number of heights is determined by the num_vals attribute. Heights can be adjusted for different surface elevations by increasing or decreasing the surface_elevation attribute.

Returns:

Name	Type	Description
heights	list	Heights (m) from base to surface.

get_surface_areas()

Calculates surface areas.

Returns a list of surface areas (m^2) that correspond with the heights returned by get_heights(). The length of the list is determined by the num_vals attribute. Surface areas are returned as a list of floats where the first item is the area at the bottom of the water body and the last is the area at the surface.

Returns:

Name	Type	Description
surface_areas	list	Surface areas of water body (m^2).

get_volumes()

Calculates volumes.

Returns a list of volumes (m^3) that correspond with the heights returned by get_heights(). The length of the list equals the num_vals attribute. Volumes are returned as a list where the first item is the volume at the bottom of the water body and the last is the volume at the surface.

Returns:

Name	Type	Description
volume	list	The water body volumes (m^3).