methodAvailable
reduce
Reduce a scalar field expression to a global value. Supported operators are ``average``, ``integral``, ``sum``, ``min`` and ``max``. Integrals and averages are mesh-aware for tetrahedral cells. Pass ``cells`` to restrict the reduction to selected cell indices.
Reference contract
| Field | Value | Description |
|---|---|---|
| symbol | telion_api.Dataset.reduce | — |
| signature | (expression: 'str', operator: 'str' = 'average', location: 'str | None' = None, cells: 'Iterable[int] | None' = None) -> 'float' | — |
| return | float | — |
Reduce a scalar field expression to a global value. Supported operators are average, integral, sum, min and max. Integrals and averages are mesh-aware for tetrahedral cells. Pass cells to restrict the reduction to selected cell indices.
Contract
| Property | Value |
|---|---|
| symbol | telion_api.Dataset.reduce |
| signature | (expression: 'str', operator: 'str' = 'average', location: 'str | None' = None, cells: 'Iterable[int] | None' = None) -> 'float' |
| return | float |
Signature
telion_api.Dataset.reduce(expression: 'str', operator: 'str' = 'average', location: 'str | None' = None, cells: 'Iterable[int] | None' = None) -> 'float'