feat: refactor source class

doc/changelog.d/690.added.md

@@ -0,0 +1 @@
+Refactor source class

doc/source/cheat_sheet/cheat_sheet_script.qmd

@@ -127,12 +127,13 @@ s_source = project.create_source(name='Surface.1', feature_type=SourceSurface)
 # Choose one way to set source power
 # for any conflicting property the last set property counts
 s_source.set_flux_from_intensity_file()
-s_source.set_flux_luminous(683)
-s_source.set_flux_radiant(1)
-s_source.set_flux_luminous_intensity(5)
-s_source.set_exitance_constant(
-    [(core.GeoRef.from_native_link(
-        'TheBodyB/TheFaceF'), False)])
+s_source.set_flux_luminous().value = 683
+s_source.set_flux_radiant().value = 1
+s_source.set_flux_luminous_intensity().value = 5
+s_source.set_exitance_constant().geometries = [
+    (core.GeoRef.from_native_link(
+        'TheBodyB/TheFaceF'), False)
+        ]
 s_int = s_source.set_intensity()
 s_int.set_cos(1,120)
 s_source.set_spectrum()
@@ -150,13 +151,13 @@ r_source.set_ray_file_uri('path/ray.ray')
 # Choose one way to set source power
 # for any conflicting property the last set property counts
 r_source.set_flux_from_ray_file()
-r_source.set_flux_luminous(683)
-r_source.set_flux_radiant(1)
+r_source.set_flux_luminous().value = 683
+r_source.set_flux_radiant().value = 1
 r_source.set_spectrum_from_ray_file()
