Skip to content

Commit

Permalink
Adding modindex_common_prefix
Browse files Browse the repository at this point in the history
  • Loading branch information
mikaem committed Aug 6, 2024
1 parent e14d9d5 commit 4a89475
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 1 deletion.
1 change: 1 addition & 0 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@
napoleon_use_param = False
napoleon_use_ivar = True
bibtex_bibfiles = ['papers.bib']
modindex_common_prefix = ['shenfun.']

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
Expand Down
26 changes: 25 additions & 1 deletion shenfun/spectralbase.py
Original file line number Diff line number Diff line change
Expand Up @@ -1834,6 +1834,30 @@ class BoundaryConditions(dict):
Etc. Any combination should be possible, and it should also be possible
to use higher order derivatives with `N2`, `N3` etc.
It is also possible to apply Robin conditions
.. math::
u(x) + c u'(x) = d
Applying this on both sides of the domain is achieved through::
bc = {'left': {'R': (c, d)}, 'right': {'R': (c, d)}}
Finally, one can use the boundary condition
.. math::
u'(x) + c u''(x) = d
Applying this on both sides of the domain::
bc = {'left': {'W': (c, d)}, 'right': {'W': (c, d)}}
Currently there are no hardcoded spaces implemented for these latter two boundary
conditions, so the composition of these bases is computed using a generic approach
that is slower than for the more common Dirichlet and Neumann spaces.
If `bc` is an n-tuple, then we assume the basis function is::
(None, a) - {'right': {'D': a}}
Expand Down Expand Up @@ -2317,7 +2341,7 @@ def get_norm_sq(v, u, method):
.. math::
`(\phi_i, \phi_i)_w`
(\phi_i, \phi_i)_w
where :math:`\phi_i` is the orthogonal basis for a spectral family.
Expand Down

0 comments on commit 4a89475

Please sign in to comment.