luminarycloud 0.13.1__py3-none-any.whl → 0.14.1__py3-none-any.whl

luminarycloud/params/{param_wrappers/simulation_param → simulation}/time/time_marching_.py

@@ -1,6 +1,6 @@
 # Generated by generate_sdk_wrappers.py. DO NOT EDIT
 
-from abc import ABCMeta
+from abc import ABC, ABCMeta
 from dataclasses import dataclass, field
 from typing import Any, Optional
 from uuid import uuid4
@@ -15,7 +15,7 @@ from luminarycloud._proto.client import simulation_pb2 as clientpb
 from luminarycloud._proto.client.entity_pb2 import EntityIdentifier
 import luminarycloud.params.enum._enum_wrappers as enum
 
-from luminarycloud.params.param_wrappers._lib import ParamGroupWrapper, CodeRepr, create_unique_id
+from luminarycloud.params.simulation._lib import ParamGroupWrapper, CodeRepr, create_unique_id
 
 
 @dataclass(kw_only=True)

luminarycloud/params/{param_wrappers/simulation_param → simulation}/time/time_step_ramp/time_step_ramp_off_.py

@@ -1,6 +1,6 @@
 # Generated by generate_sdk_wrappers.py. DO NOT EDIT
 
-from abc import ABCMeta
+from abc import ABC, ABCMeta
 from dataclasses import dataclass, field
 from typing import Any, Optional
 from uuid import uuid4
@@ -15,10 +15,10 @@ from luminarycloud._proto.client import simulation_pb2 as clientpb
 from luminarycloud._proto.client.entity_pb2 import EntityIdentifier
 import luminarycloud.params.enum._enum_wrappers as enum
 
-from luminarycloud.params.param_wrappers._lib import ParamGroupWrapper, CodeRepr, create_unique_id
+from luminarycloud.params.simulation._lib import ParamGroupWrapper, CodeRepr, create_unique_id
 
-from luminarycloud.params.param_wrappers.simulation_param.time.time_step_ramp_ import TimeStepRamp
-from luminarycloud.params.param_wrappers.simulation_param.time.time_step_ramp_ import *
+from luminarycloud.params.simulation.time.time_step_ramp_ import TimeStepRamp
+from luminarycloud.params.simulation.time.time_step_ramp_ import *
 
 
 @dataclass(kw_only=True)

luminarycloud/params/{param_wrappers/simulation_param → simulation}/time/time_step_ramp/time_step_ramp_on_.py

@@ -1,6 +1,6 @@
 # Generated by generate_sdk_wrappers.py. DO NOT EDIT
 
-from abc import ABCMeta
+from abc import ABC, ABCMeta
 from dataclasses import dataclass, field
 from typing import Any, Optional
 from uuid import uuid4
@@ -15,10 +15,10 @@ from luminarycloud._proto.client import simulation_pb2 as clientpb
 from luminarycloud._proto.client.entity_pb2 import EntityIdentifier
 import luminarycloud.params.enum._enum_wrappers as enum
 
-from luminarycloud.params.param_wrappers._lib import ParamGroupWrapper, CodeRepr, create_unique_id
+from luminarycloud.params.simulation._lib import ParamGroupWrapper, CodeRepr, create_unique_id
 
-from luminarycloud.params.param_wrappers.simulation_param.time.time_step_ramp_ import TimeStepRamp
-from luminarycloud.params.param_wrappers.simulation_param.time.time_step_ramp_ import *
+from luminarycloud.params.simulation.time.time_step_ramp_ import TimeStepRamp
+from luminarycloud.params.simulation.time.time_step_ramp_ import *
 
 
 @dataclass(kw_only=True)

luminarycloud/params/{param_wrappers/simulation_param → simulation}/time/time_step_ramp_.py

@@ -1,6 +1,6 @@
 # Generated by generate_sdk_wrappers.py. DO NOT EDIT
 
-from abc import ABCMeta
+from abc import ABC, ABCMeta
 from dataclasses import dataclass, field
 from typing import Any, Optional
 from uuid import uuid4
@@ -15,7 +15,7 @@ from luminarycloud._proto.client import simulation_pb2 as clientpb
 from luminarycloud._proto.client.entity_pb2 import EntityIdentifier
 import luminarycloud.params.enum._enum_wrappers as enum
 
