diff --git a/doc/Makefile b/doc/Makefile index ef3f08b4aff3ddd829002aaa1927b07a58961e90..16b3dd6c1dfede369015f8a2fd372cd898736307 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -3,14 +3,14 @@ # You can set these variables from the command line. SPHINXOPTS = -SPHINXBUILD = sphinx-build +SPHINXBUILD = python -m sphinx PAPER = BUILDDIR = _build # User-friendly check for sphinx-build -ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) -$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) -endif +# ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) +# $(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) +# endif # Internal variables. PAPEROPT_a4 = -D latex_paper_size=a4 diff --git a/doc/connection.rst b/doc/connection.rst new file mode 100644 index 0000000000000000000000000000000000000000..7f4660bcfdc92dfe95718e91703c94dc49a92f7c --- /dev/null +++ b/doc/connection.rst @@ -0,0 +1,4 @@ +Connections: Interpolating between Discretizations +================================================== + +.. automodule:: meshmode.discretization.connection diff --git a/doc/discretization.rst b/doc/discretization.rst index 5e66d79b10b9ad02b8cecfe210f8263ff79b97c9..9389cd8502f3a2ef3634d3e2e043c6496f08a5a2 100644 --- a/doc/discretization.rst +++ b/doc/discretization.rst @@ -6,16 +6,11 @@ Abstract interface .. automodule:: meshmode.discretization -Composite polynomial discretization ------------------------------------ +Element Groups for Composite Polynomial Discretization +------------------------------------------------------ .. automodule:: meshmode.discretization.poly_element -Connection/interpolation ------------------------- - -.. automodule:: meshmode.discretization.connection - Visualization ------------- diff --git a/doc/index.rst b/doc/index.rst index 4bde9b27731468d2d65b2fe35c3ee887242debea..3a7a2ba71dab133f5f754ef2d213c01f23d97d32 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -8,6 +8,7 @@ Contents: mesh discretization + connection misc Indices and tables diff --git a/meshmode/discretization/connection/__init__.py b/meshmode/discretization/connection/__init__.py index 5f136982d799b14ccaddef05e700dc0ec75b5156..ee1efd0c3c7078c298894c3825a9787532b3b3a3 100644 --- a/meshmode/discretization/connection/__init__.py +++ b/meshmode/discretization/connection/__init__.py @@ -61,27 +61,41 @@ __all__ = [ ] __doc__ = """ +Base classes +------------ .. autoclass:: DiscretizationConnection .. autoclass:: ChainedDiscretizationConnection .. autoclass:: DirectDiscretizationConnection + +Same-mesh connections +--------------------- .. autofunction:: make_same_mesh_connection -.. autofunction:: FACE_RESTR_INTERIOR -.. autofunction:: FACE_RESTR_ALL +Restriction to faces +-------------------- +.. autodata:: FACE_RESTR_INTERIOR +.. autodata:: FACE_RESTR_ALL .. autofunction:: make_face_restriction .. autofunction:: make_face_to_all_faces_embedding .. autofunction:: make_opposite_face_connection + +Mesh partitioning +----------------- .. autofunction:: make_partition_connection +Refinement +---------- .. autofunction:: make_refinement_connection +Flattening a :class:`ChainedDiscretizationConnection` +----------------------------------------------------- .. autofunction:: flatten_chained_connection Implementation details -^^^^^^^^^^^^^^^^^^^^^^ +---------------------- .. autoclass:: InterpolationBatch