feat: new function to reset superdroplet radii in BCs

Author: yoctoyotta1024

cleo_1dkid/cleo_deps/libs/cartesiandomain/cartesianmaps.cpp

@@ -26,7 +26,7 @@
 KOKKOS_FUNCTION
 unsigned int get_no_decomposition_bounding_gridbox(const CartesianMaps &gbxmaps,
                                                    const unsigned int gbxindex, double &coord3,
-                                                   double &coord1, double &coord2);
+                                                   double &coord1, double &coord2, double &radius);
 
 /* on host, throws error if maps are not all
 the same size, else returns size of maps */
@@ -70,7 +70,8 @@ size_t CartesianMaps::local_to_global_gridbox_index(unsigned int local_gridbox_i
 // TODO(ALL) make domain_decomp call compatible with GPUs and then remove comm_size guard
 KOKKOS_FUNCTION
 unsigned int CartesianMaps::get_local_bounding_gridbox(const unsigned int gbxindex, double &coord3,
-                                                       double &coord1, double &coord2) const {
+                                                       double &coord1, double &coord2,
+                                                       double &radius) const {
   if (is_decomp) {
     auto coordinates = std::array<double, 3>{coord3, coord1, coord2};
     const auto idx = domain_decomposition.get_local_bounding_gridbox(coordinates);
@@ -79,7 +80,7 @@ unsigned int CartesianMaps::get_local_bounding_gridbox(const unsigned int gbxind
     coord2 = coordinates[2];
     return idx;
   }
-  return get_no_decomposition_bounding_gridbox(*this, gbxindex, coord3, coord1, coord2);
+  return get_no_decomposition_bounding_gridbox(*this, gbxindex, coord3, coord1, coord2, radius);
 }
 
 /* returns flag to keep idx the same (flag = 0) or
@@ -264,14 +265,17 @@ if flag = 2 idx updated to forwards neighbour gbxindex.
 _Note:_ backwards/forwards functions may change the
 superdroplet's coords e.g. if it leaves the domain. */
 KOKKOS_FUNCTION
-unsigned int change_if_coord3nghbr(const CartesianMaps &gbxmaps, unsigned int idx, double &coord3) {
+unsigned int change_if_coord3nghbr(const CartesianMaps &gbxmaps, unsigned int idx, double &coord3,
+                                    double &radius) {
   const auto flag = flag_sdgbxindex(idx, gbxmaps.coord3bounds(idx), coord3);  // !=0 idx shld change
   switch (flag) {
     case 1:
       idx = change_to_backwards_coord3nghbr(idx, gbxmaps, coord3);
+      radius = kid_reinitialise_radius(radius);
       break;
     case 2:
       idx = change_to_forwards_coord3nghbr(idx, gbxmaps, coord3);
+      radius = kid_reinitialise_radius(radius);
       break;
   }
   return idx;
@@ -280,8 +284,8 @@ unsigned int change_if_coord3nghbr(const CartesianMaps &gbxmaps, unsigned int id
 KOKKOS_FUNCTION
 unsigned int get_no_decomposition_bounding_gridbox(const CartesianMaps &gbxmaps,
                                                    const unsigned int gbxindex, double &coord3,
-                                                   double &coord1, double &coord2) {
-  auto idx = (unsigned int)change_if_coord3nghbr(gbxmaps, gbxindex, coord3);
+                                                   double &coord1, double &coord2, double &radius) {
+  auto idx = (unsigned int)change_if_coord3nghbr(gbxmaps, gbxindex, coord3, radius);
   idx = change_if_coord1nghbr(gbxmaps, idx, coord1);
   idx = change_if_coord2nghbr(gbxmaps, idx, coord2);
   return idx;

cleo_1dkid/cleo_deps/libs/cartesiandomain/cartesianmaps.hpp

@@ -35,6 +35,7 @@
 #include "../kokkosaliases.hpp"
 #include "cartesiandomain/cartesian_decomposition.hpp"
 #include "cartesiandomain/doubly_periodic_domain.hpp"
+#include "cartesiandomain/kid_reinit.hpp"
 
 namespace dlc = dimless_constants;
 
@@ -302,7 +303,7 @@ struct CartesianMaps {
    */
   KOKKOS_FUNCTION
   unsigned int get_local_bounding_gridbox(const unsigned int gbxindex, double& coord3,
-                                          double& coord1, double& coord2) const;
+                                          double& coord1, double& coord2, double& radius) const;
 };
 
 #endif  // CLEO_1DKID_CLEO_DEPS_LIBS_CARTESIANDOMAIN_CARTESIANMAPS_HPP_

cleo_1dkid/cleo_deps/libs/cartesiandomain/kid_reinit.hpp

@@ -0,0 +1,33 @@
+/*
+ * Copyright (c) 2025 MPI-M, Clara Bayley
+ *
+ *
+ * ----- CLEO_1dkid -----
+ * File: kid_reinit.hpp
+ * Project: cartesiandomain
+ * Created Date: Monday 14th July 2025
+ * Author: Clara Bayley (CB)
+ * Additional Contributors:
+ * -----
+ * Last Modified: Monday 14th July 2025
+ * Modified By: CB
+ * -----
+ * License: BSD 3-Clause "New" or "Revised" License
+ * https://opensource.org/licenses/BSD-3-Clause
+ * -----
+ * File Description:
+ * Definition of the boundary condition for the KiD 1-D test case where superdroplets that leave the
+ * top of the domain are reinitialised with their dry radius.
+ */
+
+#ifndef CLEO_1DKID_CLEO_DEPS_LIBS_CARTESIANDOMAIN_KID_REINIT_HPP_
+#define CLEO_1DKID_CLEO_DEPS_LIBS_CARTESIANDOMAIN_KID_REINIT_HPP_
+
+#include <Kokkos_Core.hpp>
+
+/* combiined with change_radius function this will set a superdroplet's radius to its dry radius */
+double kid_reinitialise_radius(const double radius) {
+  return 0.0;
+}
+
+#endif  // CLEO_1DKID_CLEO_DEPS_LIBS_CARTESIANDOMAIN_KID_REINIT_HPP_

cleo_1dkid/cleo_deps/libs/gridboxes/gridboxmaps.hpp

@@ -53,7 +53,7 @@ concept GridboxMaps = requires(GbxMaps gbxmaps, unsigned int idx, size_t s, doub
 
   { gbxmaps.global_to_local_gbxindex(s) } -> std::convertible_to<unsigned int>;
   { gbxmaps.local_to_global_gridbox_index(idx) } -> std::convertible_to<size_t>;
-  { gbxmaps.get_local_bounding_gridbox(idx, d, d, d) } -> std::convertible_to<unsigned int>;
+  { gbxmaps.get_local_bounding_gridbox(idx, d, d, d, d) } -> std::convertible_to<unsigned int>;
 };
 
 #endif  // CLEO_1DKID_CLEO_DEPS_LIBS_GRIDBOXES_GRIDBOXMAPS_HPP_

cleo_1dkid/cleo_deps/libs/gridboxes/predcorrmotion.hpp

@@ -91,12 +91,14 @@ struct PredCorrMotion {
     auto coord3 = drop.get_coord3();
     auto coord1 = drop.get_coord1();
     auto coord2 = drop.get_coord2();
-    const auto idx = gbxmaps.get_local_bounding_gridbox(gbxindex, coord3, coord1,
-                                                        coord2);  // drop_coords may change(!)
+    auto radius = drop.get_radius();
+    // (!) drop_coords and radius may change inside get_local_bounding_gridbox (!)
+    const auto idx = gbxmaps.get_local_bounding_gridbox(gbxindex, coord3, coord1, coord2, radius);
 
     // Sets the updated superdroplet coordinates and gridbox index
     drop.set_coords(coord3, coord1, coord2);
     drop.set_sdgbxindex(idx);
+    drop.change_radius(radius);
 
     // If the index is non-local return
     // For superdrops going to other processes checks will be perfomed in the receiver