:orphan:

:mod:`atsim.potentials.config._potential_form_builder`
======================================================

.. py:module:: atsim.potentials.config._potential_form_builder


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

Classes
~~~~~~~

.. autoapisummary::

   atsim.potentials.config._potential_form_builder.Potential_Form_Builder



.. py:exception:: UnknownModifierException

   Bases: :class:`atsim.potentials.config._common.ConfigurationException`

   Common base class for all non-exit exceptions.

   .. method:: __str__(self)

      Return str(self).



.. py:exception:: UnknownPotentialFormException

   Bases: :class:`atsim.potentials.config._common.ConfigurationException`

   Common base class for all non-exit exceptions.

   .. method:: __str__(self)

      Return str(self).



.. py:class:: Potential_Form_Builder(potential_form_registry, modifier_registry)

   Bases: :class:`object`

   Class that instantiates potential function callables from PotentialFormInstanceTuple

   .. method:: create_potential_function(self, potential_form_instance)

      Create a callable for a given potential form tuple.

      :param potential_form_instance: PotentialFormInstanceTuple (or PotentialModifierTuple) defining potential form callable.
      :return: Single parameter potential function