Skip to content

Halo add pb test for halo exchange #1044

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

Draft
TomMelt wants to merge 2 commits into
base: develop
Choose a base branch
from
Draft

Halo add pb test for halo exchange #1044

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
5e05a5e
Revert "tests: remove Halo PB test for now"
TomMelt Feb 16, 2026
3c15ba9
[skip ci] wip: implementing PB test for halo
TomMelt Feb 16, 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
19 changes: 19 additions & 0 deletions core/test/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -348,6 +348,24 @@ if(ENABLE_MPI)
)
target_link_libraries(testHaloExchangeCB_MPI3 PRIVATE nextsimlib doctest::doctest)

add_executable(testHaloExchangePB_MPI3
"HaloExchangePB_test.cpp"
"MainMPI.cpp"
"../src/ModelArray.cpp"
"../src/ModelArraySlice.cpp"
)
target_compile_definitions(testHaloExchangePB_MPI3 PRIVATE USE_MPI
TEST_FILES_DIR=\"${CMAKE_CURRENT_BINARY_DIR}\")
target_include_directories(
testHaloExchangePB_MPI3 PRIVATE
${MODEL_INCLUDE_DIR}
"${ModulesRoot}/StructureModule"
"../src"
"../../dynamics/src"
"../../dynamics/src/include"
)
target_link_libraries(testHaloExchangePB_MPI3 PRIVATE nextsimlib doctest::doctest)

add_executable(testParaGrid_MPI2 "ParaGrid_test.cpp" "MainMPI.cpp")
target_compile_definitions(
testParaGrid_MPI2
Expand Down Expand Up @@ -417,6 +435,7 @@ if(ENABLE_MPI)

set(MPI_TESTS
testHaloExchangeCB_MPI3
testHaloExchangePB_MPI3
testParaGrid_MPI2
testRectGrid_MPI3
testModelMetadataCB_MPI3
Expand Down
292 changes: 292 additions & 0 deletions core/test/HaloExchangePB_test.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,292 @@
/*!
* @author Tom Meltzer <tdm39@cam.ac.uk>
* @brief Test halo exchange class for Periodic Boundaries (PB)
* @details
*
* Test halo exchange class for Periodic Boundaries (PB) on following fields:
* - HField
* - VertexField
* - DGField
* - DGVector
*/

#include <doctest/extensions/doctest_mpi.h>
#include <iostream>
#include <ostream>

#include "ModelMPI.hpp"
#include "ModelMetadata.hpp"
#include "cgVector.hpp"
#include "include/DGModelArray.hpp"
#include "include/Halo.hpp"
#include "include/Interpolations.hpp"

namespace Nextsim {

const std::string testFilesDir = TEST_FILES_DIR;
const std::string file = testFilesDir + "/halo_pb_test_partition_metadata_3.nc";

static const int DG = 3;
static const int CGDEGREE = 2;
static const bool debug = false;

int mod(int a, int n) { return ((a % n) + n) % n; }

template <typename T>
void initializeTestData(
T& data, size_t localNx, size_t localNy, size_t offsetX, size_t offsetY, bool isCG = false)
{
size_t nCells = 1;
if (isCG) {
nCells = CGDEGREE;
}

const auto numComps = data.cols();

// initialize only inner block of data (to mimic behaviour of Halo::setInnerBlock())
for (size_t j = nCells; j < localNy - nCells; ++j) {
for (size_t i = nCells; i < localNx - nCells; ++i) {
for (size_t d = 0; d < numComps; ++d) {
data(d + i * numComps + j * localNx * numComps)
= (d + 1) * 100 + (i - nCells + offsetX) * 10 + (j - nCells + offsetY);
}
}
}
}

template <typename T>
void verifyTestData(T& data, size_t localNx, size_t localNy, size_t offsetX, size_t offsetY,
size_t nx, size_t ny, bool isCG = false)
{
size_t nCells = 1;
if (isCG) {
nCells = CGDEGREE;
}

const auto numComps = data.cols();
auto globalNx = nx + 2 * Halo::haloWidth * nCells - nCells;
auto globalNy = ny + 2 * Halo::haloWidth * nCells - nCells;

// if (data.getType() == ModelArray::Type::VERTEX)
// if(type(data) == type(VertexField())) {
// globalNx = globalNx + 1;
// globalNy = globalNy + 1;
// }

// Verify the test data
for (size_t j = 0; j < localNy; j++) {
for (size_t i = 0; i < localNx; i++) {
for (size_t d = 0; d < numComps; d++) {
int globalI = i + offsetX;
int globalJ = j + offsetY;

// handle Periodic Boundaries
if (globalI < nCells) {
globalI = globalNx - globalI - nCells;
}
if (globalI >= globalNx) {
globalI = globalNx - globalI + nCells;
}
if (globalJ < nCells) {
globalJ = globalNy - globalJ - nCells;
}
if (globalJ >= globalNy) {
globalJ = globalNy - globalJ + nCells;
}

double expectedValue = (d + 1) * 100 + (globalI - nCells) * 10 + (globalJ - nCells);
double actualValue = data(d + i * numComps + j * localNx * numComps);

std::cout << "actualValue = " << actualValue
<< " :: expectedValue = " << expectedValue << std::endl;
std::cout << "global (I,J) :: (" << i + offsetX << "," << j + offsetY << ") -> ("
<< globalI << "," << globalJ << ")" << std::endl;
REQUIRE(actualValue == expectedValue);
}
}
}
}

TEST_SUITE_BEGIN("Halo exchange tests");
MPI_TEST_CASE("test halo exchange on 3 proc grid", 3)
{
// test for a 3 proc grid
// ┌─┬─┐
// │1│ │
// ├─┤2│
// │0│ │
// └─┴─┘ (proc id)

auto& modelMPI = ModelMPI::getInstance(test_comm);
auto& metadata = ModelMetadata::getInstance(file);

const size_t nx = metadata.getGlobalExtentX();
const size_t ny = metadata.getGlobalExtentY();
const size_t localNx = metadata.getLocalExtentX() + 2 * Halo::haloWidth;
const size_t localNy = metadata.getLocalExtentY() + 2 * Halo::haloWidth;
const size_t offsetX = metadata.getLocalCornerX();
const size_t offsetY = metadata.getLocalCornerY();

ModelArray::setDimension(ModelArray::Dimension::X, nx, localNx, offsetX);
ModelArray::setDimension(ModelArray::Dimension::Y, ny, localNy, offsetY);
ModelArray::setDimension(ModelArray::Dimension::XVERTEX, nx + 1, localNx + 1, offsetX);
ModelArray::setDimension(ModelArray::Dimension::YVERTEX, ny + 1, localNy + 1, offsetY);

// create example 2D field on each process
auto testData = ModelArray::HField();
testData.resize();
testData = 0.;

// create halo for testData model array
Halo halo(testData);

initializeTestData(testData.getDataRef(), localNx, localNy, offsetX, offsetY);

// exchange halos
halo.exchangeHalos(testData.getDataRef());

// Verify the test data after halo exchange
verifyTestData(testData.getDataRef(), localNx, localNy, offsetX, offsetY, nx, ny);

VertexField coordinates = ModelArray::VertexField();
coordinates.resize();
coordinates = 0.;

Halo haloVertex(coordinates);

initializeTestData(coordinates.getDataRef(), localNx + 1, localNy + 1, offsetX, offsetY);

haloVertex.exchangeHalos(coordinates.getDataRef());

verifyTestData(
coordinates.getDataRef(), localNx + 1, localNy + 1, offsetX, offsetY, nx + 1, ny + 1);
}

// MPI_TEST_CASE("DGField", 3)
// {
// auto& modelMPI = ModelMPI::getInstance();
// auto& metadata = ModelMetadata::getInstance();

// const size_t nx = metadata.getGlobalExtentX();
// const size_t ny = metadata.getGlobalExtentY();
// const size_t localNx = metadata.getLocalExtentX() + 2 * Halo::haloWidth;
// const size_t localNy = metadata.getLocalExtentY() + 2 * Halo::haloWidth;
// const size_t offsetX = metadata.getLocalCornerX();
// const size_t offsetY = metadata.getLocalCornerY();

// ModelArray::setDimension(ModelArray::Dimension::X, nx, localNx, offsetX);
// ModelArray::setDimension(ModelArray::Dimension::Y, ny, localNy, offsetY);
// ModelArray::setNComponents(ModelArray::Type::DG, DG);

// // create example 2D field on each process
// auto testData = ModelArray::DGField();
// testData.resize();
// testData = 0.;

// // create halo for testData model array
// Halo halo(testData);

// initializeTestData(testData.getDataRef(), localNx, localNy, offsetX, offsetY);

// // exchange halos
// halo.exchangeHalos(testData.getDataRef());

// verifyTestData(testData.getDataRef(), localNx, localNy, offsetX, offsetY, nx, ny);
// }

// MPI_TEST_CASE("DGVector", 3)
// {
// auto& modelMPI = ModelMPI::getInstance();
// auto& metadata = ModelMetadata::getInstance();

// const size_t nx = metadata.getGlobalExtentX();
// const size_t ny = metadata.getGlobalExtentY();
// const size_t localNx = metadata.getLocalExtentX() + 2 * Halo::haloWidth;
// const size_t localNy = metadata.getLocalExtentY() + 2 * Halo::haloWidth;
// const size_t offsetX = metadata.getLocalCornerX();
// const size_t offsetY = metadata.getLocalCornerY();

// ModelArray::setDimension(ModelArray::Dimension::X, nx, localNx, offsetX);
// ModelArray::setDimension(ModelArray::Dimension::Y, ny, localNy, offsetY);
// ModelArray::setNComponents(ModelArray::Type::DG, DG);

// ParametricMesh smesh(CARTESIAN);
// smesh.nx = localNx;
// smesh.ny = localNy;
// smesh.nelements = localNx * localNy;
// smesh.nnodes = (localNx + 1) * (localNy + 1);
// smesh.vertices.resize(smesh.nnodes, Eigen::NoChange);
// for (size_t i = 0; i < localNx + 1; ++i) {
// for (size_t j = 0; j < localNy + 1; ++j) {
// smesh.vertices(i * (localNy + 1) + j, 0) = i;
// smesh.vertices(i * (localNy + 1) + j, 1) = j;
// }
// }

// // create example DGVector
// DGVector<DG> testData(smesh);
// testData.zero();

// // create halo for testData model array
// Halo halo(testData);

// initializeTestData(testData, localNx, localNy, offsetX, offsetY);

// // exchange halos
// halo.exchangeHalos(testData);

// verifyTestData(testData, localNx, localNy, offsetX, offsetY, nx, ny);
// }

// MPI_TEST_CASE("CGVector", 3)
// {
// auto& modelMPI = ModelMPI::getInstance();
// auto& metadata = ModelMetadata::getInstance();

// const size_t nx = metadata.getGlobalExtentX();
// const size_t ny = metadata.getGlobalExtentY();
// const size_t localNx = metadata.getLocalExtentX() + 2 * Halo::haloWidth;
// const size_t localNy = metadata.getLocalExtentY() + 2 * Halo::haloWidth;
// const size_t offsetX = metadata.getLocalCornerX();
// const size_t offsetY = metadata.getLocalCornerY();

// ModelArray::setDimension(ModelArray::Dimension::X, nx, localNx, offsetX);
// ModelArray::setDimension(ModelArray::Dimension::Y, ny, localNy, offsetY);
// ModelArray::setNComponents(ModelArray::Type::DG, DG);

// ParametricMesh smesh(CARTESIAN);
// smesh.nx = localNx;
// smesh.ny = localNy;
// smesh.nelements = localNx * localNy;
// smesh.nnodes = (localNx + 1) * (localNy + 1);
// smesh.vertices.resize(smesh.nnodes, Eigen::NoChange);
// for (size_t i = 0; i < localNx + 1; ++i) {
// for (size_t j = 0; j < localNy + 1; ++j) {
// smesh.vertices(i * (localNy + 1) + j, 0) = i;
// smesh.vertices(i * (localNy + 1) + j, 1) = j;
// }
// }

// auto CGNx = nx * CGDEGREE + 1;
// auto CGNy = ny * CGDEGREE + 1;
// auto CGLocalNx = localNx * CGDEGREE + 1;
// auto CGLocalNy = localNy * CGDEGREE + 1;
// auto CGoffsetX = offsetX * CGDEGREE;
// auto CGoffsetY = offsetY * CGDEGREE;
// bool isCG = true;

// // create CGVector
// CGVector<CGDEGREE> cgVector;
// cgVector.resize_by_mesh(smesh);
// cgVector.zero();

// // initialize data
// initializeTestData(cgVector, CGLocalNx, CGLocalNy, CGoffsetX, CGoffsetY, isCG);

// // create halo for testData model array
// Halo halo(cgVector);
// halo.exchangeHalos(cgVector);

// verifyTestData(cgVector, CGLocalNx, CGLocalNy, CGoffsetX, CGoffsetY, CGNx, CGNy, isCG);
// }
}