Skip to content

Commit

Permalink
docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
dham committed Dec 17, 2024
1 parent 6768c9f commit f98e837
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions firedrake/cofunction.py
Original file line number Diff line number Diff line change
Expand Up @@ -363,16 +363,18 @@ def cell_node_map(self):


class RieszMap:
"""Return a map from a dual to a primal function space.
"""Return a map between dual and primal function spaces.
A `RieszMap` can be called on a `Cofunction` in the appropriate space
to yield the `Function` which is the Riesz representer under the.
A `RieszMap` can be called on a `Cofunction` in the appropriate space to
yield the `Function` which is the Riesz representer under the given inner
product. Conversely, it can be called on a `Function` to apply the given
inner product and return a `Cofunction`.
Parameters
----------
function_space_or_inner_product: FunctionSpace or Function or Cofunction or ufl.Form
The space from which to map, or a bilinear form defining an
inner product.
function_space_or_inner_product: FunctionSpace or ufl.Form
The space from which to map, or a bilinear form defining an inner
product.
sobolev_space: str or ufl.sobolevspace.SobolevSpace.
Used to determine the inner product.
bcs: DirichletBC or list of DirichletBC
Expand Down

0 comments on commit f98e837

Please sign in to comment.