flow360.Case

flow360.Case#

class Case[source]#

Bases: CaseBase, Flow360Resource

Case component

get_simulation_params()[source]#

returns simulation params

property params: Flow360Params | SimulationParams#

returns case params

property params_as_dict: dict#

returns case params as dictionary

has_parent()[source]#

Check if case has parent case

Returns:

True when case has parent, False otherwise

Return type:

bool

property parent: Case#

parent case

Returns:

parent case object

Return type:

Case

Raises:

RuntimeError – When case does not have parent

property info: CaseMetaV2#

returns metadata info for case

property info_v2: CaseMetaV2#

returns metadata v2 info for case

property project_id: str | None#

Returns the project id of the case if case was run with V2 interface.

property tags: List[str]#

get case tags

property volume_mesh: VolumeMeshV2#

returns volume mesh

property volume_mesh_id#

returns volume mesh id

property results: CaseResultsModel#

returns results object to managing case results

is_steady()[source]#

returns True when case is steady state

has_actuator_disks()[source]#

returns True when case has actuator disk

has_bet_disks()[source]#

returns True when case has BET disk

has_isosurfaces()[source]#

returns True when case has isosurfaces

has_monitors()[source]#

returns True when case has monitors

has_volume_output()[source]#

returns True when case has volume output

has_aeroacoustics()[source]#

returns True when case has aeroacoustics

has_user_defined_dynamics()[source]#

returns True when case has user defined dynamics

move_to_folder(folder)[source]#

Move the current case to the specified folder.

Parameters:

folder (Folder) – The destination folder where the item will be moved.

Returns:

Returns the modified item after it has been moved to the new folder.

Return type:

self

Notes

This method sends a REST API request to move the current item to the specified folder. The folder parameter should be an instance of the Folder class with a valid ID.

rename(new_name)[source]#

Rename the current case.

Parameters:

new_name (str) – The new name for the case.

classmethod from_cloud(case_id)[source]#

get case from cloud

Parameters:

case_id (str)

classmethod from_local_storage(local_storage_path, meta_data)[source]#

Create a Case instance from local storage.

Parameters:

  • local_storage_path (str) – The path to the local storage directory.

  • meta_data (CaseMeta) –

    Case metadata containing:

    • id (str): The unique identifier for the case.

    • name (str): The name of the case.

    • user_id (str): The user ID associated with the case, can be “local”.

Returns:

An instance of Case with data loaded from local storage.

Return type:

Case

classmethod create(name, params, volume_mesh_id=None, tags=None, parent_id=None, other_case=None, parent_case=None, solver_version=None)[source]#

Create new case :param name: :param params: :param volume_mesh_id: :param other_case: :param tags: :param parent_id: :param parent_case: :return:

Parameters:

  • name (str)

  • params (Flow360Params)

  • volume_mesh_id (str | None)

  • tags (List[str] | None)

  • parent_id (str | None)

  • other_case (Case | None)

  • parent_case (Case | None)

  • solver_version (str | None)

Return type:

CaseDraft