Case

class Case

Bases: CaseBase, Flow360Resource

Case component

Properties

params: Flow360Params | SimulationParams

returns case params

params_as_dict: dict

returns case params as dictionary

parent: Case

parent case

Returns:

parent case object

Return type:

Case

Raises:

RuntimeError – When case does not have parent

info: CaseMetaV2

returns metadata info for case

info_v2: CaseMetaV2

returns metadata v2 info for case

project_id: str | None

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

tags: List[str]

get case tags

volume_mesh: VolumeMeshV2

returns volume mesh

volume_mesh_id

returns volume mesh id

results: CaseResultsModel

returns results object to managing case results

Additional Constructors

classmethod from_cloud(case_id)

get case from cloud

Parameters:

case_id (str)

classmethod from_local_storage(local_storage_path, meta_data)

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

Methods

get_simulation_params()

returns simulation params

has_parent()

Check if case has parent case

Returns:

True when case has parent, False otherwise

Return type:

bool

is_steady()

returns True when case is steady state

has_actuator_disks()

returns True when case has actuator disk

has_bet_disks()

returns True when case has BET disk

has_isosurfaces()

returns True when case has isosurfaces

has_monitors()

returns True when case has monitors

has_volume_output()

returns True when case has volume output

has_aeroacoustics()

returns True when case has aeroacoustics

has_user_defined_dynamics()

returns True when case has user defined dynamics

has_custom_forces()

returns True when case has custom forces

has_force_distributions()

returns True when case has force distributions

move_to_folder(folder)

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)

Rename the current case.

Parameters:

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

classmethod create(name, params, volume_mesh_id=None, tags=None, parent_id=None, other_case=None, parent_case=None, solver_version=None)

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

retry(name=None, params=None, solver_version=None, tags=None)

Retry case :param name: :param params: :param tags: :return:

Parameters:

• name (str | None)

• params (Flow360Params | None)

• solver_version (str | None)

• tags (List[str] | None)

Return type:

CaseDraft

continuation(name=None, params=None, tags=None)

Alias for fork a case to continue simulation :param name: :param params: :param tags: :return:

Parameters:

• name (str | None)

• params (Flow360Params | None)

• tags (List[str] | None)

Return type:

CaseDraft

fork(name=None, params=None, tags=None)

Fork a case to continue simulation :param name: :param params: :param tags: :return:

Parameters:

• name (str | None)

• params (Flow360Params | None)

• tags (List[str] | None)

Return type:

CaseDraft