Skip to content

Commit

Permalink
Update comments for the generate_tracer_mass_terms routine
Browse files Browse the repository at this point in the history
  • Loading branch information
ta440 committed Mar 15, 2024
1 parent f6c886a commit 301c7ff
Showing 1 changed file with 8 additions and 9 deletions.
17 changes: 8 additions & 9 deletions gusto/equations.py
Original file line number Diff line number Diff line change
Expand Up @@ -432,18 +432,17 @@ def add_tracers_to_prognostics(self, domain, active_tracers):

def generate_tracer_mass_terms(self, active_tracers):
"""
Builds the weak time derivative terms for the equation set.
Generates the weak time derivative terms ("mass terms") for all the
prognostic variables of the equation set.
The mass terms can differ depending on the tracer type. A mixing ratio
that is being transported conservatively will need its mass form multiplied
by a reference density.
Adds the mass forms for the active tracers to the equation set.
Args:
active_tracers (list): A list of :class:`ActiveTracer` objects that
encode the metadata for the active tracers.
Returns:
:class:`LabelledForm`: a labelled form containing the mass terms.
:class:`LabelledForm`: a labelled form containing the mass
terms for the active tracers. This is the usual mass form
unless using tracer_conservative, where it is multiplied
by the reference density.
"""

for i, tracer in enumerate(active_tracers):
Expand Down

0 comments on commit 301c7ff

Please sign in to comment.