Model.hm_getaverageelemsize#

Model.hm_getaverageelemsize(elems_collection, panel_sensitive_deprecated=1, round_to=0, size_mode=0, limit_range_percent=0.0)#

Returns the average element size for shell elements. This function calculates the average element size using the following formula:

  • quad elements: \(average\ size\ of\ one\ element\ = \sqrt{1/2 * longest\ diagonal\ * \sum parallel\ altitudes\ }\)

  • tria elements: \(average\ size\ of\ one\ element\ = \sqrt{area}\)

The total average size is then calculated by summing each average size and dividing by the number of elements considered.

Parameters:

  • elems_collection (Collection) – The collection containing the shell element entities to return the average element size.

  • panel_sensitive_deprecated (int) – Deprecated. Always set to 0.

  • round_to (int) –

    0 - Round up to 3 significant digits (default).

    1 - Do not round.

  • int (size_mode) –

    Valid modes are:

    0 - Average element size by area

    1 - Average element size by edge length

    2 - Average minimum element size

    3 - Average maximum element size

  • float (limit_range_percent) –

    Valid only for size_mode 1 and 2.

    For mode 2, min_element_size_limit is output so that limit_range_percent of elements has min_element_size >= min_element_size_limit.

    For mode 3, max_element_size_limit is output so that limit_range_percent of elements has max_element_size <= max_element_size_limit.

Returns:

Example#

Get the average element size for elements with IDs 1 - 100#
import hm
import hm.entities as ent

model = hm.Model()

element_collection = hm.Collection(model, ent.Element, list(range(1, 101)))

_, result = model.hm_getaverageelemsize(elems_collection=element_collection)

print("Average Element Size:", result.averageElemSize)