.. file:pysic_fortran

.. _pysic_fortran:






.. file:pysic_fortran - description

.. _pysic_fortran - description:




.. module:: pysic.pysic_fortran
.. module:: pysic.pysic_fortran.pysic_interface

====================
Pysic Fortran module
====================

Pysic Fortran (:mod:`pysic.pysic_fortran`) is the Python interface of the Fortran core generated
using `f2py`_ from PyInterface.F90. This is the only Fortran source file of Pysic 
that should be wrapped with f2py: the rest of the core needs to be directly 
compiled with a Fortran compiler to .mod Fortran modules.

The module is naturally accessible from within Python, 
but usually there should be no need to directly invoke its functions as :mod:`~pysic` 
defines a more refined interface to the Fortran core, mainly through the
class :class:`~pysic.calculator.Pysic`. It is assumed that the arguments passed to the functions
have proper data types and array dimensions, and that they are called in such an
order that the necessary memory allocations have been done within Fortran before data
structures are accessed. Methods in :class:`~pysic.calculator.Pysic` do this automatically and are 
thus much safer to use than directly calling the functions in this module. The Fortran routines are documented here mostly for development purposes.

.. _f2py: http://www.scipy.org/F2py

.. file:pysic_fortran - autogenerated

.. _pysic_fortran - autogenerated:





Modules of the Fortran core of Pysic
------------------------------------

.. toctree::
   :maxdepth: 3

   PyInterface_f90
   Core_f90
   Potentials_f90
   Geometry_f90
   Utility_f90
   MPI_f90
   Quaternions_f90
   Mersenne_f90