flow360.report.Delta

flow360.report.Delta#

class Delta#

Bases: Flow360BaseModel

Represents a delta calculation between a reference case and a target case based on specified data.

data: str | DataItem [Required]#

Path to the data item used for delta calculation.

ref_index: pd.NonNegativeInt | None = 0#

Index of the reference case in the list of cases for comparison.

type_name: Literal['Delta'] = 'Delta'#
calculate(case, cases)#

Calculates the delta between the specified case and the reference case.

Parameters:

  • case (Case) – The target case for which the delta is calculated.

  • cases (List[Case]) – A list of available cases, including the reference case.

Returns:

The computed delta value between the case and reference case data.

Return type:

float

Raises:

ValueError – If ref_index is out of bounds or None, indicating a missing reference.