ForceDistributionsResultModel#

class ForceDistributionsResultModel[source]#

Bases: NamedResultsCollectionModel

Model for handling results of force distributions.

Attributes

remote_file_name: str, optional#
Default:

None

local_file_name: str#
Default:

None

do_download: bool, optional#
Default:

None

local_storage: str, optional#
Default:

None

get_download_file_list_method: Callable, optional#
Default:

<function NamedResultsCollectionModel.<lambda> at 0x794a4a8a8790>

Properties

names: List[str]#

Get the list of result names.

Returns:

List of result names.

Return type:

list of str

Methods

get_result_by_name(name)#

Get a result by name.

Parameters:

name (str) – The name of the result.

Returns:

The result model corresponding to the given name.

Return type:

ResultCSVModel

Raises:

Flow360ValueError – If the result with the provided name is not found.

download(to_folder='.', overwrite=False)#

Download all result files to the specified location.

Parameters:
  • to_folder (str, optional) – The folder where the files will be downloaded.

  • overwrite (bool, optional) – Flag indicating whether to overwrite existing files.