luminarycloud 0.14.0__py3-none-any.whl → 0.15.0__py3-none-any.whl

luminarycloud/enum/geometry_status.py

@@ -0,0 +1,28 @@
+# Copyright 2023-2024 Luminary Cloud, Inc. All Rights Reserved.
+from enum import IntEnum
+from .._proto.api.v0.luminarycloud.geometry import geometry_pb2
+
+
+class GeometryStatus(IntEnum):
+    """
+    Represents the status of a geometry.
+
+    Attributes
+    ----------
+    UNKNOWN
+        Status is unknown.
+    IMPORTING
+        Geometry is still being processed.
+    NEEDS_CHECK
+        Geometry was created but has not yet been checked.
+    FAILED_CHECK
+        Geometry is not well-formed and cannot be used.
+    READY
+        Geometry is ready to use.
+    """
+
+    UNKNOWN = geometry_pb2.Geometry.UNKNOWN
+    IMPORTING = geometry_pb2.Geometry.IMPORTING
+    NEEDS_CHECK = geometry_pb2.Geometry.NEEDS_CHECK
+    FAILED_CHECK = geometry_pb2.Geometry.FAILED_CHECK
+    READY = geometry_pb2.Geometry.READY

luminarycloud/geometry.py

@@ -5,8 +5,9 @@ from datetime import datetime
 import random
 from uuid import uuid4
 import time
+from typing import Sequence
 
-from typing_extensions import TYPE_CHECKING, Sequence
+from typing_extensions import TYPE_CHECKING
 
 import luminarycloud as lc
 
@@ -14,7 +15,7 @@ from ._client import get_default_client
 from ._helpers._timestamp_to_datetime import timestamp_to_datetime
 from ._proto.api.v0.luminarycloud.geometry import geometry_pb2 as geometrypb
 from ._proto.geometry import geometry_pb2 as gpb
-
+from .enum import GeometryStatus
 from .params.geometry import Surface, Volume
 from .tag import Tag
 from ._wrapper import ProtoWrapper, ProtoWrapperBase
@@ -37,6 +38,8 @@ class Geometry(ProtoWrapperBase):
     "Geometry ID."
     name: str
     "Geometry name."
+    status: GeometryStatus
+    "The status of the geometry."
 
     _proto: geometrypb.Geometry
 
@@ -47,29 +50,18 @@ class Geometry(ProtoWrapperBase):
         """
         return timestamp_to_datetime(self._proto.create_time)
 
-    def project(self) -> "Project":
+    @property
+    def update_time(self) -> datetime:
         """
-        Get the project this geometry belongs to.
+        The time the geometry was last updated.
         """
-        return lc.get_project(ProjectID(self._proto.project_id))
+        return timestamp_to_datetime(self._proto.update_time)
 
-    def modify(self, modification: gpb.Modification) -> None:
+    def project(self) -> "Project":
         """
-        Apply a modification to the geometry.
-
-        Parameters
-        ----------
-        modification : Modification
-            The modification to apply to the geometry. If the modification type is
-            `MODIFICATION_TYPE_CREATE_FEATURE`, and the feature is a `farfield`, the
-            geometry will be automatically subtracted from the farfield.
+        Get the project this geometry belongs to.
         """
-        req = geometrypb.ModifyGeometryRequest(
-            geometry_id=self.id,
-            modification=modification,
-            request_id=str(uuid4()),
-        )
-        get_default_client().ModifyGeometry(req)
+        return lc.get_project(ProjectID(self._proto.project_id))
 
     def copy(self, name: str = "") -> "Geometry":
         """
@@ -136,7 +128,7 @@ class Geometry(ProtoWrapperBase):
             create_proto.half_sphere.CopyFrom(shape._to_proto())  # type: ignore
         else:
             raise TypeError(f"Unsupported shape for farfield: {type(shape)}")
