report.FixedRangeLimit

class FixedRangeLimit

Bases: Flow360BaseModel

Class for setting up ylim in Chart2D by providing a fixed range of y values and strategy for centering.

Attributes

fixed_range: float

Range of absolute y values that will be visible on the chart. For example, fixed_range=3 means that y_max - y_min = 3.

center_fraction: float, optional

Used alongside center_strategy=”last_percent”, describes values that will be taken into account for calculating ylim. For example, center_fraction=0.3 means that the last 30% of data will be used.

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

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