io_dtos.py

"""Data transfer objects (DTOs) for the inductor optimization."""
# python libraries
import dataclasses

# 3rd party libraries
from magnethub.loss import LossModel

# own libraries
from femmt.optimization.ito_dtos import WorkingDirectories
from femmt.optimization.optimization_dtos import MaterialDataSources

@dataclasses.dataclass
class InductorInsulationDTO:
    """Insulation distances for the inductor geometry."""

    core_left: float
    core_right: float
    core_top: float
    core_bot: float
    primary_to_primary: float

@dataclasses.dataclass
class InductorOptimizationDTO:
    """Contains boundary parameters for the inductor optimization."""

    # general parameters
    inductor_study_name: str
    inductor_optimization_directory: str

    # target parameter
    target_inductance: float

    # fixed parameters
    insulations: InductorInsulationDTO
    temperature: float
    time_current_vec: list

    # optimization parameters
    material_name_list: list[str]
    core_name_list: list[str] | None
    core_inner_diameter_min_max_list: list[float] | None
    window_w_min_max_list: list[float] | None
    window_h_min_max_list: list[float] | None
    litz_wire_name_list: list[str]

    # FEM simulation
    material_data_sources: MaterialDataSources

@dataclasses.dataclass
class InductorOptimizationTargetAndFixedParameters:
    """
    Inductor optimization target and fixed parameters.

    These parameters are calculated from the inductor input configuration (InductorOptimizationDTO).
    """

    i_rms: float
    i_peak: float
    material_name_list: list[str]
    material_mu_r_abs_list: list[float]
    magnet_hub_model_list: list[LossModel]
    time_extracted_vec: list
    current_extracted_vec: list
    fundamental_frequency: float
    working_directories: WorkingDirectories
    fft_frequency_list: list[float]
    fft_amplitude_list: list[float]
    fft_phases_list: list[float]

@dataclasses.dataclass
class IoFemInput:
    """Input DTO for a FEM simulation within the inductor optimization."""

    # general parameters
    working_directory: str
    simulation_name: str

    # material and geometry parameters
    material_name: str
    litz_wire_name: str
    core_inner_diameter: float
    window_w: float
    window_h: float
    air_gap_length: float
    turns: float
    insulations: InductorInsulationDTO

    # data sources
    material_data_sources: MaterialDataSources

    # operating point conditions
    temperature: float
    fundamental_frequency: float
    fft_frequency_list: list[float]
    fft_amplitude_list: list[float]
    fft_phases_list: list[float]

    # magnet loss model
    time_vec: list[float]
    current_vec: list[float]

@dataclasses.dataclass
class IoFemOutput:
    """Output DTO for a FEM simulation within the inductor optimization."""

    inductance: float
    p_loss_winding: float
    p_core_sine: float
    p_core_magnet: float
    volume: float

@dataclasses.dataclass
class IoReluctanceModelInput:
    """Input DTO for reluctance model simulation within the inductor optimization."""

    target_inductance: float
    core_inner_diameter: float
    window_w: float
    window_h: float
    turns: int
    litz_wire_name: str
    litz_wire_diameter: float

    insulations: InductorInsulationDTO
    material_mu_r_abs: float
    magnet_material_model: LossModel

    temperature: float
    time_extracted_vec: list
    current_extracted_vec: list
    fundamental_frequency: float
    fft_frequency_list: list[float]
    fft_amplitude_list: list[float]
    fft_phases_list: list[float]

@dataclasses.dataclass
class IoReluctanceModelOutput:
    """output DTO for reluctance model simulation within the inductor optimization."""

    volume: float
    area_to_heat_sink: float
    p_loss_total: float
    p_winding: float
    p_hyst: float
    l_air_gap: float
    flux_density_peak: float