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)

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

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')