Skip to content

Allow null halo periods for non-periodic halos. #143

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
romerojosh merged 1 commit into from
Jun 23, 2026
Merged

Allow null halo periods for non-periodic halos. #143

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 4 additions & 2 deletions include/cudecomp.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -598,7 +598,8 @@ cudecompResult_t cudecompUpdateHalosX(cudecompHandle_t handle, cudecompGridDesc_
* i-th global domain axis. Symmetric halos are assumed (e.g. a value of one in halo_extents means there are 2 halo
* elements, one element on each side)
* @param[in] halo_periods An array of three booleans to define halo periodicity of the input data, in global order.
* If the i-th entry in this array is true, the domain is treated periodically along the i-th global domain axis.
* If the i-th entry in this array is true, the domain is treated periodically along the i-th global domain axis. A NULL
* pointer can be provided if none of the domain axes are periodic.
* @param[in] dim Which pencil dimension (global indexed) to perform the halo update
* @param[in] padding An array of three integers to define padding of the input data, in global order. The i-th entry
* in this array should contain the number of elements to treat as padding in the i-th global domain axis. If the input
Expand All @@ -624,7 +625,8 @@ cudecompResult_t cudecompUpdateHalosY(cudecompHandle_t handle, cudecompGridDesc_
* i-th global domain axis. Symmetric halos are assumed (e.g. a value of one in halo_extents means there are 2 halo
* elements, one element on each side)
* @param[in] halo_periods An array of three booleans to define halo periodicity of the input data, in global order.
* If the i-th entry in this array is true, the domain is treated periodically along the i-th global domain axis.
* If the i-th entry in this array is true, the domain is treated periodically along the i-th global domain axis. A NULL
* pointer can be provided if none of the domain axes are periodic.
* @param[in] dim Which pencil dimension (global indexed) to perform the halo update
* @param[in] padding An array of three integers to define padding of the input data, in global order. The i-th entry
* in this array should contain the number of elements to treat as padding in the i-th global domain axis. If the input
Expand Down
3 changes: 0 additions & 3 deletions src/cudecomp.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1647,7 +1647,6 @@ cudecompResult_t cudecompUpdateHalosX(cudecompHandle_t handle, cudecompGridDesc_
// No halos, quick return.
return CUDECOMP_RESULT_SUCCESS;
}
if (!halo_periods) { THROW_INVALID_USAGE("halo_periods argument cannot be null"); }
if (!input) { THROW_INVALID_USAGE("input argument cannot be null"); }
if (!work) { THROW_INVALID_USAGE("work argument cannot be null"); }
if (dim < 0 || dim > 2) { THROW_INVALID_USAGE("dim argument out of range"); }
Expand Down Expand Up @@ -1690,7 +1689,6 @@ cudecompResult_t cudecompUpdateHalosY(cudecompHandle_t handle, cudecompGridDesc_
// No halos, quick return.
return CUDECOMP_RESULT_SUCCESS;
}
if (!halo_periods) { THROW_INVALID_USAGE("halo_periods argument cannot be null"); }
if (!input) { THROW_INVALID_USAGE("input argument cannot be null"); }
if (!work) { THROW_INVALID_USAGE("work argument cannot be null"); }
if (dim < 0 || dim > 2) { THROW_INVALID_USAGE("dim argument out of range"); }
Expand Down Expand Up @@ -1733,7 +1731,6 @@ cudecompResult_t cudecompUpdateHalosZ(cudecompHandle_t handle, cudecompGridDesc_
// No halos, quick return.
return CUDECOMP_RESULT_SUCCESS;
}
if (!halo_periods) { THROW_INVALID_USAGE("halo_periods argument cannot be null"); }
if (!input) { THROW_INVALID_USAGE("input argument cannot be null"); }
if (!work) { THROW_INVALID_USAGE("work argument cannot be null"); }
if (dim < 0 || dim > 2) { THROW_INVALID_USAGE("dim argument out of range"); }
Expand Down
3 changes: 0 additions & 3 deletions tests/ctest/api_tests.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1228,9 +1228,6 @@ TEST_F(ApiHaloTest, RejectsInvalidArguments) {
EXPECT_EQ(CUDECOMP_RESULT_INVALID_USAGE,
cudecompUpdateHalosX(handle_, grid_desc, valid_pointer, valid_pointer, CUDECOMP_FLOAT, nullptr,
kHaloPeriods.data(), 0, nullptr, 0));
EXPECT_EQ(CUDECOMP_RESULT_INVALID_USAGE,
cudecompUpdateHalosX(handle_, grid_desc, valid_pointer, valid_pointer, CUDECOMP_FLOAT, kHaloExtents.data(),
nullptr, 0, nullptr, 0));
EXPECT_EQ(CUDECOMP_RESULT_INVALID_USAGE,
cudecompUpdateHalosX(handle_, grid_desc, nullptr, valid_pointer, CUDECOMP_FLOAT, kHaloExtents.data(),
kHaloPeriods.data(), 0, nullptr, 0));
Expand Down
Loading