Analytical fields
=================

.. automodule:: edelweissfe.config.analyticalfields
    :members: __doc__

``scalarexpression`` - Field defined by expression
--------------------------------------------------

Relevant module ``edelweissfe.analyticalfields.scalarexpression``

.. automodule:: edelweissfe.analyticalfields.scalarexpression
    :members: __doc__

.. pprint:: edelweissfe.analyticalfields.scalarexpression.documentation
    :caption: Options

.. literalinclude:: ../../../testfiles/AnalyticalFieldsScalarExpression/test.inp
    :language: edelweiss
    :caption: Example: ``testfiles/AnalyticalFieldsScalarExpression/test.inp``

``randomscalar`` - A random field
---------------------------------

Relevant module ``edelweissfe.analyticalfields.randomscalar``

.. automodule:: edelweissfe.analyticalfields.randomscalar
    :members: __doc__

.. pprint:: edelweissfe.analyticalfields.randomscalar.documentation
    :caption: Options

.. literalinclude:: ../../../testfiles/AnalyticalFieldsRandomScalar/test.inp
    :language: edelweiss
    :caption: Example: ``testfiles/AnalyticalFieldsRandomScalar/test.inp``

Implementing your own fields
----------------------------

Subclass from the field base class in module ``edelweissfe.analyticalfields.base.analyticalfieldbase``

.. automodule:: edelweissfe.analyticalfields.base.analyticalfieldbase
   :members: