geoprob_pipe.calculations.systems.base_objects.system_calculation
=================================================================

.. py:module:: geoprob_pipe.calculations.systems.base_objects.system_calculation


Attributes
----------

.. autoapisummary::

   geoprob_pipe.calculations.systems.base_objects.system_calculation.logger
   geoprob_pipe.calculations.systems.base_objects.system_calculation.DEFAULT_RELIABILITY_SETTINGS


Classes
-------

.. autoapisummary::

   geoprob_pipe.calculations.systems.base_objects.system_calculation.SystemSetup
   geoprob_pipe.calculations.systems.base_objects.system_calculation.SystemResults
   geoprob_pipe.calculations.systems.base_objects.system_calculation.SystemCalculation


Functions
---------

.. autoapisummary::

   geoprob_pipe.calculations.systems.base_objects.system_calculation._apply_settings
   geoprob_pipe.calculations.systems.base_objects.system_calculation._apply_distributions
   geoprob_pipe.calculations.systems.base_objects.system_calculation._apply_correlations
   geoprob_pipe.calculations.systems.base_objects.system_calculation._generate_dps_limit_states
   geoprob_pipe.calculations.systems.base_objects.system_calculation._generate_dp_reliability
   geoprob_pipe.calculations.systems.base_objects.system_calculation._generate_dp_combine


Module Contents
---------------

.. py:data:: logger

.. py:data:: DEFAULT_RELIABILITY_SETTINGS
   :type:  Dict[str, Union[str, float, int]]

.. py:class:: SystemSetup(distributions, correlations, reliability_settings, variables_function = None, system_limit_states = None, project_limit_state = None)

   .. py:attribute:: distributions
      :type:  List[Dict]


   .. py:attribute:: correlations
      :type:  List[Tuple[str, str, float]]


   .. py:attribute:: reliability_settings
      :type:  Dict[str, Union[str, float, int]]


   .. py:attribute:: variables_function
      :type:  Optional[Callable]
      :value: None



   .. py:attribute:: system_limit_states
      :type:  Optional[List[Callable]]
      :value: None



   .. py:attribute:: project_limit_state
      :type:  Optional[Callable]
      :value: None



.. py:class:: SystemResults

   .. py:attribute:: reliability_project


   .. py:attribute:: dps_limit_states
      :type:  List[probabilistic_library.DesignPoint]
      :value: []



   .. py:attribute:: dp_reliability
      :type:  Optional[probabilistic_library.DesignPoint]
      :value: None



   .. py:attribute:: combine_project


   .. py:attribute:: dp_combine
      :type:  Optional[probabilistic_library.DesignPoint]
      :value: None



.. py:class:: SystemCalculation(distributions, correlations, reliability_settings = None, variables_function = None, system_limit_states = None, project_limit_state = None)

   Performs


   .. py:attribute:: validation_messages


   .. py:attribute:: metadata


   .. py:attribute:: setup


   .. py:attribute:: results


   .. py:method:: run()


.. py:function:: _apply_settings(system_calculation)

   Applies the settings of both the Reliability Project and the Combine Project, where the former can be user
   defined settings.


.. py:function:: _apply_distributions(system_calculation)

   Both initiates the variables and applies the distributions.


.. py:function:: _apply_correlations(system_calculation)

   Correlations will be applied to the Reliability Project.


.. py:function:: _generate_dps_limit_states(system_calculation)

   Generates the design points for the limit states separately, i.e. uplift, heave and Sellmeijer. It uses the
   Reliability Project for this.


.. py:function:: _generate_dp_reliability(system_calculation)

   Generates the design point for the piping limit state, i.e. an encapsulating limit state for uplift, heave
   and Sellmeijer. It uses the Reliability Project for this.


.. py:function:: _generate_dp_combine(system_calculation)

   Generates the design point for the Combine Project.