-r_source.set_exit_geometries(
-    [core.GeoRef.from_native_link(
-        'TheBodyB/TheFaceF')])
-r_source.set_axis_system([0,0,0,1,0,0,0,1,0,0,0,1])
+r_source.set_exit_geometries().geometries = [
+    core.GeoRef.from_native_link('TheBodyB/TheFaceF'),
+        ]
+r_source.axis_system = [0,0,0,1,0,0,0,1,0,0,0,1]
 r_source.commit()
 ```
 

examples/core/prism-example.py

@@ -93,7 +93,9 @@
 
 irr_features = p.find(name=".*", name_regex=True, feature_type=SensorIrradiance)
 irr = irr_features[0]
-irr.set_type_spectral().set_wavelengths_range().set_start(500).set_end(600).set_sampling(11)
+irr.set_type_spectral().set_wavelengths_range().start = 500
+irr.set_type_spectral().set_wavelengths_range().end = 600
+irr.set_type_spectral().set_wavelengths_range().sampling = 11
 irr.commit()
 
 # Create and add a new sensor, e.g. 3d irradiance sensor

examples/core/project.py

@@ -78,7 +78,7 @@
 # #### Source
 
 source1 = p.create_source(name="Source.1", feature_type=SourceLuminaire)
-source1.set_intensity_file_uri(uri=str(assets_data_path / "IES_C_DETECTOR.ies"))
+source1.intensity_file_uri = assets_data_path / "IES_C_DETECTOR.ies"
 source1.commit()
 
 
@@ -193,7 +193,7 @@
 
 # modify the surface source, e.g. surface source wavelength:
 
-src.set_spectrum().set_monochromatic(wavelength=550)
+src.set_spectrum().set_monochromatic().wavelength = 550
 src.commit()
 
 

examples/core/simulation.py

@@ -103,7 +103,7 @@
 # ### Prepare a surface source
 
 source1 = p.create_source(name=SOURCE_NAME)
-source1.set_exitance_constant(geometries=[(face_1, True)])
+source1.set_exitance_constant().geometries = [(face_1, True)]
 # define a spectrum which is not monochromatic so it can be used in both direct and inverse
 # simulation
 source1.set_spectrum().set_blackbody()

examples/core/source.py

@@ -96,7 +96,7 @@ def create_face(body):
 
 intensity_file_path = str(assets_data_path / IES)
 source1 = p.create_source(name="Luminaire.1", feature_type=SourceLuminaire)  # type luminaire
-source1.set_intensity_file_uri(uri=intensity_file_path)
+source1.intensity_file_uri = intensity_file_path
 print(source1)
 
 # **Push it to the server.**
@@ -114,10 +114,11 @@ def create_face(body):
 
 intensity_file_path = str(assets_data_path / IES)
 source2 = p.create_source(name="Luminaire.2", feature_type=SourceLuminaire)
-source2.set_intensity_file_uri(uri=intensity_file_path)
-source2.set_flux_radiant()  # select flux radiant with default value
+source2.intensity_file_uri = intensity_file_path
+source2.set_flux().set_radiant()
+source2.set_flux().value = 1.0  # select flux radiant
 # choose the source location [Origin, Xvector, Yvector, Zvector]
-source2.set_axis_system(axis_system=[20, 50, 10, 1, 0, 0, 0, 1, 0, 0, 0, 1])
+source2.axis_system = [20, 50, 10, 1, 0, 0, 0, 1, 0, 0, 0, 1]
 source2.set_spectrum().set_blackbody()  # choose blackbody with default value for the spectrum
 source2.commit()  # Push to the server
 print(source2)
@@ -140,8 +141,9 @@ def create_face(body):
 # > changes.
 # > If you don't, you will still only watch what is committed on the server.
 
-source1.set_flux_radiant(value=1.2)  # modify radiant flux value
-source1.set_axis_system(axis_system=[17, 10, 10, 1, 0, 0, 0, 1, 0, 0, 0, 1])  # modify axis system
+source1.set_flux().set_radiant()
+source1.set_flux().value = 1.2  # modify radiant flux value
+source1.axis_system = [17, 10, 10, 1, 0, 0, 0, 1, 0, 0, 0, 1]  # modify axis system
 source1.set_spectrum().set_halogen()  # modify spectrum by choosing halogen
 source1.commit()  # Push changes to the server
 print(source1)
@@ -150,7 +152,7 @@ def create_face(body):
 #
 # Possibility to reset local values from the one available in the server.
 
-source1.set_flux_luminous()  # modify to luminous flux BUT no commit
+source1.set_flux().set_luminous().value = 683.0  # modify to luminous flux BUT no commit
 source1.reset()
 # reset -> this will apply the server value to the local value the local value will be back to
 # halogen
@@ -178,13 +180,13 @@ def create_face(body):
 ray_file_path = str(assets_data_path / "Rays.ray")
 
 source3 = p.create_source(name="Ray-file.1", feature_type=SourceRayFile)  # type ray file
-source3.set_ray_file_uri(uri=ray_file_path)
+source3.ray_file_uri = ray_file_path
 source3.commit()
 print(source3)
 # -
 
 # +
-source3.set_flux_luminous()
+source3.set_flux().set_luminous()
 source3.commit()
 print(source3)
 # -
@@ -198,18 +200,16 @@ def create_face(body):
 # +
 create_helper_geometries(p)
 source4 = p.create_source(name="Surface.1", feature_type=SourceSurface)
-source4.set_exitance_constant(
-    geometries=[
-        (GeoRef.from_native_link("TheBodyB/TheFaceF"), False),
-        (GeoRef.from_native_link("TheBodyC/TheFaceF"), True),
-    ]
-)
+source4.set_exitance_constant().geometries = [
+    (GeoRef.from_native_link("TheBodyB/TheFaceF"), False),
+    (GeoRef.from_native_link("TheBodyC/TheFaceF"), True),
+]
 source4.commit()
 print(source4)
 # -
 
 # +
-source4.set_flux_luminous_intensity()
+source4.set_flux().set_luminous_intensity()
 source4.set_intensity().set_gaussian().set_axis_system(
     axis_system=[10, 50, 20, 1, 0, 0, 0, 1, 0, 0, 0, 1]
 )

examples/workflow/combine-speos.py

@@ -135,10 +135,9 @@
 
 # +
 src = p.create_source(name="Luminaire.1", feature_type=SourceLuminaire)
-src.set_intensity_file_uri(
-    uri=str(assets_data_path / "IES_C_DETECTOR.ies")
-).set_spectrum().set_daylightfluorescent()
-src.set_axis_system([0, 10000, 50000, 1, 0, 0, 0, 1, 0, 0, 0, 1])
+src.intensity_file_uri = assets_data_path / "IES_C_DETECTOR.ies"
+src.set_spectrum().set_daylightfluorescent()
+src.axis_system = [0, 10000, 50000, 1, 0, 0, 0, 1, 0, 0, 0, 1]
 
 src.commit()
 # -

src/ansys/speos/core/generic/constants.py

@@ -22,7 +22,13 @@
 
 """Collection of all constants used in pySpeos."""
 
+from dataclasses import dataclass, field
+from enum import Enum
 import os
+from pathlib import Path
+from typing import Optional, Union
+
+from ansys.speos.core.geo_ref import GeoRef
 
 DEFAULT_HOST: str = "localhost"
 """Default host used by Speos RPC server and client """
@@ -38,3 +44,142 @@
 """Maximum message Size accepted by grpc channel,
 By default, 4194304.
 """
+ORIGIN = [0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1]
+"""Global Origin"""
+
+
+class SPECTRUM:
+    """Constant class for Spectrum."""
+
+    class MONOCHROMATIC:
+        """Constant class for Monochromatic."""
+
+        WAVELENGTH = 555
+
+    class BLACKBODY:
+        """Constant class for BlackBody."""
+
+        TEMPERATURE = 2856
+
+
+class SOURCE:
+    """Constant class for Sources."""
+
+    class LUMINOUS:
+        """Constant class for Luminous."""
+
+        VALUE = 683
+
+    class RADIANT:
+        """Constant class for Radiant."""
+
+        VALUE = 1
+
+    class INTENSITY:
+        """Constant class for Intensity."""
+
+        VALUE = 5
+
+
+class FluxType(Enum):
+    """Enum representing the type of flux."""
+
+    LUMINOUS = "luminous"
+    RADIANT = "radiant"
+    FROM_FILE = "from_file"
+    INTENSITY = "intensity"
+
+
+@dataclass
+class SourceRayfileParameters:
+    """Constant class for SourceRayfileParameters."""
+
+    ray_file_uri: Union[str, Path] = ""
+    flux_type: FluxType = FluxType.FROM_FILE
+    flux_value: Optional[float] = None
+    axis_system: list[float] = field(default_factory=lambda: ORIGIN)
+    exit_geometry: Optional[GeoRef] = None
+
+    def __post_init__(self):
+        """Verify the dataclass initiation."""
+        # Validation: restrict flux_type
+        if self.flux_type not in {FluxType.FROM_FILE, FluxType.LUMINOUS, FluxType.RADIANT}:
+            raise ValueError(
+                f"Invalid flux_type '{self.flux_type}'. Must be FROM_FILE, LUMINOUS, or RADIANT."
+            )
+
+        # Set default flux_value based on flux_type (only if not manually provided)
+        if self.flux_value is None:
+            match self.flux_type:
+                case FluxType.LUMINOUS:
+                    self.flux_value = 683
+                case FluxType.RADIANT:
+                    self.flux_value = 1
+                case FluxType.FROM_FILE:
+                    self.flux_value = 0.0
+
+
+@dataclass
+class SourceLuminaireParameters:
+    """Constant class for SourceLuminaireParamters."""
+
+    intensity_file_uri: Union[str, Path] = ""
+    flux_type: FluxType = FluxType.FROM_FILE
+    flux_value: Optional[float] = None
+    axis_system: list[float] = field(default_factory=lambda: ORIGIN)
+
+    def __post_init__(self) -> None:
+        """Verify the dataclass initiation."""
+        # Validation: restrict flux_type
+        if self.flux_type not in {FluxType.FROM_FILE, FluxType.LUMINOUS, FluxType.RADIANT}:
+            raise ValueError(
+                f"Invalid flux_type '{self.flux_type}'. Must be FROM_FILE, LUMINOUS, or RADIANT."
+            )
+
+        # Set default flux_value based on flux_type (only if not manually provided)
+        if self.flux_value is None:
+            match self.flux_type:
+                case FluxType.LUMINOUS:
+                    self.flux_value = 683
+                case FluxType.RADIANT:
+                    self.flux_value = 1
+                case FluxType.FROM_FILE:
+                    self.flux_value = 0.0
+
+
+class SENSOR:
+    """Constant class for Sensors."""
+
+    class WAVELENGTHSRANGE:
+        """Wavelength constants."""
+
+        START = 400
+        """Wavelength start value."""
+        END = 700
+        """Wavelength end value."""
+        SAMPLING = 13
+        """Wavelength sampling."""
+
+    class DIMENSIONS:
+        """Dimension Constants."""
+
+        X_START = -50
+        """Lower bound x axis."""
+        X_END = 50
+        """Upper bound x axis."""
+        X_SAMPLING = 100
+        """Sampling x axis."""
+        Y_START = -50
+        """Lower bound y axis."""
+        Y_END = 50
+        """Upper bound y axis."""
+        Y_SAMPLING = 100
+        """Sampling y axis."""
+
+    class LAYERTYPES:
+        """Layer Separation constants."""
+
+        MAXIMUM_NB_OF_SEQUENCE = 10
+        """Number of sequences stored in sensor."""
+        INCIDENCE_SAMPLING = 9
+        """Number of incidence sampling stored in sensor"""