Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Direct Solver: Recursive Skeletonization #164

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,10 @@
"DOFDescriptorLike": "pytential.symbolic.dof_desc.DOFDescriptorLike",
}

nitpick_ignore_regex = [
["py:class", r".*_ProxyNeighborEvaluationResult"],
]

intersphinx_mapping = {
"arraycontext": ("https://documen.tician.de/arraycontext", None),
"boxtree": ("https://documen.tician.de/boxtree", None),
Expand Down
22 changes: 18 additions & 4 deletions doc/linalg.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ scheme is used:
component of the Stokeslet.
* ``cluster`` refers to a piece of a ``block`` as used by the recursive
proxy-based skeletonization of the direct solver algorithms. Clusters
are represented by a :class:`~pytential.linalg.TargetAndSourceClusterList`.
are represented by a :class:`~pytential.linalg.utils.TargetAndSourceClusterList`.

GMRES
-----
Expand All @@ -20,17 +20,31 @@ GMRES
Hierarchical Direct Solver
--------------------------

.. note::

High-level API for direct solvers is in progress.

Low-level Functionality
-----------------------

.. warning::

All the classes and routines in this module are experimental and the
API can change at any point.

.. automodule:: pytential.linalg.skeletonization
.. automodule:: pytential.linalg.cluster
.. automodule:: pytential.linalg.proxy
.. automodule:: pytential.linalg.utils

Internal Functionality
----------------------
Internal Functionality and Utilities
------------------------------------

.. warning::

All the classes and routines in this module are experimental and the
API can change at any point.

.. automodule:: pytential.linalg.utils
.. automodule:: pytential.linalg.direct_solver_symbolic

.. vim: sw=4:tw=75:fdm=marker
16 changes: 0 additions & 16 deletions pytential/linalg/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,25 +25,9 @@
make_index_list, make_index_cluster_cartesian_product,
interp_decomp,
)
from pytential.linalg.proxy import (
ProxyClusterGeometryData, ProxyPointTarget, ProxyPointSource,
ProxyGeneratorBase, ProxyGenerator, QBXProxyGenerator,
partition_by_nodes, gather_cluster_neighbor_points,
)
from pytential.linalg.skeletonization import (
SkeletonizationWrangler, make_skeletonization_wrangler,
SkeletonizationResult, skeletonize_by_proxy,
)

__all__ = (
"IndexList", "TargetAndSourceClusterList",
"make_index_list", "make_index_cluster_cartesian_product",
"interp_decomp",

"ProxyClusterGeometryData", "ProxyPointTarget", "ProxyPointSource",
"ProxyGeneratorBase", "ProxyGenerator", "QBXProxyGenerator",
"partition_by_nodes", "gather_cluster_neighbor_points",

"SkeletonizationWrangler", "make_skeletonization_wrangler",
"SkeletonizationResult", "skeletonize_by_proxy",
)
Loading
Loading