Skip to content
Snippets Groups Projects
Commit 86c12ec4 authored by Christoph Groth's avatar Christoph Groth
Browse files

absorb solver module docstrings into the documentation

parent c7ab3a29
No related branches found
No related tags found
No related merge requests found
:mod:`kwant.solvers.common` -- common functionality used by solvers
===================================================================
.. automodule:: kwant.solvers.common
.. module:: kwant.solvers.common
This module typically needs not be used directly by the user. It is rather
used by the individual solver modules.
.. autosummary::
:toctree: generated/
......
:mod:`kwant.solvers.mumps` -- High performance sparse solver based on MUMPS
===========================================================================
.. automodule:: kwant.solvers.mumps
.. module:: kwant.solvers.mumps
A sparse solver that uses `MUMPS <http://graal.ens-lyon.fr/MUMPS/>`_. (Only
the sequential, single core version is used.)
MUMPS is a very efficient direct sparse solver that can take advantage of
memory beyond 3GB for the solution of large problems. Furthermore, it offers a
choice of several orderings of the input matrix from which can speed up a
calculation significantly.
Compared to the generic sparse solver framework, `mumps` adds the following
control options that may affect performance:
- `ordering`: a fill-in reducing ordering of the matrix
- `nrhs`: number of right hand sides that should be solved simultaneously
- `sparse_rhs`: whether to use dense or sparse right hand sides
For more details see `~Solver.options`.
.. autosummary::
:toctree: generated/
......
:mod:`kwant.solvers.sparse` -- Basic sparse matrix solver
=========================================================
.. automodule:: kwant.solvers.sparse
.. module:: kwant.solvers.sparse
A sparse solver that uses `scipy.sparse.linalg
<http://docs.scipy.org/doc/scipy/reference/sparse.linalg.html>`_.
SciPy currently uses internally either the direct sparse solver UMFPACK or if
that is not installed, SuperLU. Often, SciPy's SuperLU will give quite poor
performance and you will be warned if only SuperLU is found. The module
variable `uses_umfpack` can be checked to determine if UMFPACK is being used.
`sparse` does not introduce any additional options as compared to the generic
sparse solver framework.
.. autosummary::
:toctree: generated/
......
"""Collection of things commonly used by the different solvers.
Typically needs not be called by the user, but is rather used by the
individual solver modules
"""
__all__ = ['SparseSolver', 'BlockResult']
from collections import namedtuple
......
"""Implementation of the sparse solver framework using the direct sparse solver
MUMPS (http://graal.ens-lyon.fr/MUMPS/, only the sequential, single core
version is used).
MUMPS is a very efficient direct sparse solver that can take advantage of
memory beyond 3GB for the solution of large problems. Furthermore, it offers a
choice of several orderings of the input matrix from which can speed up a
calculation significantly.
Compared to the generic sparse solver framework, `mumps` adds the following
control options that may affect performance:
- `ordering`: a fill-in reducing ordering of the matrix
- `nrhs`: number of right hand sides that should be solved simultaneously
- `sparse_rhs`: whether to use dense or sparse right hand sides
For more details see `~Solver.options`.
"""
__all__ = ['solve', 'ldos', 'wave_func', 'options', 'Solver']
import numpy as np
......
"""Implementation of the sparse solver framework using the direct sparse solver
provided by `scipy.sparse.linalg
<http://docs.scipy.org/doc/scipy/reference/sparse.linalg.html>`.
SciPy currently uses internally either the direct sparse solver UMFPACK or if
that is not installed, SuperLU. Often, SciPy's SuperLU will give quite poor
performance and you will be warned if only SuperLU is found. The module
variable `uses_umfpack` can be checked to determine if UMFPACK is being used.
`sparse` does not introduce any additional options as compared to the generic
sparse solver framework.
"""
__all__ = ['solve', 'ldos', 'wave_func', 'Solver']
import warnings
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment