use aborts, modify docs

Exawind · Jan 16, 2025 · d64f260 · d64f260
1 parent a0feb1e
commit d64f260
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 1 deletion.
diff --git a/amr-wind/ocean_waves/relaxation_zones/stokes_waves_ops.H b/amr-wind/ocean_waves/relaxation_zones/stokes_waves_ops.H
@@ -21,6 +21,12 @@ struct ReadInputsOp<StokesWaves>
         auto& info = data.info();
         relaxation_zones::read_inputs(wdata, info, pp);
 
+        if (wdata.current > constants::TIGHT_TOL) {
+            amrex::Abort(
+                "Current is specified as nonzero, but current is not yet "
+                "implemented for Stokes Waves.");
+        }
+
         // Get gravity from MultiPhase physics, assume negative z
         wdata.g = -data.sim().physics_manager().get<MultiPhase>().gravity()[2];
         // Get wave attributes

diff --git a/amr-wind/ocean_waves/relaxation_zones/waves2amr_ops.H b/amr-wind/ocean_waves/relaxation_zones/waves2amr_ops.H
@@ -209,6 +209,12 @@ struct ReadInputsOp<W2AWaves>
         auto& info = data.info();
         relaxation_zones::read_inputs(wdata, info, pp);
 
+        if (wdata.current > constants::TIGHT_TOL) {
+            amrex::Abort(
+                "Current is specified as nonzero, but current is not yet "
+                "implemented for W2A Waves.");
+        }
+
         pp.get("HOS_modes_filename", wdata.modes_file);
         pp.query("HOS_init_timestep", wdata.ntime);
         if (!pp.contains("HOS_init_timestep")) {

diff --git a/docs/sphinx/user/inputs_ocean_waves.rst b/docs/sphinx/user/inputs_ocean_waves.rst
@@ -95,7 +95,7 @@ This section is for setting up wave forcing and relaxation zones.
 
    Flow speed of a uniform current in the x-direction to be added to the wave forcing. This option is
    currently only compatible with the LinearWaves wave type and the numerical beach. If a nonzero current is
-   specified for a case with nonlinear waves and a numerical beach, nonphysical results will occur.
+   specified for a case with nonlinear waves, the code will abort.
 
 The following input arguments are only valid for the LinearWaves and StokesWave wave types: