pyHarm.Analysis.FactoryNonLinearStudy
=====================================

.. py:module:: pyHarm.Analysis.FactoryNonLinearStudy

.. autoapi-nested-parse::

   This module is the factory of ABCAnalysis subclasses.

   .. attribute:: NonLinearStudy_kind

      Dictionary containing ABCAnalysis subclasses as values and their factory_keyword attribute as key.

      :type: dict[str, ABCAnalysis]



Attributes
----------

.. autoapisummary::

   pyHarm.Analysis.FactoryNonLinearStudy.NonLinearStudy_kind


Functions
---------

.. autoapisummary::

   pyHarm.Analysis.FactoryNonLinearStudy.generateNonLinearAnalysis


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

.. py:data:: NonLinearStudy_kind

   Dictionary containing ABCAnalysis subclasses as values and their factory_keyword attribute as key.

   :type: dict[str, ABCAnalysis]

.. py:function:: generateNonLinearAnalysis(name_nonlinearstudy, datas: dict, system: pyHarm.Systems.ABCSystem.ABCSystem, **kwargs) -> pyHarm.Analysis.ABCAnalysis.ABCAnalysis

   Factory function that creates a ABCAnalysis object.

   :param name_nonlinearstudy: type of ABCAnalysis to instantiate.
   :type name_nonlinearstudy: str
   :param datas: dictionary containing the definition of the analysis.
   :type datas: dict
   :param system: System associated with the analysis.
   :type system: ABCSystem

   :returns: Instance of the required ABCAnalysis class.
   :rtype: ABCAnalysis