report.SubsetLimit

report.SubsetLimit#

class SubsetLimit#

Bases: Flow360BaseModel

Class for setting up ylim in Chart2D by providing a subset of values and an offset, which will be applied to the range of y values.

Attributes

subset: tuple[float, float]#

Tuple of fractions between 0 and 1 describing the lower and upper range of the subset of values that will be used to calculate the ylim.

offset: float#

“Padding” that will be added to the top and bottom of the charts y_range. It scales with with calculated range of y values. For example, if range of y value is 10, an offset=0.3 will “expand” the range by 0.3*10 on both sides, resulting in a final range of y values equal to 16.

Additional Constructors

classmethod from_file(filename)#

Load a Flow360BaseModel from a .json file.

Parameters:

filename (str)

Return type:

Flow360BaseModel

Methods

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