flow360.report.Average

class Average

Bases: GenericOperation

Represents an averaging operation on simulation results.

This operation calculates the average of a given data set over a specified range of steps, time, or fraction of the dataset.

Raises:

NotImplementedError – If the method of averaging (e.g., step-based or time-based) is not implemented or the data type is unsupported.

Example

avg = Average(fraction=0.1) result = avg.calculate(data, case, cases, variables, new_variable_name)

start_step: pd.NonNegativeInt | None = None

The starting step for averaging. If not specified, averaging starts from the beginning.

end_step: pd.NonNegativeInt | None = None

The ending step for averaging. If not specified, averaging continues to the end.

start_time: pd.NonNegativeFloat | None = None

The starting time for averaging. If not specified, averaging starts from the beginning.

end_time: pd.NonNegativeFloat | None = None

The ending time for averaging. If not specified, averaging continues to the end.

fraction: pd.PositiveFloat | None = None

The fraction of the dataset to be averaged, ranging from 0 to 1. Only the fraction-based method is implemented.

Constraints:

• le = 1

type_name: Literal['Average'] = 'Average'

calculate(data, case, cases, variables, new_variable_name)

Performs the averaging operation on the provided data.