flow360.VolumeMesh

class VolumeMesh

Volume mesh component

__init__(id)

Methods

__init__(id)
complete_multipart_upload(remote_file_name, ...)	Completes a multipart upload for the specified remote file name and upload ID.
copy_from_example(example_id[, name])	Create a new volume mesh by copying from an example mesh identified by example_id.
create(name, params, surface_mesh_id[, ...])	Create volume mesh from surface mesh
create_case(name, params[, tags, solver_version])	Create new case :param name: :param params: :param tags: :return:
create_multipart_upload(remote_file_name)	Creates a multipart upload for the specified remote file name and file.
delete([path, method])	Resource delete
download([to_file, to_folder, overwrite])	Download volume mesh file :param to_file: :return:
download_file(file_name[, to_file, ...])	Download file from surface mesh :param file_name: :param to_file: :return:
from_cloud(mesh_id)	Get volume mesh info from cloud :param mesh_id: :return:
from_file(file_name[, params, name, tags, ...])	Upload volume mesh from file :param volume_mesh_name: :param file_name: :param params: :param tags: :param solver_version: :return:
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
is_cloud_resource()	returns true if is cloud resource
open_in_browser()	Open resource in browser
post(json[, path, method])	Resource post
put(json[, path, method])	Resource put
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.

Attributes

all_boundaries	returns mesh no_slip_walls
id	returns id of resource
info	returns metadata info for resource
name	returns name of resource
no_slip_walls	returns mesh no_slip_walls
solver_version	returns solver version of resource
status	returns status for resource

property info

returns metadata info for resource

property no_slip_walls

returns mesh no_slip_walls

property all_boundaries

returns mesh no_slip_walls

download_file(file_name, to_file=None, to_folder='.', overwrite=True, progress_callback=None, **kwargs)

Download file from surface mesh :param file_name: :param to_file: :return:

download(to_file=None, to_folder='.', overwrite=True)

Download volume mesh file :param to_file: :return:

classmethod from_cloud(mesh_id)

Get volume mesh info from cloud :param mesh_id: :return:

classmethod from_file(file_name, params=None, name=None, tags=None, solver_version=None, endianess=None, isascii=False)

Upload volume mesh from file :param volume_mesh_name: :param file_name: :param params: :param tags: :param solver_version: :return:

classmethod copy_from_example(example_id, name=None)

Create a new volume mesh by copying from an example mesh identified by example_id.

Parameters:

• example_id (str) – The unique identifier of the example volume mesh to copy from.

• name (str, optional) – The name to assign to the new volume mesh. If not provided, the name of the example volume mesh will be used.

Returns:

A new instance of VolumeMesh copied from the example mesh if successful.

Return type:

VolumeMesh

Examples

>>> new_mesh = VolumeMesh.copy_from_example('example_id_123', name='New Mesh')

classmethod create(name, params, surface_mesh_id, tags=None, solver_version=None)

Create volume mesh from surface mesh

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

Create new case :param name: :param params: :param tags: :return:

complete_multipart_upload(remote_file_name, upload_id, uploaded_parts)

Completes a multipart upload for the specified remote file name and upload ID.

Parameters:

• remote_file_name (str) – The name of the remote file.

• upload_id (str) – The ID of the multipart upload.

• uploaded_parts (dict) –

  A dictionary containing information about the uploaded parts. The dictionary should have the following structure: {

  ”ETag”: “string”, # The ETag of each uploaded part. “part_number”: int # The part number of each uploaded part.

  }

Returns:

None

create_multipart_upload(remote_file_name)

Creates a multipart upload for the specified remote file name and file.

Parameters:

remote_file_name (str) – The name of the remote file.

Returns:

UploadID

delete(path=None, method=None)

Resource delete

get(path=None, method=None, json=None, params=None)

Resource get

get_download_file_list()

return list of files available for download

Returns:

List of files available for download

Return type:

List

get_info(force=False)

returns metadata info for resource

property id

returns id of resource

is_cloud_resource()

returns true if is cloud resource

property name

returns name of resource

open_in_browser()

Open resource in browser

post(json, path=None, method=None)

Resource post

put(json, path=None, method=None)

Resource put

short_description()

Returns:

generates short description of resource (name, id, status)

Return type:

str

property solver_version

returns solver version of resource

property status

returns status for resource

upload_part(remote_file_name, upload_id, part_number, compressed_chunk)

Uploads a part of the file as part of a multipart upload.

Parameters:

• remote_file_name (str) – The name of the remote file.

• upload_id (str) – The ID of the multipart upload.

• part_number (int) – The part number of the upload.

• compressed_chunk – The compressed chunk data to upload.

Returns:

response[“ETag”], “PartNumber”: part_number}

Return type:

{“ETag”