luminarycloud.mesh

Classes

Mesh	Represents a Mesh object.
MeshAdaptationParameters	Parameters used to create a new mesh with mesh adaptation.

Functions

get_mesh(→ Mesh)	Get a specific mesh with the given ID.
get_mesh_metadata(...)	Returns the mesh metadata of a specific mesh with the given ID.

Module Contents

class luminarycloud.mesh.Mesh(proto_type: google.protobuf.message.Message | None = None)

Represents a Mesh object.

id: str

Mesh ID.

name: str

Mesh name.

status: luminarycloud.enum.MeshStatus

Mesh status. May not reflect the current status.

property create_time: datetime.datetime

update(*, name: str = '') → None

Update mesh attributes.

Mutates self.

Parameters:

namestr

New mesh name, maximum length of 256 characters.

wait(*, interval_seconds: float = 5, timeout_seconds: float = float('inf')) → luminarycloud.enum.MeshStatus

Wait until the mesh has either completed or failed processing.

Parameters:

interval_secondsfloat, optional

Number of seconds between polls. Default is 5 seconds.

timeout_secondsfloat, optional

Number of seconds before timeout.

Returns:

luminarycloud.enum.MeshStatus

Current status of the mesh.

delete() → None

Delete the mesh.

class luminarycloud.mesh.MeshAdaptationParameters(source_simulation_id: str, target_cv_count: int, h_ratio: float)

Parameters used to create a new mesh with mesh adaptation.

Attributes:

source_simulation_idstr

(Required) The simluation ID of a previously completed simulation. The source simulation will be used to extract the input mesh and mesh adaptation sensor from the solution.

target_cv_countint

(Required) Target count of mesh CVs.

h_ratiofloat

(Required) Boundary layer scaling.

source_simulation_id: str

target_cv_count: int

h_ratio: float

luminarycloud.mesh.get_mesh(id: str) → Mesh

Get a specific mesh with the given ID.

Parameters:

idstr

Mesh ID.

luminarycloud.mesh.get_mesh_metadata(id: str) → luminarycloud._proto.api.v0.luminarycloud.mesh.mesh_pb2.MeshMetadata

Returns the mesh metadata of a specific mesh with the given ID.

Parameters:

idstr

Mesh ID.