flow360.Case

class Case

Bases: CaseBase, Flow360Resource

Case component

Attributes

id	returns id of resource
info	returns metadata info for case
name	returns name of resource
params	returns case params
params_as_dict	returns case params as dictionary
parent	parent case
results	returns results object to managing case results
solver_version	returns solver version of resource
status	returns status for resource
volume_mesh_id	returns volume mesh id

Methods

__init__(id)
complete_multipart_upload(remote_file_name, ...)	Completes a multipart upload for the specified remote file name and upload ID.
continuation([name, params, tags])	Alias for fork a case to continue simulation :param name: :param params: :param tags: :return:
copy([name, params, solver_version, tags])	Alias for retry case :param name: :param params: :param tags: :return:
create(name, params[, volume_mesh_id, tags, ...])	Create new case :param name: :param params: :param volume_mesh_id: :param other_case: :param tags: :param parent_id: :param parent_case: :return:
create_multipart_upload(remote_file_name)	Creates a multipart upload for the specified remote file name and file.
delete([path, method])	Resource delete
fork([name, params, tags])	Fork a case to continue simulation :param name: :param params: :param tags: :return:
from_cloud(case_id)	get case from cloud
get([path, method, json, params])	Resource get
get_download_file_list()	return list of files available for download
get_info([force])	returns metadata info for resource
has_actuator_disks()	returns True when case has actuator disk
has_aeroacoustics()	returns True when case has aeroacoustics
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_parent()	Check if case has parent case
has_user_defined_dynamics()	returns True when case has user defined dynamics
is_cloud_resource()	returns true if is cloud resource
is_finished()	returns False when case is in running or preprocessing state
is_steady()	returns True when case is steady state
move_to_folder(folder)	Move the current case to the specified folder.
open_in_browser()	Open resource in browser
post(json[, path, method])	Resource post
put(json[, path, method])	Resource put
retry([name, params, solver_version, tags])	Retry case :param name: :param params: :param tags: :return:
short_description()	returns: generates short description of resource (name, id, status)
upload_part(remote_file_name, upload_id, ...)	Uploads a part of the file as part of a multipart upload.
wait([timeout_minutes])	Wait until the Case finishes processing, refresh periodically

Inherited Common Usage

property params

returns case params

property params_as_dict

returns case params as dictionary

has_parent()

Check if case has parent case

Returns:

True when case has parent, False otherwise

Return type:

bool

property parent

parent case

Returns:

parent case object

Return type:

Case

Raises:

RuntimeError – When case does not have parent

property info

returns metadata info for case

property volume_mesh_id

returns volume mesh id

property results

returns results object to managing case results

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_aeroacoustics()

returns True when case has aeroacoustics

has_user_defined_dynamics()

returns True when case has user defined dynamics

is_finished()

returns False when case is in running or preprocessing state

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.

classmethod from_cloud(case_id)

get case from cloud

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:

wait(timeout_minutes=60)

Wait until the Case finishes processing, refresh periodically