File tree Expand file tree Collapse file tree 1 file changed +12
-2
lines changed
Expand file tree Collapse file tree 1 file changed +12
-2
lines changed Original file line number Diff line number Diff line change @@ -7,8 +7,18 @@ Computing the barotropic streamfunction
77---------------------------------------
88
99The function :py:func: `mpas_tools.ocean.compute_barotropic_streamfunction() `
10- computes the barotproic streamfunction at vertices on the MPAS-Ocean grid.
10+ computes the barotropic streamfunction at vertices on the MPAS-Ocean grid.
1111The function takes a dataset containing an MPAS-Ocean mesh and another with
1212``normalVelocity `` and ``layerThickness `` variables (possibly with a
13- ``timeMonthly_avg_ `` prefix). The streamfunction is computed only over the
13+ ``timeMonthly_avg_ `` prefix). The streamfunction is computed only over the
1414range of (positive-down) depths provided and at the given time index.
15+
16+ Optionally, the Gent-McWilliams bolus velocity (``normalGMBolusVelocity ``) and
17+ the submesoscale velocity (``normalMLEvelocity ``) can be included in the
18+ vertically integrated velocity calculation by setting the corresponding
19+ arguments ``include_bolus `` and ``include_submesoscale `` to ``True ``.
20+
21+ For large meshes, performance and memory usage can be improved by specifying
22+ the ``horiz_chunk `` argument to control the number of edges processed at once,
23+ and by providing a ``tmp_dir `` argument to use a temporary directory for
24+ intermediate files.
You can’t perform that action at this time.
0 commit comments