pyHarm.KinematicConditions.FactoryKinematic

Module that contains the factory of the ABCKinematic subclasses.

pyHarm.KinematicConditions.FactoryKinematic.Kinematic_dico

Dictionary containing ABCKinematic as values and their factory_keyword attribute as key.

Type:

dict

Attributes

Kinematic_dico

Dictionary containing ABCKinematic as values and their factory_keyword attribute as key.

Functions

generateKinematic(...)

Factory function that creates a ABCKinematic object.

Module Contents

pyHarm.KinematicConditions.FactoryKinematic.Kinematic_dico

Dictionary containing ABCKinematic as values and their factory_keyword attribute as key.

Type:

dict

pyHarm.KinematicConditions.FactoryKinematic.generateKinematic(nh, nti, name, data, dict_CS: dict[str, pyHarm.CoordinateSystem.CoordinateSystem]) → pyHarm.KinematicConditions.ABCKinematic.ABCKinematic

Factory function that creates a ABCKinematic object.

Parameters:

  • nh (int) – number of harmonics.

  • nti (int) – number of time steps.

  • name (str) – type of kinematic condition to instantiate.

  • data (dict) – dictionary containing the definition of the kinematic condition.

  • dict_CS (dict[str,CoordinateSystem]) – dictionary containing all the local and global coordinate systems.

Returns:

Instance of the required ABCKinematic class.

Return type:

ABCKinematic