roms_tools.BoundaryForcing.plot

BoundaryForcing.plot(var_name, time=0, layer_contours=False, ax=None) → None

Plot the boundary forcing field for a given time-slice.

Parameters:

• var_name (str) –

  The name of the boundary forcing field to plot. Options include:

  • ”temp_{direction}”: Potential temperature,

  • ”salt_{direction}”: Salinity,

  • ”zeta_{direction}”: Sea surface height,

  • ”u_{direction}”: u-flux component,

  • ”v_{direction}”: v-flux component,

  • ”ubar_{direction}”: Vertically integrated u-flux component,

  • ”vbar_{direction}”: Vertically integrated v-flux component,

  • ”PO4_{direction}”: Dissolved Inorganic Phosphate (mmol/m³),

  • ”NO3_{direction}”: Dissolved Inorganic Nitrate (mmol/m³),

  • ”SiO3_{direction}”: Dissolved Inorganic Silicate (mmol/m³),

  • ”NH4_{direction}”: Dissolved Ammonia (mmol/m³),

  • ”Fe_{direction}”: Dissolved Inorganic Iron (mmol/m³),

  • ”Lig_{direction}”: Iron Binding Ligand (mmol/m³),

  • ”O2_{direction}”: Dissolved Oxygen (mmol/m³),

  • ”DIC_{direction}”: Dissolved Inorganic Carbon (mmol/m³),

  • ”DIC_ALT_CO2_{direction}”: Dissolved Inorganic Carbon, Alternative CO2 (mmol/m³),

  • ”ALK_{direction}”: Alkalinity (meq/m³),

  • ”ALK_ALT_CO2_{direction}”: Alkalinity, Alternative CO2 (meq/m³),

  • ”DOC_{direction}”: Dissolved Organic Carbon (mmol/m³),

  • ”DON_{direction}”: Dissolved Organic Nitrogen (mmol/m³),

  • ”DOP_{direction}”: Dissolved Organic Phosphorus (mmol/m³),

  • ”DOPr_{direction}”: Refractory Dissolved Organic Phosphorus (mmol/m³),

  • ”DONr_{direction}”: Refractory Dissolved Organic Nitrogen (mmol/m³),

  • ”DOCr_{direction}”: Refractory Dissolved Organic Carbon (mmol/m³),

  • ”zooC_{direction}”: Zooplankton Carbon (mmol/m³),

  • ”spChl_{direction}”: Small Phytoplankton Chlorophyll (mg/m³),

  • ”spC_{direction}”: Small Phytoplankton Carbon (mmol/m³),

  • ”spP_{direction}”: Small Phytoplankton Phosphorous (mmol/m³),

  • ”spFe_{direction}”: Small Phytoplankton Iron (mmol/m³),

  • ”spCaCO3_{direction}”: Small Phytoplankton CaCO3 (mmol/m³),

  • ”diatChl_{direction}”: Diatom Chlorophyll (mg/m³),

  • ”diatC_{direction}”: Diatom Carbon (mmol/m³),

  • ”diatP_{direction}”: Diatom Phosphorus (mmol/m³),

  • ”diatFe_{direction}”: Diatom Iron (mmol/m³),

  • ”diatSi_{direction}”: Diatom Silicate (mmol/m³),

  • ”diazChl_{direction}”: Diazotroph Chlorophyll (mg/m³),

  • ”diazC_{direction}”: Diazotroph Carbon (mmol/m³),

  • ”diazP_{direction}”: Diazotroph Phosphorus (mmol/m³),

  • ”diazFe_{direction}”: Diazotroph Iron (mmol/m³),

  where {direction} can be one of [“south”, “east”, “north”, “west”].

• time (int, optional) – The time index to plot. Default is 0.

• layer_contours (bool, optional) – If True, contour lines representing the boundaries between vertical layers will be added to the plot. For clarity, the number of layer contours displayed is limited to a maximum of 10. Default is False.

• ax (matplotlib.axes.Axes, optional) – The axes to plot on. If None, a new figure is created.

Returns:

None – This method does not return any value. It generates and displays a plot.

Raises:

ValueError – If the specified var_name is not one of the valid options.