pyHarm.Analysis.FactoryNonLinearStudy

This module is the factory of ABCAnalysis subclasses.

pyHarm.Analysis.FactoryNonLinearStudy.NonLinearStudy_kind

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

Type:

dict[str, ABCAnalysis]

Attributes

NonLinearStudy_kind

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

Functions

generateNonLinearAnalysis(...)

Factory function that creates a ABCAnalysis object.

Module Contents

pyHarm.Analysis.FactoryNonLinearStudy.NonLinearStudy_kind

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

Type:

dict[str, ABCAnalysis]

pyHarm.Analysis.FactoryNonLinearStudy.generateNonLinearAnalysis(name_nonlinearstudy, datas: dict, system: pyHarm.Systems.ABCSystem.ABCSystem, logger: logging.Logger | None = None, key: str = '', **kwargs) pyHarm.Analysis.ABCAnalysis.ABCAnalysis

Factory function that creates a ABCAnalysis object.

Parameters:
  • name_nonlinearstudy (str) – type of ABCAnalysis to instantiate.

  • datas (dict) – dictionary containing the definition of the analysis.

  • system (ABCSystem) – System associated with the analysis.

Returns:

Instance of the required ABCAnalysis class.

Return type:

ABCAnalysis