force_field_factory

Factory class for generating force fields

class MDMC.MD.force_fields.force_field_factory.ForceFieldFactory[source]

Provides a factory for creating a ForceField. Any force field within the force fields folder can be created with a string of the class name, as long as it is a subclass of ForceField.

static create_force_field(module_name)[source]
Returns

A ForceField specified by module_name

Return type

ForceField

static get_force_field_names()[source]

Get the names of available force fields

Requires all ForceField derived classes to be in modules of the same name

Returns

A list of str with the names of the available ForceField objects

Return type

list