-from luminarycloud.params.param_wrappers._lib import ParamGroupWrapper, CodeRepr, create_unique_id
+from luminarycloud.params.simulation._lib import ParamGroupWrapper, CodeRepr, create_unique_id
 
 
 @dataclass(kw_only=True)

luminarycloud/params/{param_wrappers/simulation_param → simulation}/time_.py

@@ -1,6 +1,6 @@
 # Generated by generate_sdk_wrappers.py. DO NOT EDIT
 
-from abc import ABCMeta
+from abc import ABC, ABCMeta
 from dataclasses import dataclass, field
 from typing import Any, Optional
 from uuid import uuid4
@@ -15,40 +15,30 @@ from luminarycloud._proto.client import simulation_pb2 as clientpb
 from luminarycloud._proto.client.entity_pb2 import EntityIdentifier
 import luminarycloud.params.enum._enum_wrappers as enum
 
-from luminarycloud.params.param_wrappers._lib import ParamGroupWrapper, CodeRepr, create_unique_id
+from luminarycloud.params.simulation._lib import ParamGroupWrapper, CodeRepr, create_unique_id
 
-from luminarycloud.params.param_wrappers.simulation_param.time.compute_statistics_ import (
-    ComputeStatistics,
-)
-from luminarycloud.params.param_wrappers.simulation_param.time.compute_statistics_ import *
-from luminarycloud.params.param_wrappers.simulation_param.time.compute_statistics.compute_statistics_off_ import (
+from luminarycloud.params.simulation.time.compute_statistics_ import ComputeStatistics
+from luminarycloud.params.simulation.time.compute_statistics_ import *
+from luminarycloud.params.simulation.time.compute_statistics.compute_statistics_off_ import (
     ComputeStatisticsOff,
 )
-from luminarycloud.params.param_wrappers.simulation_param.time.compute_statistics.compute_statistics_off_ import *
-from luminarycloud.params.param_wrappers.simulation_param.time.compute_statistics.compute_statistics_on_ import (
+from luminarycloud.params.simulation.time.compute_statistics.compute_statistics_off_ import *
+from luminarycloud.params.simulation.time.compute_statistics.compute_statistics_on_ import (
     ComputeStatisticsOn,
 )
-from luminarycloud.params.param_wrappers.simulation_param.time.compute_statistics.compute_statistics_on_ import *
-from luminarycloud.params.param_wrappers.simulation_param.time.time_marching.time_explicit_ import (
-    TimeExplicit,
-)
-from luminarycloud.params.param_wrappers.simulation_param.time.time_marching.time_explicit_ import *
-from luminarycloud.params.param_wrappers.simulation_param.time.time_marching.time_implicit_ import (
-    TimeImplicit,
-)
-from luminarycloud.params.param_wrappers.simulation_param.time.time_marching.time_implicit_ import *
-from luminarycloud.params.param_wrappers.simulation_param.time.time_marching_ import TimeMarching
-from luminarycloud.params.param_wrappers.simulation_param.time.time_marching_ import *
-from luminarycloud.params.param_wrappers.simulation_param.time.time_step_ramp_ import TimeStepRamp
-from luminarycloud.params.param_wrappers.simulation_param.time.time_step_ramp_ import *
-from luminarycloud.params.param_wrappers.simulation_param.time.time_step_ramp.time_step_ramp_off_ import (
-    TimeStepRampOff,
-)
-from luminarycloud.params.param_wrappers.simulation_param.time.time_step_ramp.time_step_ramp_off_ import *
-from luminarycloud.params.param_wrappers.simulation_param.time.time_step_ramp.time_step_ramp_on_ import (
-    TimeStepRampOn,
-)
-from luminarycloud.params.param_wrappers.simulation_param.time.time_step_ramp.time_step_ramp_on_ import *
+from luminarycloud.params.simulation.time.compute_statistics.compute_statistics_on_ import *
+from luminarycloud.params.simulation.time.time_marching.time_explicit_ import TimeExplicit
+from luminarycloud.params.simulation.time.time_marching.time_explicit_ import *
+from luminarycloud.params.simulation.time.time_marching.time_implicit_ import TimeImplicit
+from luminarycloud.params.simulation.time.time_marching.time_implicit_ import *
+from luminarycloud.params.simulation.time.time_marching_ import TimeMarching
+from luminarycloud.params.simulation.time.time_marching_ import *
+from luminarycloud.params.simulation.time.time_step_ramp_ import TimeStepRamp
+from luminarycloud.params.simulation.time.time_step_ramp_ import *
+from luminarycloud.params.simulation.time.time_step_ramp.time_step_ramp_off_ import TimeStepRampOff
+from luminarycloud.params.simulation.time.time_step_ramp.time_step_ramp_off_ import *
+from luminarycloud.params.simulation.time.time_step_ramp.time_step_ramp_on_ import TimeStepRampOn
+from luminarycloud.params.simulation.time.time_step_ramp.time_step_ramp_on_ import *
 
 
 @dataclass(kw_only=True)

luminarycloud/params/{param_wrappers/simulation_param → simulation}/volume_entity_.py

@@ -1,6 +1,6 @@
 # Generated by generate_sdk_wrappers.py. DO NOT EDIT
 
-from abc import ABCMeta
+from abc import ABC, ABCMeta
 from dataclasses import dataclass, field
 from typing import Any, Optional
 from uuid import uuid4
@@ -15,7 +15,7 @@ from luminarycloud._proto.client import simulation_pb2 as clientpb
 from luminarycloud._proto.client.entity_pb2 import EntityIdentifier
 import luminarycloud.params.enum._enum_wrappers as enum
 
-from luminarycloud.params.param_wrappers._lib import ParamGroupWrapper, CodeRepr, create_unique_id
+from luminarycloud.params.simulation._lib import ParamGroupWrapper, CodeRepr, create_unique_id
 
 
 @dataclass(kw_only=True)

luminarycloud/project.py

@@ -2,14 +2,18 @@
 from __future__ import annotations
 
 import re
+import uuid
 from datetime import datetime
 from os import PathLike, path
-from typing import TYPE_CHECKING, Optional
+from typing import TYPE_CHECKING, Any, Dict, Optional, Union
+
+import concurrent
 
 import grpc
 
 import luminarycloud as lc
-from luminarycloud.params.param_wrappers.simulation_param.adjoint_ import Adjoint
+from luminarycloud._helpers.named_variables import _named_variables_to_proto
+from luminarycloud.params.simulation.adjoint_ import Adjoint
 
 from ._client import get_default_client
 from ._helpers import (
@@ -22,18 +26,20 @@ from ._helpers import (
     upload_mesh,
     upload_table_as_json,
 )
-from luminarycloud._helpers import util
 from ._helpers.warnings import deprecated, experimental
 from ._proto.api.v0.luminarycloud.geometry import geometry_pb2 as geometrypb
 from ._proto.api.v0.luminarycloud.mesh import mesh_pb2 as meshpb
+from ._proto.api.v0.luminarycloud.named_variable_set import (
+    named_variable_set_pb2 as namedvariablepb,
+)
 from ._proto.api.v0.luminarycloud.project import project_pb2 as projectpb
 from ._proto.api.v0.luminarycloud.simulation import simulation_pb2 as simulationpb
 from ._proto.api.v0.luminarycloud.simulation_template import (
     simulation_template_pb2 as simtemplatepb,
 )
 from ._proto.client import simulation_pb2 as clientpb
-from ._proto.upload import upload_pb2 as uploadpb
 from ._proto.hexmesh import hexmesh_pb2 as hexmeshpb
+from ._proto.upload import upload_pb2 as uploadpb
 from ._wrapper import ProtoWrapper, ProtoWrapperBase
 from .enum import GPUType, MeshType, TableType
 from .meshing import MeshAdaptationParams, MeshGenerationParams
@@ -44,6 +50,7 @@ from .types import MeshID, ProjectID
 if TYPE_CHECKING:
     from .geometry import Geometry
     from .mesh import Mesh
+    from .named_variable_set import NamedVariableSet
     from .simulation import Simulation
     from .simulation_template import SimulationTemplate
 
@@ -337,22 +344,44 @@ class Project(ProtoWrapperBase):
                     return lc.Mesh(res.mesh)
             raise
 
-    def create_hex_mesh(self, file_path: PathLike | str, params: hexmeshpb.HexMeshSpec) -> "Mesh":
+    def create_hex_mesh(
+        self,
+        names_to_file_paths: Dict[str, Union[PathLike[Any], str]],
+        params: hexmeshpb.HexMeshSpec,
+    ) -> "Mesh":
         """
         Creates a hex mesh. Only for internal use.
         """
         client = get_default_client()
-        if not str(file_path).endswith(".stl"):
-            raise ValueError("File must be a .stl file")
 
-        file_meta = util.get_file_metadata(file_path)
-        finish_res = upload_file(
-            client,
-            self.id,
-            uploadpb.ResourceParams(geometry_params=uploadpb.GeometryParams()),
-            file_path,
-        )[1]
-        params.file_url = finish_res.url
+        def upload_single_file(name: str, file_path: Union[PathLike[Any], str]) -> tuple[str, str]:
+            if not str(file_path).endswith(".stl"):
+                raise ValueError(f"File {file_path} must be a .stl file")
+            finish_res = upload_file(
+                client,
+                self.id,
+                uploadpb.ResourceParams(geometry_params=uploadpb.GeometryParams()),
+                file_path,
+            )[1]
+            return name, finish_res.url
+
+        names_to_uploaded_file_paths = {}
+        with concurrent.futures.ThreadPoolExecutor() as executor:
+            future_to_name = {
+                executor.submit(upload_single_file, name, file_path): name
+                for name, file_path in names_to_file_paths.items()
+            }
+
+            for future in concurrent.futures.as_completed(future_to_name):
+                try:
+                    name, url = future.result()
+                    names_to_uploaded_file_paths[name] = url
+                except Exception as exc:
+                    name = future_to_name[future]
+                    raise RuntimeError(f"Upload failed for {name}: {exc}")
+
+        for name, url in names_to_uploaded_file_paths.items():
+            params.names_to_file_urls[name] = url
 
         req = meshpb.CreateHexMeshRequest(project_id=self.id, hex_mesh_config=params)
 
@@ -503,7 +532,8 @@ class Project(ProtoWrapperBase):
 
     def list_simulation_templates(self) -> "list[SimulationTemplate]":
         """
-        List all simulation templates in project.
+        List all simulation templates in project. The first one in the list is the "setup" template,
+        which is the one that is synced to the Setup tab in the UI.
         """
         req = simtemplatepb.ListSimulationTemplatesRequest(project_id=self.id)
         res = get_default_client().ListSimulationTemplates(req)
@@ -513,7 +543,7 @@ class Project(ProtoWrapperBase):
         self,
         name: str,
         *,
-        parameters: Optional[clientpb.SimulationParam] = None,
+        parameters: Optional[Union[clientpb.SimulationParam, SimulationParam]] = None,
         params_json_path: Optional[PathLike | str] = None,
     ) -> "SimulationTemplate":
         """
@@ -533,15 +563,48 @@ class Project(ProtoWrapperBase):
             Path to local JSON file containing simulation params.
         """
         if params_json_path is not None:
-            parameters = simulation_params_from_json_path(params_json_path)
-        elif parameters is None:
+            param_proto = simulation_params_from_json_path(params_json_path)
+        elif parameters is not None:
+            if isinstance(parameters, SimulationParam):
+                param_proto = parameters._to_proto()
+            else:
+                param_proto = clientpb.SimulationParam()
+                param_proto.CopyFrom(parameters)
+        else:
             raise Exception("Either parameters or params_json_path must be set")
         req = simtemplatepb.CreateSimulationTemplateRequest(
-            project_id=self.id, name=name, parameters=parameters
+            project_id=self.id, name=name, parameters=param_proto
         )
         res = get_default_client().CreateSimulationTemplate(req)
         return lc.SimulationTemplate(res.simulation_template)
 
+    @experimental
+    def create_named_variable_set(
+        self, name: str, named_variables: dict[str, float | str]
+    ) -> NamedVariableSet:
+        """
+        Create a new named variable set.
+
+        Note: This feature is experimental and may change or be removed without notice.
+        """
+        req = namedvariablepb.CreateNamedVariableSetRequest(
+            project_id=self.id,
+            name=name,
+            named_variables=_named_variables_to_proto(named_variables),
+            request_id=str(uuid.uuid4()),
+        )
+        res: namedvariablepb.CreateNamedVariableSetResponse = (
+            get_default_client().CreateNamedVariableSet(req)
+        )
+        return lc.NamedVariableSet(res.named_variable_set)
+
+    def list_named_variable_sets(self) -> list[NamedVariableSet]:
+        req = namedvariablepb.ListNamedVariableSetsRequest(project_id=self.id)
+        res: namedvariablepb.ListNamedVariableSetsResponse = (
+            get_default_client().ListNamedVariableSets(req)
+        )
+        return [lc.NamedVariableSet(n) for n in res.named_variable_sets]
+
 
 def create_project(
     name: str,

luminarycloud/reference_values.py

@@ -5,7 +5,7 @@ from ._proto.base.base_pb2 import AdFloatType
 from ._proto.output import reference_values_pb2 as refvalpb
 from .enum import ReferenceValuesType
 
-from .params.param_wrappers._lib import CodeRepr
+from .params.simulation._lib import CodeRepr
 
 
 @dataclass(kw_only=True)

luminarycloud/simulation.py

@@ -10,6 +10,7 @@ from ._proto.api.v0.luminarycloud.common import common_pb2 as commonpb
 from ._proto.api.v0.luminarycloud.simulation import simulation_pb2 as simulationpb
 from ._proto.api.v0.luminarycloud.solution import solution_pb2 as solutionpb
 from ._proto.client import simulation_pb2 as clientpb
+from ._proto.quantity import quantity_options_pb2 as quantityoptspb
 from ._wrapper import ProtoWrapper, ProtoWrapperBase
 from .enum import (
     AveragingType,
@@ -19,6 +20,7 @@ from .enum import (
     SimulationStatus,
     Vector3Component,
 )
+from .simulation_param import SimulationParam
 from .reference_values import ReferenceValues
 from .solution import Solution
 from .types import MeshID, ProjectID, SimulationID, Vector3Like
@@ -178,7 +180,7 @@ class Simulation(ProtoWrapperBase):
         surface_ids: list[str],
         *,
         reference_values: ReferenceValues = None,
-        calculation_type: CalculationType = CalculationType.PER_SURFACE,
+        calculation_type: CalculationType = CalculationType.AGGREGATE,
         frame_id: str = "",
         force_direction: Optional[Vector3Like] = None,
         moment_center: Optional[Vector3Like] = None,
@@ -204,7 +206,7 @@ class Simulation(ProtoWrapperBase):
             reference values will be used.
         calculation_type : CalculationType, optional
             Whether the calculation should be done for all the surfaces together or each surface
-            individually. Default is PER_SURFACE.
+            individually. Default is AGGREGATE.
         frame_id: str, optional
             The ID of the reference frame that this output should be
             reported in for "force" quantity types.
@@ -242,6 +244,8 @@ class Simulation(ProtoWrapperBase):
         ...     with open(dl.filename, "w") as fp:
         ...         fp.write(dl.read())
         """
+        if quantity_type._has_tag(quantityoptspb.TAG_COEFFICIENT) and reference_values is None:
+            print("WARNING: Quantity is a coefficient but reference values were not specified.")
         req = simulationpb.GetSimulationSurfaceQuantityOutputRequest(
             id=self.id,
             quantity_type=quantity_type.value,
@@ -288,6 +292,13 @@ class Simulation(ProtoWrapperBase):
         req = simulationpb.GetSimulationParametersRequest(id=self.id)
         return get_default_client().GetSimulationParameters(req)
 
+    def get_simulation_param(self) -> SimulationParam:
+        """
+        Returns the simulation parameters associated with this template to allow customization of
+        the parameters.
+        """
+        return SimulationParam.from_proto(self.get_parameters())
+
 
 def get_simulation(id: SimulationID) -> Simulation:
     """

luminarycloud/simulation_param.py

@@ -17,24 +17,24 @@ from luminarycloud._proto.output import output_pb2 as outputpb
 from luminarycloud._proto.quantity import quantity_options_pb2 as quantityoptspb
 from luminarycloud.enum import AveragingType, QuantityType, SpaceAveragingType
 from luminarycloud.params.geometry import Volume
-from luminarycloud.params.param_wrappers.simulation_param import (
+from luminarycloud.params.simulation import (
     EntityRelationships,
 )
-from luminarycloud.params.param_wrappers.simulation_param.adjoint_ import Adjoint
-from luminarycloud.params.param_wrappers.simulation_param.entity_relationships.volume_material_relationship_ import (
+from luminarycloud.params.simulation.adjoint_ import Adjoint
+from luminarycloud.params.simulation.entity_relationships.volume_material_relationship_ import (
     VolumeMaterialRelationship,
 )
-from luminarycloud.params.param_wrappers.simulation_param.entity_relationships.volume_physics_relationship_ import (
+from luminarycloud.params.simulation.entity_relationships.volume_physics_relationship_ import (
     VolumePhysicsRelationship,
 )
-from luminarycloud.params.param_wrappers.simulation_param.material_entity_ import (
+from luminarycloud.params.simulation.material_entity_ import (
     MaterialEntity,
 )
-from luminarycloud.params.param_wrappers.simulation_param.physics_ import Physics
-from luminarycloud.params.param_wrappers.simulation_param.volume_entity_ import (
+from luminarycloud.params.simulation.physics_ import Physics
+from luminarycloud.params.simulation.volume_entity_ import (
     VolumeEntity,
 )
-from luminarycloud.params.param_wrappers.simulation_param_ import (
+from luminarycloud.params.simulation import (
     SimulationParam as _SimulationParam,
 )
 from luminarycloud.reference_values import ReferenceValues, ReferenceValuesType
@@ -79,7 +79,49 @@ class SimulationParam(_SimulationParam):
 
     def assign_material(self, material: MaterialEntity, volume: Volume | str) -> None:
         """
-        Assigns a material entity to a volume ID.
+        Assigns a material entity to a volume.
+
+        This method links a material entity to a specific volume in the simulation domain.
+        If the volume or material entity has not been added to the simulation parameters yet,
+        they will be added automatically.
+
+        Parameters
+        ----------
+        material : MaterialEntity
+            The material entity to assign to the volume. This is typically created using
+            lc.params.simulation.MaterialEntity.
+        volume : Volume | str
+            The volume to assign the material to. Can be a Volume object or a string
+            representing the volume ID.
+
+        Examples
+        --------
+        Using volumes from list_tags():
+
+        >>> # Get the fluid volume from tags
+        >>> tags = geometry.list_tags()
+        >>> # Assume the fluid volume is tagged with "Fluid"
+        >>> fluid_volume_tag_name = "Fluid"
+        >>> fluid_tag = next(
+        ...     (tag for tag in tags if tag.name == fluid_volume_tag_name and tag.volumes), None
+        ... )
+        >>> if fluid_tag:
+        ...     # Assume we want to assign the material to the first volume in the tag
+        ...     for fluid_volume in fluid_tag.volumes:
+        ...         simulation_param.assign_material(material, fluid_volume)
+        >>> else:
+        ...     raise ValueError("No fluid volume found")
+
+        Using volumes from list_entities():
+
+        >>> # Get the fluid volume from list_entities()
+        >>> surfaces, volumes = geometry.list_entities()
+        >>> if volumes:
+        ...     # Assume we want to assign the material to the first volume in the list
+        ...     fluid_volume_to_assign = volumes[0]
+        ...     simulation_param.assign_material(material, fluid_volume_to_assign)
+        >>> else:
+        ...     raise ValueError("No fluid volume found")
         """
         volume_identifier = EntityIdentifier()
         if isinstance(volume, str):
@@ -112,7 +154,49 @@ class SimulationParam(_SimulationParam):
 
     def assign_physics(self, physics: Physics, volume: Volume | str) -> None:
         """
-        Assigns a physics entity to a volume ID.
+        Assigns a physics entity to a volume.
+
+        This method links a physics entity to a specific volume in the simulation domain.
+        If the volume or physics entity has not been added to the simulation parameters yet,
+        they will be added automatically.
+
+        Parameters
+        ----------
+        physics : Physics
+            The physics entity to assign to the volume. This is typically created using
+            lc.params.simulation.Physics.
+        volume : Volume | str
+            The volume to assign the physics to. Can be a Volume object or a string
+            representing the volume ID.
+
+        Examples
+        --------
+        Using volumes from list_tags():
+
+        >>> # Get the fluid volume from tags
+        >>> tags = geometry.list_tags()
+        >>> # Assume the fluid volume is tagged with "Fluid"
+        >>> fluid_volume_tag_name = "Fluid"
+        >>> fluid_tag = next(
+        ...     (tag for tag in tags if tag.name == fluid_volume_tag_name and tag.volumes), None
+        ... )
+        >>> if fluid_tag:
+        ...     # Assume we want to assign the physics to the first volume in the tag
+        ...     for fluid_volume in fluid_tag.volumes:
+        ...         simulation_param.assign_physics(physics, fluid_volume)
+        >>> else:
+        ...     raise ValueError("No fluid volume found")
+
+        Using volumes from list_entities():
+
+        >>> # Get the fluid volume from list_entities()
+        >>> surfaces, volumes = geometry.list_entities()
+        >>> if volumes:
+        ...     # Assume we want to assign the physics to the first volume in the list
+        ...     fluid_volume_to_assign = volumes[0]
+        ...     simulation_param.assign_physics(physics, fluid_volume_to_assign)
+        >>> else:
+        ...     raise ValueError("No fluid volume found")
         """
         if isinstance(volume, str):
             volume_identifier = EntityIdentifier(id=volume)

luminarycloud/solution.py

@@ -6,11 +6,13 @@ from os import PathLike
 import luminarycloud as lc
 
 from ._client import get_default_client
+from ._helpers.warnings import experimental
 from ._helpers.download import (
     download_surface_solution,
     download_volume_solution,
     download_surface_deformation_template,
     download_surface_sensitivity_data,
+    download_parameter_sensitivity_data,
 )
 from ._helpers.file_chunk_stream import FileChunkStream
 from ._proto.api.v0.luminarycloud.solution import solution_pb2 as solutionpb
@@ -79,12 +81,17 @@ class Solution(ProtoWrapperBase):
             mode="r|gz",
         )
 
-    def download_volume_data(self) -> tarfile.TarFile:
+    def download_volume_data(self, single_precision: bool = False) -> tarfile.TarFile:
         """
         Download volume solution for a completed steady simulation as a gzipped tarball containing .vtu & .vtp files.
 
         The output may be broken up into multiple .vtu files for large simulations.
 
+        Parameters
+        ----------
+        single_precision : bool
+            If True, outputs floating point fields in single precision. Defaults to False.
+
         Returns
         -------
         tarfile.Tarfile
@@ -108,6 +115,7 @@ class Solution(ProtoWrapperBase):
         stream = download_volume_solution(
             get_default_client(),
             self.id,
+            single_precision=single_precision,
         )
         return tarfile.open(
             name=stream.filename,
@@ -125,7 +133,7 @@ class Solution(ProtoWrapperBase):
         Project.set_surface_deformation to create simulations with volume mesh morphing.
         """
         stream = download_surface_deformation_template(get_default_client(), self.id)
-        return _handle_surface_data_stream(stream, dst)
+        _handle_surface_data_stream(stream, dst)
 
     def download_surface_sensitivity_data(self, dst: Optional[PathLike] = None) -> None:
         """
@@ -136,4 +144,17 @@ class Solution(ProtoWrapperBase):
         The IDs of the sensitivity data are consistent with the node IDs of the surface deformation.
         """
         stream = download_surface_sensitivity_data(get_default_client(), self.id)
-        return _handle_surface_data_stream(stream, dst)
+        _handle_surface_data_stream(stream, dst)
+
+    @experimental
+    def download_parameter_sensitivity_data(self, dst: Optional[PathLike] = None) -> None:
+        """
+        Download the parameter sensitivity data associated with an adjoint solution into the
+        destination file or into a default-named file. The data consists of parameter names and
+        sensitivity values (d "adjoint output" / d "SimulationParam parameter").
+
+        NOTE: This is a very experimental feature, likely to change in the future in favor of
+        including the sensitivities in a SimulationParam object directly.
+        """
+        stream = download_parameter_sensitivity_data(get_default_client(), self.id)
+        _handle_surface_data_stream(stream, dst)

luminarycloud/types/__init__.py

@@ -6,6 +6,7 @@ from .ids import (
     SolutionID as SolutionID,
     SimulationTemplateID as SimulationTemplateID,
     GeometryFeatureID as GeometryFeatureID,
+    NamedVariableSetID as NamedVariableSetID,
 )
 
 from .adfloat import (