-        self.modify(
+        self._modify(
             modification=gpb.Modification(
                 mod_type=gpb.Modification.MODIFICATION_TYPE_CREATE_FEATURE,
                 feature=gpb.Feature(
@@ -153,8 +145,21 @@ class Geometry(ProtoWrapperBase):
     def undo(self) -> None:
         """
         Undo the last modification to the geometry.
-        """
-        self.modify(
+
+        Examples
+        --------
+        >>> # Initialize create a farfield
+        >>> geometry.add_farfield(
+        ...     lc.params.geometry.shapes.Sphere(radius=2.0, center=Vector3(0.0, 0.0, 0.0))
+        ... )
+        >>> # Undo the last modification
+        >>> geometry.undo()
+        >>> # Re-create a bigger farfield with a different center
+        >>> geometry.add_farfield(
+        ...     lc.params.geometry.shapes.Sphere(radius=3.0, center=Vector3(1.0, 1.0, 1.0))
+        ... )
+        """
+        self._modify(
             modification=gpb.Modification(
                 mod_type=gpb.Modification.MODIFICATION_TYPE_UNDO,
             )
@@ -164,7 +169,7 @@ class Geometry(ProtoWrapperBase):
         """
         Redo the last modification to the geometry.
         """
-        self.modify(
+        self._modify(
             modification=gpb.Modification(
                 mod_type=gpb.Modification.MODIFICATION_TYPE_REDO,
             )
@@ -181,7 +186,7 @@ class Geometry(ProtoWrapperBase):
         new_name : str
             The new name for the feature.
         """
-        self.modify(
+        self._modify(
             modification=gpb.Modification(
                 mod_type=gpb.Modification.MODIFICATION_TYPE_RENAME_FEATURE,
                 feature=gpb.Feature(
@@ -200,7 +205,7 @@ class Geometry(ProtoWrapperBase):
         feature_id : str
             The ID of the feature to delete.
         """
-        self.modify(
+        self._modify(
             modification=gpb.Modification(
                 mod_type=gpb.Modification.MODIFICATION_TYPE_DELETE_FEATURE,
                 feature=gpb.Feature(
@@ -218,7 +223,7 @@ class Geometry(ProtoWrapperBase):
         tag_names : list[str]
             The names of the tags to delete.
         """
-        self.modify(
+        self._modify(
             modification=gpb.Modification(
                 mod_type=gpb.Modification.MODIFICATION_TYPE_DELETE_TAGS,
                 delete_tags=gpb.DeleteTags(
@@ -265,6 +270,7 @@ class Geometry(ProtoWrapperBase):
                 )
             )
             if res.finished:
+                self.refresh()
                 return res.ok, list(res.issues)
             jitter = random.uniform(0.5, 1.5)
             time.sleep(2 + jitter)
@@ -314,7 +320,7 @@ class Geometry(ProtoWrapperBase):
         new_name : str
             The new name for the tag.
         """
-        self.modify(
+        self._modify(
             modification=gpb.Modification(
                 mod_type=gpb.Modification.MODIFICATION_TYPE_RENAME_TAG,
                 rename_tag=gpb.RenameTag(
@@ -346,7 +352,7 @@ class Geometry(ProtoWrapperBase):
             else:
                 raise TypeError("entities must be of type Volume or Surface")
 
-        self.modify(
+        self._modify(
             modification=gpb.Modification(
                 mod_type=gpb.Modification.MODIFICATION_TYPE_DELETE_TAG,
                 delete_tag=gpb.DeleteTag(
@@ -377,7 +383,7 @@ class Geometry(ProtoWrapperBase):
             else:
                 raise TypeError("entities must be of type Volume or Surface")
 
-        self.modify(
+        self._modify(
             modification=gpb.Modification(
                 mod_type=gpb.Modification.MODIFICATION_TYPE_UPDATE_TAG,
                 create_or_update_tag=gpb.CreateOrUpdateTag(
@@ -439,7 +445,25 @@ class Geometry(ProtoWrapperBase):
         ]
         return surfaces, volumes
 
-    def list_features(
+    def _modify(self, modification: gpb.Modification) -> None:
+        """
+        Apply a modification to the geometry.
+
+        Parameters
+        ----------
+        modification : Modification
+            The modification to apply to the geometry. If the modification type is
+            `MODIFICATION_TYPE_CREATE_FEATURE`, and the feature is a `farfield`, the
+            geometry will be automatically subtracted from the farfield.
+        """
+        req = geometrypb.ModifyGeometryRequest(
+            geometry_id=self.id,
+            modification=modification,
+            request_id=str(uuid4()),
+        )
+        get_default_client().ModifyGeometry(req)
+
+    def _list_features(
         self,
     ) -> list[gpb.Feature]:
         """
@@ -458,7 +482,7 @@ class Geometry(ProtoWrapperBase):
         )
         return list(res.features)
 
-    def list_feature_issues(
+    def _list_feature_issues(
         self,
     ) -> list[gpb.FeatureIssues]:
         """
@@ -478,6 +502,14 @@ class Geometry(ProtoWrapperBase):
         )
         return list(res.features_issues)
 
+    def refresh(self) -> None:
+        """
+        Refresh the geometry status.
+        """
+        req = geometrypb.GetGeometryRequest(geometry_id=self.id)
+        res: geometrypb.GetGeometryResponse = get_default_client().GetGeometry(req)
+        self._proto = res.geometry
+
 
 def get_geometry(id: str) -> Geometry:
     """

luminarycloud/geometry_version.py

@@ -87,7 +87,7 @@ class GeometryVersion(ProtoWrapperBase):
         ]
         return surfaces, volumes
 
-    def list_features(
+    def _list_features(
         self,
     ) -> list[gpb.Feature]:
         """
@@ -106,7 +106,7 @@ class GeometryVersion(ProtoWrapperBase):
         )
         return list(res.features)
 
-    def list_feature_issues(
+    def _list_feature_issues(
         self,
     ) -> list[gpb.FeatureIssues]:
         """

luminarycloud/mesh.py

@@ -11,8 +11,9 @@ from ._helpers._wait_for_mesh import wait_for_mesh
 from ._proto.api.v0.luminarycloud.mesh import mesh_pb2 as meshpb
 from ._wrapper import ProtoWrapper, ProtoWrapperBase
 from .enum import MeshStatus
-from .types import MeshID, ProjectID
 from .geometry_version import GeometryVersion, get_geometry_version
+from .meshing.metadata import MeshMetadata
+from .types import MeshID, ProjectID
 
 if TYPE_CHECKING:
     from .project import Project
@@ -122,6 +123,12 @@ class Mesh(ProtoWrapperBase):
         )
         get_default_client().DeleteMesh(req)
 
+    def get_metadata(self) -> MeshMetadata:
+        """
+        Get the metadata for this mesh.
+        """
+        return get_mesh_metadata(self.id)
+
 
 def get_mesh(id: MeshID) -> Mesh:
     """
@@ -137,9 +144,9 @@ def get_mesh(id: MeshID) -> Mesh:
     return Mesh(res.mesh)
 
 
-def get_mesh_metadata(id: MeshID) -> meshpb.MeshMetadata:
+def get_mesh_metadata(id: MeshID) -> MeshMetadata:
     """
-    Returns the mesh metadata of a specific mesh with the given ID.
+    Returns the mesh metadata for the mesh with the given ID.
 
     Parameters
     ----------
@@ -149,4 +156,4 @@ def get_mesh_metadata(id: MeshID) -> meshpb.MeshMetadata:
     res: meshpb.GetMeshMetadataResponse = get_default_client().GetMeshMetadata(
         meshpb.GetMeshMetadataRequest(id=id)
     )
-    return res.mesh_metadata
+    return MeshMetadata(res.mesh_metadata)

luminarycloud/meshing/__init__.py

@@ -1,3 +1,4 @@
+from . import metadata as metadata
 from . import sizing_strategy as sizing_strategy
 
 from .mesh_generation_params import (

luminarycloud/meshing/metadata/__init__.py

@@ -0,0 +1,6 @@
+from .mesh_metadata import (
+    BoundaryMetadata as BoundaryMetadata,
+    MeshMetadata as MeshMetadata,
+    MeshStats as MeshStats,
+    ZoneMetadata as ZoneMetadata,
+)

luminarycloud/meshing/metadata/mesh_metadata.py

@@ -0,0 +1,57 @@
+from ..._proto.api.v0.luminarycloud.mesh import mesh_pb2 as meshpb
+from ..._wrapper import ProtoWrapper, ProtoWrapperBase
+from ...types import Vector3
+
+
+@ProtoWrapper(meshpb.MeshMetadata.MeshStats)
+class MeshStats(ProtoWrapperBase):
+    """Contains stats about a part of a mesh."""
+
+    n_points: int
+    "The number of points."
+    n_faces: int
+    "The number of faces."
+    n_cvs: int
+    "The number of control volumes."
+    min_coord: Vector3
+    "The minimum coordinate."
+    max_coord: Vector3
+    "The maximum coordinate."
+
+    _proto: meshpb.MeshMetadata.MeshStats
+
+
+@ProtoWrapper(meshpb.MeshMetadata.Boundary)
+class BoundaryMetadata(ProtoWrapperBase):
+    """Represents a Mesh object."""
+
+    name: str
+    "The name of this mesh boundary."
+    stats: MeshStats
+    "The stats for this mesh boundary."
+
+    _proto: meshpb.MeshMetadata.Boundary
+
+
+@ProtoWrapper(meshpb.MeshMetadata.Zone)
+class ZoneMetadata(ProtoWrapperBase):
+    """Contains info about a zone in a mesh."""
+
+    name: str
+    "The name of this mesh zone."
+    stats: MeshStats
+    "The stats for this mesh zone."
+    boundaries: list[BoundaryMetadata]
+    "The boundaries in this mesh zone."
+
+    _proto: meshpb.MeshMetadata.Zone
+
+
+@ProtoWrapper(meshpb.MeshMetadata)
+class MeshMetadata(ProtoWrapperBase):
+    """Contains info about a Mesh."""
+
+    zones: list[ZoneMetadata]
+    "The zones in this mesh."
+
+    _proto: meshpb.MeshMetadata

luminarycloud/named_variable_set.py

@@ -0,0 +1,121 @@
+# Copyright 2023-2024 Luminary Cloud, Inc. All Rights Reserved.
+from datetime import datetime
+
+from ._client import get_default_client
+from ._helpers._timestamp_to_datetime import timestamp_to_datetime
+from ._helpers.named_variables import _named_variables_from_proto
+from ._helpers.warnings import experimental
+from ._proto.api.v0.luminarycloud.named_variable_set import (
+    named_variable_set_pb2 as namedvariablepb,
+)
+from ._wrapper import ProtoWrapper, ProtoWrapperBase
+from .types import ProjectID, NamedVariableSetID
+
+
+@experimental
+@ProtoWrapper(namedvariablepb.NamedVariableSet)
+class NamedVariableSet(ProtoWrapperBase):
+    """
+    Represents a named variable set object.
+
+    Note: This class is experimental and may change in the future.
+
+    Attributes
+    ----------
+    id : NamedVariableSetID
+        Named variable set ID.
+    project_id : ProjectID
+        ID of the project containing this named variable set.
+    name : str
+        Name of the named variable set.
+    create_time : datetime
+        Time the named variable set was created.
+    update_time : datetime
+        Time the named variable set was last updated.
+
+    Examples
+    --------
+    >>> named_variable_set = lc.get_named_variable_set(NamedVariableSetID("123"))
+    >>> named_variable_set.name = "My Named Variable Set"
+    >>> named_variable_set["x"] = 1.0
+    >>> named_variable_set["custom_expression"] = "x + 1"
+    >>> named_variable_set.save()
+    """
+
+    id: NamedVariableSetID
+    "Named variable set ID."
+    project_id: ProjectID
+    "ID of the project containing this simulation."
+
+    _proto: namedvariablepb.NamedVariableSet
+
+    @property
+    def name(self) -> str:
+        """Name of the named variable set."""
+        return self._proto.name
+
+    @name.setter
+    def name(self, value: str) -> None:
+        self._proto.name = value
+
+    @property
+    def create_time(self) -> datetime:
+        return timestamp_to_datetime(self._proto.create_time)
+
+    @property
+    def update_time(self) -> datetime:
+        return timestamp_to_datetime(self._proto.update_time)
+
+    def save(self) -> None:
+        """Save the named variable set."""
+        req = namedvariablepb.UpdateNamedVariableSetRequest(
+            id=self.id,
+            name=self._proto.name,
+            named_variables=self._get_named_variables(),
+        )
+        res: namedvariablepb.UpdateNamedVariableSetResponse = (
+            get_default_client().UpdateNamedVariableSet(req)
+        )
+        self._proto = res.named_variable_set
+        self._named_variables = None
+
+    def refresh(self) -> None:
+        """Refresh the named variable set."""
+        self._proto = get_named_variable_set(self.id)._proto
+        self._named_variables = None
+
+    def delete(self) -> None:
+        """Delete the named variable set. This is irreversible."""
+        req = namedvariablepb.DeleteNamedVariableSetRequest(id=self.id)
+        get_default_client().DeleteNamedVariableSet(req)
+
+    def __getitem__(self, key: str) -> float | str:
+        return self._get_named_variables()[key]
+
+    def __setitem__(self, key: str, value: float | str) -> None:
+        self._get_named_variables()[key] = value
+
+    def __delitem__(self, key: str) -> None:
+        del self._get_named_variables()[key]
+
+    def __contains__(self, key: str) -> bool:
+        return key in self._get_named_variables()
+
+    def _get_named_variables(self) -> dict[str, float | str]:
+        if self._named_variables is None:
+            self._named_variables = _named_variables_from_proto(self._proto.named_variables)
+        return self._named_variables
+
+
+def get_named_variable_set(id: NamedVariableSetID) -> NamedVariableSet:
+    """
+    Retrieve a specific named variable set by ID.
+
+    Parameters
+    ----------
+    id : str
+        Named variable set ID.
+    """
+    req = namedvariablepb.GetNamedVariableSetRequest(id=id)
+    res: namedvariablepb.GetNamedVariableSetResponse = get_default_client().GetNamedVariableSet(req)
+    return NamedVariableSet(res.named_variable_set)

luminarycloud/outputs/output_definitions.py

@@ -16,6 +16,7 @@ from ..enum import (
     Vector3Component,
     VolumeReductionType,
 )
+from .._helpers import CodeRepr
 
 
 # CalculationType enum comes from the simulation protobuf, but that's just a copy-paste of the
@@ -29,7 +30,7 @@ def _proto_calc_type(calc_type: CalculationType) -> feoutputpb.CalculationType.V
 
 
 @dataclass
-class TrailingAverageConfig:
+class TrailingAverageConfig(CodeRepr):
     """Configuration for a trailing average calculation of an OutputDefinition."""
 
     averaging_iterations: int = 0
@@ -37,7 +38,7 @@ class TrailingAverageConfig:
 
 
 @dataclass
-class ConvergenceMonitoringConfig:
+class ConvergenceMonitoringConfig(CodeRepr):
     """Configuration for a convergence monitoring calculation of an OutputDefinition."""
 
     averaging_iterations: int = 0
@@ -47,7 +48,7 @@ class ConvergenceMonitoringConfig:
 
 
 @dataclass
-class OutputDefinitionInclusions:
+class OutputDefinitionInclusions(CodeRepr):
     """Specifies which values should be calculated for an OutputDefinition."""
 
     base_value: bool = True
@@ -101,7 +102,7 @@ class OutputDefinitionInclusions:
 
 
 @dataclass
-class SurfaceAverageOutputDefinition:
+class SurfaceAverageOutputDefinition(CodeRepr):
     """An output that is calculated as an average over surfaces."""
 
     id: str = ""
@@ -161,7 +162,7 @@ class SurfaceAverageOutputDefinition:
 
 
 @dataclass
-class ForceOutputDefinition:
+class ForceOutputDefinition(CodeRepr):
     """A force or moment output."""
 
     id: str = ""
@@ -223,7 +224,7 @@ class ForceOutputDefinition:
 
 
 @dataclass
-class ResidualOutputDefinition:
+class ResidualOutputDefinition(CodeRepr):
     """Configuration of simulation residuals."""
 
     id: str = ""
@@ -262,7 +263,7 @@ class ResidualOutputDefinition:
 
 
 @dataclass
-class InnerIterationOutputDefinition:
+class InnerIterationOutputDefinition(CodeRepr):
     """The presence of this definition enables reporting of inner iteration counts for transient simulations."""
 
     id: str = ""
@@ -289,7 +290,7 @@ class InnerIterationOutputDefinition:
 
 
 @dataclass
-class PointProbeOutputDefinition:
+class PointProbeOutputDefinition(CodeRepr):
     """An output that is calculated at specific points in the domain."""
 
     id: str = ""
@@ -332,7 +333,7 @@ class PointProbeOutputDefinition:
 
 
 @dataclass
-class VolumeReductionOutputDefinition:
+class VolumeReductionOutputDefinition(CodeRepr):
     """An output that is calculated as an aggregation over volumes."""
 
     id: str = ""
@@ -384,7 +385,7 @@ class VolumeReductionOutputDefinition:
 
 
 @dataclass
-class DerivedOutputDefinition:
+class DerivedOutputDefinition(CodeRepr):
     """An output that is expressed as a function of other output definitions."""
 
     @dataclass