Skip to content

Commit

Permalink
update citations for html (#160)
Browse files Browse the repository at this point in the history
Linked to
mesh-adaptation/docs#50

should be evaluated in combination with:
mesh-adaptation/docs#50
mesh-adaptation/goalie#232
mesh-adaptation/movement#132

Locally the main warning remaining after all the PRs should be about
'duplicate_citations', though all citations should still render.
  • Loading branch information
acse-ej321 authored Dec 6, 2024
1 parent 0600554 commit d78b142
Show file tree
Hide file tree
Showing 6 changed files with 19 additions and 37 deletions.
4 changes: 2 additions & 2 deletions animate/interpolation.py
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ def project(source, target_space, **kwargs):
projection operator when applied to :class:`firedrake.cofunction.Cofunction`\s.
For details on the approach for achieving boundedness through mass lumping and
post-processing, see :cite:`FPP+:2009`.
post-processing, see :cite:`Farrell:2009`.
:arg source: the function to be transferred
:type source: :class:`firedrake.function.Function` or
Expand Down Expand Up @@ -296,7 +296,7 @@ def _validate_matching_spaces(Vs, Vt):
def clement_interpolant(source, target_space=None, boundary=False):
r"""
Compute the Clement interpolant of a :math:`\mathbb P0` source field, i.e. take the
volume average over neighbouring cells at each vertex. See :cite:`Cle:75`.
volume average over neighbouring cells at each vertex. See :cite:`Clement:1975`.
:arg source: the :math:`\mathbb P0` source field
:kwarg target_space: the :math:`\mathbb P1` space to interpolate into
Expand Down
12 changes: 6 additions & 6 deletions animate/metric.py
Original file line number Diff line number Diff line change
Expand Up @@ -799,9 +799,9 @@ def compute_isotropic_dwr_metric(
Compute an isotropic metric from some error indicator using an element-based
formulation.
The formulation is based on that presented in :cite:`CPB:13`. Note that
The formulation is based on that presented in :cite:`Carpio:2013`. Note that
normalisation is implicit in the metric construction and involves the
`convergence_rate` parameter, named :math:`alpha` in :cite:`CPB:13`.
`convergence_rate` parameter, named :math:`alpha` in :cite:`Carpio:2013`.
Whilst an element-based formulation is used to derive the metric, the result is
projected into :math:`\mathbb P1` space, by default.
Expand Down Expand Up @@ -834,9 +834,9 @@ def compute_anisotropic_dwr_metric(
r"""
Compute an anisotropic metric from some error indicator, given a Hessian field.
The formulation used is based on that presented in :cite:`CPB:13`. Note that
The formulation used is based on that presented in :cite:`Carpio:2013`. Note that
normalisation is implicit in the metric construction and involves the
`convergence_rate` parameter, named :math:`alpha` in :cite:`CPB:13`.
`convergence_rate` parameter, named :math:`alpha` in :cite:`Carpio:2013`.
If a Hessian is not provided then an isotropic formulation is used.
Expand Down Expand Up @@ -936,7 +936,7 @@ def compute_weighted_hessian_metric(
Compute a vertex-wise anisotropic metric from a list of error indicators, given
a list of corresponding Hessian fields.
The formulation used is based on that presented in :cite:`PPP+:06`. It is
The formulation used is based on that presented in :cite:`Power:2006`. It is
assumed that the error indicators have been constructed in the appropriate way.
:arg error_indicators: list of error indicators
Expand Down Expand Up @@ -987,7 +987,7 @@ def determine_metric_complexity(H_interior, H_boundary, target, p, **kwargs):
Solve an algebraic problem to obtain coefficients for the interior and boundary
metrics to obtain a given metric complexity.
See :cite:`LDA:10` for details. Note that we use a slightly different formulation
See :cite:Loseille:2010` for details. Note that we use a slightly different formulation
here.
:arg H_interior: Hessian component from domain interior
Expand Down
6 changes: 6 additions & 0 deletions demos/bubble_shear.py
Original file line number Diff line number Diff line change
Expand Up @@ -511,3 +511,9 @@ def adapt_metric_advection(mesh, t_start, t_end, c):
# to maintain numerical stability (look at CFL condition).
#
# This demo can also be accessed as a `Python script <bubble_shear.py>`__.
#
#
# .. rubric:: References
#
# .. bibliography::
# :filter: docname in docnames
5 changes: 2 additions & 3 deletions demos/combining_metrics.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,8 @@
# intersection of two metrics produces a metric whose associated ellipsoid is
# the largest ellipsoid that can fit within the ellipsoids of the two metrics:
#
# .. figure:: combining_ellipse_intersection.jpg
# :figwidth: 70%
# :align: center
# .. raw:: html
# :file: combining_ellipse_intersection.svg
#
# Below we first set up two metrics: Metric 1 asks for a medium resolution of
# :math:`hm=0.025` in the left, and a coarse resolution of :math:`hc=0.1` in
Expand Down
24 changes: 0 additions & 24 deletions demos/demo_references.bib

This file was deleted.

5 changes: 3 additions & 2 deletions demos/ping_pong.py
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@
# :math:`\mathbb P1` fields specifically, it is possible to achieve this using 'mass
# lumping'. Recall the linear system above. Lumping amounts to replacing the mass matrix
# :math:`\underline{\mathbf{M}_B}` with a diagonal matrix, whose entries correspond to
# the sums over the corresponding mass matrix rows. (See :cite:`FPP+:2009` for details.)
# the sums over the corresponding mass matrix rows. (See :cite:`Farrell:2009` for details.)
#
# The resulting bounded projection operator can be used in Animate by passing
# ``bounded=True`` to the ``project`` function. ::
Expand Down Expand Up @@ -247,7 +247,8 @@
#
# This demo can also be accessed as a `Python script <ping_pong.py>`__.
#
#
# .. rubric:: References
#
# .. bibliography:: demo_references.bib
# .. bibliography::
# :filter: docname in docnames

0 comments on commit d78b142

Please sign in to comment.