Skip to content
Snippets Groups Projects
Commit 922d7fbe authored by Andreas Klöckner's avatar Andreas Klöckner
Browse files

Doc tweaks

parent dc56b8fd
No related branches found
No related tags found
No related merge requests found
TODO 0 → 100644
- Split out affinely mapped groups
- p refinement
Common infrastructure
=====================
.. automodule:: meshmode
Mesh management
===============
......
#! /bin/sh
rsync --progress --verbose --archive --delete _build/html/* doc-upload:doc/meshmode
from __future__ import division
__copyright__ = "Copyright (C) 2014 Andreas Kloeckner"
__license__ = """
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
"""
__doc__ = """
.. exception:: Error
.. exception:: ConnectivityUnavailable
"""
class Error(RuntimeError):
pass
class ConnectivityUnavailable(Error):
pass
......@@ -35,21 +35,16 @@ __doc__ = """
Group types
^^^^^^^^^^^
.. autclass:: InterpolatoryQuadratureSimplexElementGroup
.. autoclass:: InterpolatoryQuadratureSimplexElementGroup
.. autoclass:: QuadratureSimplexElementGroup
.. autoclass:: PolynomialWarpAndBlendElementGroup
Group factories
^^^^^^^^^^^^^^^
.. autclass:: InterpolatoryQuadratureSimplexGroupFactory
.. autoclass:: InterpolatoryQuadratureSimplexGroupFactory
.. autoclass:: QuadratureSimplexGroupFactory
.. autoclass:: PolynomialWarpAndBlendGroupFactory
Discretization class
^^^^^^^^^^^^^^^^^^^^
.. autoclass:: PolynomialElementDiscretization
"""
# FIXME Most of the loopy kernels will break as soon as we start using multiple
......
......@@ -27,6 +27,20 @@ import modepy as mp
#import numpy.linalg as la
from pytools import Record
__doc__ = """
.. autoclass:: MeshElementGroup
:members:
:undoc-members:
.. autoclass:: Mesh
:members:
:undoc-members:
.. autoclass:: ElementConnectivity
"""
# {{{ element group
......
......@@ -188,7 +188,7 @@ def read_gmsh(filename, force_ambient_dim=None):
def generate_gmsh(source, dimensions, order=None, other_options=[],
extension="geo", gmsh_executable="gmsh", force_ambient_dim=None):
"""Run :cmd:`gmsh` on the input given by *source*, and return a
"""Run :command:`gmsh` on the input given by *source*, and return a
:class:`meshmode.mesh.Mesh` based on the result.
:arg source: an instance of either :class:`FileSource` or
......
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