report.Average

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)

Attributes

start_step: int, optional#

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

Default:

None

end_step: int, optional#

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

Default:

None

start_time: float, optional#

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

Default:

None

end_time: float, optional#

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

Default:

None

fraction: float, optional#

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

Default:

None

Additional Constructors

classmethod from_file(filename)#

Load a Flow360BaseModel from a .json file.

Parameters:

filename (str)

Return type:

Flow360BaseModel

Methods

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

Performs the averaging operation on the provided data.

help(methods=False)#

Print fields and methods of a Flow360BaseModel using rich.

Parameters:

methods (bool)

Return type:

None

to_file(filename, **kwargs)#

Export Flow360BaseModel instance to a .json file.

Parameters:
Return type:

None