← Back to Analysis1 documentation

Analysis1 - Source Code

File: userfiles/SpeedReducer/subsystem1/Analysis1.py

# Copyright (C) The DistributedDesignOptimizer Contributors
# Licensed under the GNU General Public License v3.0. See LICENSE file for details.
"""Analysis module for Speed Reducer subsystem 1.

Implements the disciplinary analysis for shaft 1 in the Speed Reducer problem,
computing shaft dimensions and strength-related responses.
"""

from typing import List
from Distributed_Design_Optimizer.subsystem.optimization import AnalysisInterface
from Distributed_Design_Optimizer.subsystem import LocalSubSystemBasis
from Distributed_Design_Optimizer.subsystem.tools import ScalerBasis


class Analysis1(AnalysisInterface):
    """Analysis class for Speed Reducer subsystem 1 (shaft 1).

    Computes physical responses for shaft 1 including diameter, length,
    and coupling with the gear subsystem.

    Attributes:
        None specific to this class; inherits from AnalysisInterface.
    """

    def __init__(self) -> None:
        """Initialize Analysis1 instance."""
        pass

    def evaluateLocalResponses(self, subsystem: LocalSubSystemBasis) -> None:
        """Evaluate subsystem responses for shaft 1.

        Computes physical responses for shaft 1 including diameter, length,
        and shared design variables from the gear subsystem.

        Args:
            subsystem: The local subsystem containing design variables and scalers.
        """

        des_var: List[float] = subsystem.get_DesignVariables_Unscaled()  # unscaled values

        # load copymappedresponsevariables from other neighborhing subsystmes which may be necessary for this analysis
        # scalers: List[ScalerBasis] = subsystem.get_Scalers() 
        # copymappedresponsevariables_neighbor_id_scaled01: List[float] | None = subsystem.get_Copy_MappedResponseVariables(id=neighbor_id)  # scaled01 values
        # # to unscale, run
        # copymappedresponsevariables_neighbor_id = scalers[corresponding_index].inverse_transform(copymappedresponsevariables_neighbor_id_scaled01)  # unscaled value        

        # Compute responses using des_var and copymappedresponsevariables
        ################################################################
        ###          USER CODE: Compute responses                    ###
        ################################################################
        # responses are the shared design variables z1, z2, z3 and local design variables x1, x2

        responses = [des_var[2], des_var[3], des_var[4], des_var[0], des_var[1]]

        # responses is a unscaled quantity
        ################################################################
        ###          END USER CODE                                   ###
        ################################################################

        subsystem.set_Responses_Unscaled(responses)

    def mapLocalResponsesDesignVariables_to_CouplingParameters(self, subsystem: LocalSubSystemBasis) -> None:
        """Map subsystem responses to neighboring subsystems.

        Distributes target design variables z1, z2, z3 to subsystem 0 and
        shared design variables to subsystem 2.

        Args:
            subsystem: The local subsystem containing responses and scalers.
        """
        responses: List[float] = subsystem.get_Responses_Unscaled()  # unscaled values
        scalers: List[ScalerBasis] = subsystem.get_Scalers()
        des_var: List[float] = subsystem.get_DesignVariables()  # scaled01 values
        des_var_unscaled: List[float] = subsystem.get_DesignVariables_Unscaled()  # unscaled values

        # map responses and shared/target design variables
        ################################################################
        ###          USER CODE: Map to coupling parameters           ###
        ################################################################
        # only map scaled01 quantities!

        subsystem.set_TargetSharedDesignVariables(id="0",
                                                  targetdesignvariablesin=[des_var[2], des_var[3], des_var[4]],
                                                  targetdesignvariablesin_unscaled=[des_var_unscaled[2], des_var_unscaled[3], des_var_unscaled[4]])  # z1, z2, z3 with subsystem 0

        subsystem.set_SharedDesignVariables(id="2",
                                            shareddesignvariablesin=[des_var[2], des_var[3], des_var[4]],
                                            shareddesignvariablesin_unscaled=[des_var_unscaled[2], des_var_unscaled[3], des_var_unscaled[4]])  # z1, z2, z3 with subsystem 2
        ################################################################
        ###          END USER CODE                                   ###
        ################################################################

    def mapLocalResponsesDesignVariables_to_CouplingParameters_Jacobians(self, subsystem: LocalSubSystemBasis) -> None:
        """Map the Jacobians of the mapped responses.

        Args:
            subsystem: The subsystem for which the Jacobians are mapped.
        """

        ################################################################
        ###          USER CODE: Compute Jacobians                    ###
        ################################################################
        # This subsystem exchanges only shared design variables (no mapped
        # responses), so there is no mapped-response Jacobian to provide.
        pass
        ################################################################
        ###          END USER CODE                                   ###
        ################################################################

    def mapLocalResponsesDesignVariables_to_CouplingParameters_Hessian(self, subsystem: LocalSubSystemBasis) -> None:
        """Map the Hessians of the mapped responses, if known a priori.

        Args:
            subsystem: The subsystem for which the Hessians are mapped.
        """
        pass