Skip to content

Commit

Permalink
aaorf - fix docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
JHopeCollins committed Jan 2, 2025
1 parent 0447e7b commit 0a40dc8
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions firedrake/adjoint/fourdvar_reduced_functional.py
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,8 @@ class FourDVarReducedFunctional(ReducedFunctional):
----------
control
The :class:`EnsembleFunction` for the control x_{i} at the initial condition and at the end of each observation stage.
The :class:`.EnsembleFunction` for the control x_{i} at the initial condition
and at the end of each observation stage.
background_iprod
The inner product to calculate the background error functional
Expand All @@ -113,8 +114,8 @@ class FourDVarReducedFunctional(ReducedFunctional):
background
The background (prior) data for the initial condition :math:`x_{b}`.
If not provided, the value of the first Function on the first ensemble
of the EnsembleFunction will be used.
If not provided, the value of the first subfunction on the first ensemble
member of the control :class:`.EnsembleFunction` will be used.
observation_err
Given a state :math:`x`, returns the observations error
Expand Down

0 comments on commit 0a40dc8

Please sign in to comment.