:orphan:

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

.. py:module:: atsim.potentials.config._potential_form


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

Classes
~~~~~~~

.. autoapisummary::

   atsim.potentials.config._potential_form.Potential_Form
   atsim.potentials.config._potential_form.Existing_Potential_Form



.. py:class:: Potential_Form(potential_function)

   Bases: :class:`object`

   Wraps cexprtk and python functions so that they can be used
   as potential-form style function factories in Potential_Form_Registry

   .. attribute:: potential_function
      

      

   .. attribute:: signature
      

      

   .. attribute:: expression
      

      

   .. method:: __call__(self, *args)



.. py:class:: Existing_Potential_Form(name, potential_form)

   Bases: :class:`object`

   Wraps an object from the atsim.potentials.potentialforms module so that 
   it can be registered directly with Potential_Form_Registry and so used from
   config files. 

   This is the case for objects that are registered in potentialforms
   but not in the potentialfunctions module

   .. attribute:: signature
      

      

   .. method:: __call__(self, *args)