Skip to content

Fix inactive layer guard in gradient Richardson number computation #518

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sbrus89 merged 2 commits into from
Aug 25, 2026
Merged

Fix inactive layer guard in gradient Richardson number computation #518

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
777c7e5
Fix inactive layer guard in gradient Richardson number computation
mwarusz Aug 17, 2026
edf086a
Update vertical mixing test after Richardson number fix
mwarusz Aug 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion components/omega/src/ocn/VertMix.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ class GradRichardsonNum {

// Skip this edge contribution if it would access
// invalid edge velocity levels.
if (K1 > MaxLayerEdgeBot(JEdge) || K2 > MaxLayerEdgeBot(JEdge))
if (K > MaxLayerEdgeTop(JEdge))
continue;

Real DNormVel =
Expand Down
100 changes: 54 additions & 46 deletions components/omega/test/ocn/VertMixTest.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
#include "Decomp.h"
#include "Dimension.h"
#include "Field.h"
#include "FillValues.h"
#include "HorzMesh.h"
#include "IO.h"
#include "IOStream.h"
Expand Down Expand Up @@ -142,21 +143,12 @@ void testGradRichNum() {
/// Use deep copy to initialize results
deepCopy(NormalVelEdge, NV);
deepCopy(TangVelEdge, TV);
deepCopy(BruntVaisalaFreqSqCell, BVFP);
deepCopy(TestVertMix->GradRichNum, 0.0);

parallelFor(
"populateArrays", {Mesh->NCellsAll, NVertLayers},
KOKKOS_LAMBDA(I4 ICell, I4 K) {
GeomZMid(ICell, K) = -K;
NEdgesOnCell(ICell) = 5;
AreaCell(ICell) = 3.6e10_Real;
});

// Also test guard is working for skipping layer edge contribution
// if it would access invalid edge velocity levels
parallelFor(
"setMinMax", {Mesh->NCellsAll}, KOKKOS_LAMBDA(I4 ICell) {
"setMinMax", {Mesh->NCellsOwned}, KOKKOS_LAMBDA(I4 ICell) {
MinLayerCell(ICell) = 0;
if (ICell % 2 == 0) {
MaxLayerCell(ICell) = 10;
Expand All @@ -165,37 +157,62 @@ void testGradRichNum() {
}
});

// Need to exchange halo after changing MaxLayerCell
MeshHalo->exchangeFullArrayHalo(MaxLayerCell, OnCell);

// Refresh edge layer ranges after overriding MaxLayerCell.
VCoord->minMaxLayerEdge(MeshHalo);

parallelForOuter(
"populateArrays", {Mesh->NCellsAll},
KOKKOS_LAMBDA(I4 ICell, const TeamMember &Team) {
AreaCell(ICell) = 3.6e10_Real;

// Set inactive layers to fill value to cause failure if used
parallelForInner(
Team, NVertLayers, INNER_LAMBDA(I4 K) {
if (K > MaxLayerCell(ICell)) {
GeomZMid(ICell, K) = FillValueReal;
} else {
GeomZMid(ICell, K) = -K;
}
});

// Set inactive layers to fill value to cause failure if used
parallelForInner(
Team, NVertLayersP1, INNER_LAMBDA(I4 K) {
if (K > MaxLayerCell(ICell) + 1) {
BruntVaisalaFreqSqCell(ICell, K) = FillValueReal;
} else {
BruntVaisalaFreqSqCell(ICell, K) = BVFP;
}
});
});

// Rebind GradRichardsonNum so the functor captures refreshed edge ranges.
TestVertMix->ComputeGradRichardsonNum = GradRichardsonNum(Mesh, VCoord);

// Recapture after minMaxLayerEdge since it reallocates edge layer views.
OMEGA_SCOPE(MaxLayerEdgeBot, VCoord->MaxLayerEdgeBot);

// filling CellsOnCell with simple mapping for this test
parallelFor(
"populateArrays", {Mesh->NCellsAll}, KOKKOS_LAMBDA(I4 ICell) {
CellsOnCell(ICell, 0) = ICell;
CellsOnCell(ICell, 1) = ICell;
CellsOnCell(ICell, 2) = ICell;
CellsOnCell(ICell, 3) = ICell;
CellsOnCell(ICell, 4) = ICell;
});
OMEGA_SCOPE(MaxLayerEdgeTop, VCoord->MaxLayerEdgeTop);

parallelFor(
"populateArrays", {NEdgesAll, NVertLayers},
KOKKOS_LAMBDA(I4 IEdge, I4 K) {
if (K > MaxLayerEdgeBot(IEdge)) {
NormalVelEdge(IEdge, K) =
Comment thread
mwarusz marked this conversation as resolved.
-9.99e30; // Fill value to cause failure if used
TangVelEdge(IEdge, K) =
-9.99e30; // Fill value to cause failure if used
FillValueReal; // Fill value to cause failure if used
} else {
NormalVelEdge(IEdge, K) = NormalVelEdge(IEdge, K) + 0.5 * K;
TangVelEdge(IEdge, K) = TangVelEdge(IEdge, K) + 0.5 * K;
}

if (K > MaxLayerEdgeTop(IEdge)) {
TangVelEdge(IEdge, K) =
FillValueReal; // Fill value to cause failure if used
} else {
TangVelEdge(IEdge, K) = TangVelEdge(IEdge, K) + 0.5 * K;
}

DcEdge(IEdge) = 2.0e5_Real;
DvEdge(IEdge) = 1.45e5_Real;
});
Expand Down Expand Up @@ -233,8 +250,8 @@ void testGradRichNum() {
bool HasValidEdge = false;
for (int J = 0; J < NEdgesOnCell(ICell); ++J) {
const I4 JEdge = EdgesOnCell(ICell, J);
if (K1 <= MaxLayerEdgeBot(JEdge) &&
K2 <= MaxLayerEdgeBot(JEdge)) {
if (K1 <= MaxLayerEdgeTop(JEdge) &&
K2 <= MaxLayerEdgeTop(JEdge)) {
HasValidEdge = true;
break;
}
Expand Down Expand Up @@ -265,6 +282,15 @@ void testGradRichNum() {
LOG_INFO("TestVertMix: GradRichNum PASS");
}

// Reset MaxLayerCell to the original values
parallelFor(
"resetMinMax", {Mesh->NCellsAll}, KOKKOS_LAMBDA(I4 ICell) {
MinLayerCell(ICell) = 0;
MaxLayerCell(ICell) = NVertLayers - 1;
});
// Refresh edge layer ranges after overriding MaxLayerCell.
VCoord->minMaxLayerEdge(MeshHalo);

return;
}

Expand Down Expand Up @@ -302,12 +328,6 @@ void testOneTwoOneFilter() {
}
});

parallelFor(
"setMinMax", {Mesh->NCellsAll}, KOKKOS_LAMBDA(I4 ICell) {
MinLayerCell(ICell) = 0;
MaxLayerCell(ICell) = NVertLayers - 1;
});

// Apply the 1-2-1 filter to each cell
OMEGA_SCOPE(ComputeOneTwoOneFilter, TestVertMix->ComputeOneTwoOneFilter);
parallelFor(
Expand Down Expand Up @@ -803,20 +823,8 @@ void testTotalVertMix() {
parallelFor(
"populateArrays", {Mesh->NCellsAll, NVertLayers},
KOKKOS_LAMBDA(I4 ICell, I4 K) {
GeomZMid(ICell, K) = -K;
NEdgesOnCell(ICell) = 5;
AreaCell(ICell) = 3.6e10_Real;
});

// current mesh has some CellsOnCell value > NCellsAll, so
// filling CellsOnCell with simple mapping for this test
parallelFor(
"populateArrays", {Mesh->NCellsAll}, KOKKOS_LAMBDA(I4 ICell) {
CellsOnCell(ICell, 0) = ICell;
CellsOnCell(ICell, 1) = ICell;
CellsOnCell(ICell, 2) = ICell;
CellsOnCell(ICell, 3) = ICell;
CellsOnCell(ICell, 4) = ICell;
GeomZMid(ICell, K) = -K;
AreaCell(ICell) = 3.6e10_Real;
});

parallelFor(
Expand Down
Loading