atsim.potentials.config._potential_form_builder

Module Contents

Classes

Potential_Form_Builder(potential_form_registry, modifier_registry)

Class that instantiates potential function callables from PotentialFormInstanceTuple

exception atsim.potentials.config._potential_form_builder.UnknownModifierException

Bases: atsim.potentials.config._common.ConfigurationException

Common base class for all non-exit exceptions.

__str__(self)

Return str(self).

exception atsim.potentials.config._potential_form_builder.UnknownPotentialFormException

Bases: atsim.potentials.config._common.ConfigurationException

Common base class for all non-exit exceptions.

__str__(self)

Return str(self).

class atsim.potentials.config._potential_form_builder.Potential_Form_Builder(potential_form_registry, modifier_registry)

Bases: object

Class that instantiates potential function callables from PotentialFormInstanceTuple

create_potential_function(self, potential_form_instance)

Create a callable for a given potential form tuple.

Parameters:potential_form_instance – PotentialFormInstanceTuple (or PotentialModifierTuple) defining potential form callable. Returns:Single parameter potential function