underworld.function module
==========================

The function module contains the Function class, and related classes.

Function objects are constructed in python, but evaluated in C for 
efficiency. They provide a high level interface for users to compose model
behaviour (such as viscosity), as well as a natural interface by which
discrete data (such as meshvariables) may be utilised.



Submodules
~~~~~~~~~~~

.. toctree::
    :titlesonly: 
    :hidden: 

    underworld.function.analytic.rst
    underworld.function.branching.rst
    underworld.function.exception.rst
    underworld.function.math.rst
    underworld.function.misc.rst
    underworld.function.rheology.rst
    underworld.function.shape.rst
    underworld.function.tensor.rst
    underworld.function.view.rst

.. autosummary::
    :nosignatures:

    underworld.function.analytic
    underworld.function.branching
    underworld.function.exception
    underworld.function.math
    underworld.function.misc
    underworld.function.rheology
    underworld.function.shape
    underworld.function.tensor
    underworld.function.view

.. module:: underworld.function

Classes
~~~~~~~

.. autosummary::
    :nosignatures:

    underworld.function.Function
    underworld.function.FunctionInput
    underworld.function.coord
    underworld.function.input

.. autoclass:: underworld.function.Function
    :members:
    :show-inheritance:
.. autoclass:: underworld.function.FunctionInput
    :members:
    :show-inheritance:
.. autoclass:: underworld.function.coord
    :members:
    :show-inheritance:
.. autoclass:: underworld.function.input
    :members:
    :show-inheritance: