From 4d0015d92d88e6301d9e42de0d57830fb2822970 Mon Sep 17 00:00:00 2001 From: Hannah Klion Date: Wed, 29 Jan 2025 16:21:43 -0800 Subject: [PATCH] fix namespacing in documentation --- Docs/sphinx_doc/BoundaryConditions.rst | 10 +++++----- Docs/sphinx_doc/Checkpoint.rst | 2 +- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/Docs/sphinx_doc/BoundaryConditions.rst b/Docs/sphinx_doc/BoundaryConditions.rst index df40c121..fa96a74f 100644 --- a/Docs/sphinx_doc/BoundaryConditions.rst +++ b/Docs/sphinx_doc/BoundaryConditions.rst @@ -38,7 +38,7 @@ options for boundary conditions per side are listed below. Each of these types of physical boundary condition has a mapping to a mathematical boundary condition for each type; this is summarized in the table below, along with the corresponding ROMS boundary conditions. -If periodic is selected, it must be used for both low and high faces in a direction. The ``geometry.is_periodic`` +If periodic is selected, it must be used for both low and high faces in a direction. The ``remora.is_periodic`` flag must match as described in :ref:`ProblemGeometry``. For example, setting @@ -50,13 +50,13 @@ For example, setting remora.bc.ylo.type = "periodic" #optional remora.bc.yhi.type = "periodic" #optional - geometry.is_periodic = 0 1 0 + remora.is_periodic = 0 1 0 would define a problem with inflow in the low-\ :math:`x` direction, outflow in the high-\ :math:`x` direction, periodic in the :math:`y`-direction, and slip wall on the low and high :math:`y`-faces, and Note that no keyword is needed for a periodic boundary, here only the -specification in ``geometry.is_periodic`` is needed. +specification in ``remora.is_periodic`` is needed. Boundary per variable --------------------- @@ -106,7 +106,7 @@ For example, setting remora.bc.zeta.type = periodic chapman periodic chapman remora.bc.tke.type = periodic outflow periodic outflow - geometry.is_periodic = 1 0 0 + remora.is_periodic = 1 0 0 will define a problem that is periodic on the Western and Eastern sides. Temperature, salinity, passive scalar, 3D u-velocity, and 3D v-velocity will be clamped to values given in a NetCDF file specified by @@ -178,7 +178,7 @@ We note that ``noslipwall`` allows for non-zero tangential velocities to be spec :: - geometry.is_periodic = 1 0 0 + remora.is_periodic = 1 0 0 remora.bc.ylo.type = "NoSlipWall" remora.bc.yhi.type = "NoSlipWall" diff --git a/Docs/sphinx_doc/Checkpoint.rst b/Docs/sphinx_doc/Checkpoint.rst index a5e10f96..5d0994f3 100644 --- a/Docs/sphinx_doc/Checkpoint.rst +++ b/Docs/sphinx_doc/Checkpoint.rst @@ -71,5 +71,5 @@ Examples of Usage To restart from *chk_run00061*,for example, then set -- **amr.restart** = *chk_run00061* +- **remora.restart** = *chk_run00061*