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)

Loads a Flow360BaseModel from .json, or .yaml file.

Parameters:

filename (str) – Full path to the .yaml or .json file to load the Flow360BaseModel from.

Returns:

An instance of the component class calling load.

Return type:

Flow360BaseModel

Example

>>> params = Flow360BaseModel.from_file(filename='folder/sim.json') 

Methods

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

Performs the averaging operation on the provided data.

help(methods=False)

Prints message describing the fields and methods of a Flow360BaseModel.

Parameters:

methods (bool = False) – Whether to also print out information about object’s methods.

Return type:

None

Example

>>> params.help(methods=True) 

to_file(filename, **kwargs)

Exports Flow360BaseModel instance to .json or .yaml file

Parameters:

filename (str) – Full path to the .json or .yaml or file to save the Flow360BaseModel to.

Return type:

None

Example

>>> params.to_file(filename='folder/flow360.json')