spamean

ens_calculator.spamean(source_parts: List[ENS_PART] | List[int] | List[str] | ENS_PART | int | str, variable: ENS_VAR | str | int, component: str = '[X]', result_type: str = 'Compute_Per_case', output_varname: str | None = None) → ENS_VAR

Computes a constant variable defined as the volume (or area) weighted mean of the variable specified

Args:

source_parts:

Any part(s) or a part number.

variable:

A scalar or vector variable.

component:

A vector component [X], [Y], [Z] or [] for magnitude.

result_type:

Per/Case or Per/Part Results

output_varname:

The name of the newly created variable

Returns:

New ENS_VAR instance or None

Note:

See SpaMean() for function details.