removed configure_box

hannorein · hannorein · commit 37ba7deaeb52 · 2026-03-29T01:21:02.000Z
diff --git a/docs/boundaryconditions.md b/docs/boundaryconditions.md
@@ -27,14 +27,14 @@ The syntax is as follows:
 === "C"
     ```c
     struct reb_simulation* r = reb_simulation_create();
-    reb_simulation_configure_box(r, 10., 1, 1, 1); # confine the simulation to a box of size 10
+    r->root_size = 10.0 # confine the simulation to a box of size 10
     r->boundary = REB_BOUNDARY_OPEN;
     ```
 
 === "Python"
     ```python
     sim = rebound.Simulation()
-    sim.configure_box(10.)   # confine the simulation to a box of size 10
+    sim.root_size = 10.0   # confine the simulation to a box of size 10
     sim.boundary = "open"
     ```
 
@@ -46,14 +46,20 @@ The syntax is as follows:
 === "C"
     ```c
     struct reb_simulation* r = reb_simulation_create();
-    reb_simulation_configure_box(r, 10., 1, 2, 3); # confine the simulation to a box of size 10x20x30
+    r->root_size = 10.0
+    r->N_root_x = 1  // 1 is the default
+    r->N_root_y = 2
+    r->N_root_z = 3  // confine the simulation to a box of size 10x20x30
     r->boundary = reb_boundary_periodic;
     ```
 
 === "python"
     ```python
     sim = rebound.simulation()
-    sim.configure_box(10., 1, 2, 3)   # confine the simulation to a box of size 10x20x30
+    sim.root_size = 10.0
+    sim.N_root_x = 1  # 1 is the default
+    sim.N_root_y = 2
+    sim.N_root_z = 3  # confine the simulation to a box of size 10x20x30
     sim.boundary = "periodic"
     ```
 
@@ -94,15 +100,15 @@ For more information on how to setup simulations of planetary rings in REBOUND,
 === "C"
     ```c
     struct reb_simulation* r = reb_simulation_create();
-    reb_simulation_configure_box(r, 10., 1, 1, 1); 
+    r->root_size = 10.0
     r->OMEGA = 1.0;
     r->boundary = REB_BOUNDARY_SHEAR;
     ```
 
 === "Python"
     ```python
     sim = rebound.Simulation()
-    sim.configure_box(10.)
+    sim.root_size = 10.0
     sim.OMEGA = 1.0
     sim.boundary = "shear"
     ```
diff --git a/docs/collisions.md b/docs/collisions.md
@@ -69,14 +69,14 @@ Below is an example on how to enable the tree based collision search.
 === "C"
     ```c
     struct reb_simulation* r = reb_simulation_create();
-    reb_simulation_configure_box(r, 10, 1, 1, 1); # confine the simulation to a box of size 10
+    r->root_size = 10.0; // confine the simulation to a box of size 10
     r->collision = REB_COLLISION_TREE;
     ```
 
 === "Python"
     ```python
     sim = rebound.Simulation()
-    sim.configure_box(10)   # confine the simulation to a box of size 10
+    sim.root_size = 10.0 # confine the simulation to a box of size 10
     sim.collision = "tree"
     ```
 
@@ -92,14 +92,14 @@ Below is an example on how to enable the line-tree collision search.
 === "C"
     ```c
     struct reb_simulation* r = reb_simulation_create();
-    reb_simulation_configure_box(r, 10, 1, 1, 1); # confine the simulation to a box of size 10
+    r->root_size = 10.0; // confine the simulation to a box of size 10
     r->collision = REB_COLLISION_LINETREE;
     ```
 
 === "Python"
     ```python
     sim = rebound.Simulation()
-    sim.configure_box(10)   # confine the simulation to a box of size 10
+    sim.root_size = 10.0   # confine the simulation to a box of size 10
     sim.collision = "linetree"
     ```
 
diff --git a/docs/mpi.md b/docs/mpi.md
@@ -31,7 +31,9 @@ struct reb_simulation* r = reb_simulation_create();
 r->gravity          = REB_GRAVITY_TREE;
 r->collision        = REB_COLLISION_TREE;
 // other configuration options
-reb_simulation_configure_box(r, boxsize, 2, 2, 1);
+r->root_size = boxsize;
+r->N_root_x = 2;
+r->N_root_y = 2;
 ```    
 
 The number of root trees needs to be an integer multiple of the number of MPI processes.
diff --git a/docs/simulation.md b/docs/simulation.md
@@ -42,25 +42,3 @@ It's the one structure you will work with most when using REBOUND.
         sim = None           # free simulation
         print(sim.particles) # segmentation fault
         ```
-
-There are several instances where you need to initialize a simulation's root boxes:
-
-- If you use a tree code for collision detection or for calculating gravity.
-- If you want to use open, periodic or shear-periodic boundary conditions.
-
-Initializing root boxes is done after the simulation is created:
-=== "C"
-    ```c
-    struct reb_simulation* r = reb_simulation_create();
-    double size = 100.;
-    reb_simulation_configure_box(r, size, 1, 2, 3);
-    ```
-=== "Python"
-    ```python
-    sim = rebound.Simulation()
-    size = 100.
-    sim.configure_box(size, 1, 2, 3);
-    ```
-In the above example, there is one root box in the x direction, there are two in the y direction, and three in the z direction. 
-In most cases you want exactly one root box in each direction.
-
diff --git a/examples/animation_saturns_rings/problem.c b/examples/animation_saturns_rings/problem.c
@@ -50,8 +50,10 @@ int main(int argc, char* argv[]) {
     r->G                 = 6.67428e-11;         // N / (1e-5 kg)^2 m^2
     r->softening         = 0.1;                 // m
     r->dt                = 1e-3*2.*M_PI/r->ri_sei.OMEGA;  // s
-    
-    reb_simulation_configure_box(r, 100, 2, 2, 1); // 100m box
+   
+    r->root_size = 100.0;
+    r->N_root_x = 2; 
+    r->N_root_y = 2; 
     r->N_ghost_x = 2; r->N_ghost_y = 2; r->N_ghost_z = 0;
     
     // Add all ring particles
diff --git a/examples/bouncing_balls/problem.c b/examples/bouncing_balls/problem.c
@@ -24,7 +24,7 @@ int main(int argc, char* argv[]){
     r->usleep    = 1000;            // Slow down integration (for visualization only)
     r->dt = 1e-2;
 
-    reb_simulation_configure_box(r, 3.0, 1, 1, 1);
+    r->root_size = 3;
     
     // Initial conditions
     {
diff --git a/examples/bouncing_balls_corners/problem.c b/examples/bouncing_balls_corners/problem.c
@@ -26,7 +26,7 @@ int main(int argc, char* argv[]){
     r->dt          = 1e-3;
     r->boundary    = REB_BOUNDARY_PERIODIC;
     r->usleep     = 1000;            // Slow down integration (for visualization only)
-    reb_simulation_configure_box(r,3.,1,1,1);
+    r->root_size = 3; 
     
     // Initial conditions
     int problem_id = 1;
diff --git a/examples/bouncing_string/problem.c b/examples/bouncing_string/problem.c
@@ -26,7 +26,10 @@ int main(int argc, char* argv[]){
     r->gravity           = REB_GRAVITY_NONE;
     r->usleep            = 5000;      // Slow down integration (for visualization only)
     
-    reb_simulation_configure_box(r,10.,3,1,1);  // boxsize 10., three root boxes in x direction, one in y and z
+    // boxsize 10., three root boxes in x direction, one in y and z
+    r->root_size = 10.0;
+    r->N_root_x = 2; 
+
     r->N_ghost_x = 1; 
     r->N_ghost_y = 1; 
     r->N_ghost_z = 0;
diff --git a/examples/granulardynamics/problem.c b/examples/granulardynamics/problem.c
@@ -32,7 +32,8 @@ int main(int argc, char* argv[]){
     // Override default collision handling to account for border particles
     r->collision_resolve = collision_resolve_hardsphere_withborder;
     r->heartbeat         = heartbeat;
-    reb_simulation_configure_box(r, 20., 1, 1, 4);
+    r->root_size = 20.0;
+    r->N_root_z = 4;
     
     r->N_ghost_x = 1; r->N_ghost_y = 1; r->N_ghost_z = 0;     
     struct reb_vec3d boxsize = {
diff --git a/examples/mpi_unittests/problem.c b/examples/mpi_unittests/problem.c
@@ -32,7 +32,9 @@ void test_twobody(){
     r->opening_angle2   = 1.5; 
     r->G                = 1;        
     r->dt               = 0.1;
-    reb_simulation_configure_box(r,30,2,2,1);
+    r->root_size = 30; 
+    r->N_root_x = 2; 
+    r->N_root_y = 2; 
 
     printf("MPI init...\n");
     reb_mpi_init(r);
diff --git a/examples/openmp/problem.c b/examples/openmp/problem.c
@@ -37,7 +37,8 @@ void run_sim(){
     r->softening     = 0.02;        // Gravitational softening length
     r->dt         = 3e-2;        // Timestep
     const double boxsize = 10.2;
-    reb_simulation_configure_box(r,boxsize,1,1,1);
+    r->root_size = boxsize; 
+
 
     // Setup particles
     double disc_mass = 2e-1;    // Total disc mass
diff --git a/examples/overstability/problem.c b/examples/overstability/problem.c
@@ -43,7 +43,8 @@ int main(int argc, char* argv[]){
     r->gravity              = REB_GRAVITY_NONE;
     r->boundary             = REB_BOUNDARY_SHEAR;
 
-    reb_simulation_configure_box(r,1.,200,5,20);
+    r->root_size = 1;
+    r->N_root_x = 200;    r->N_root_y = 5;      r->N_root_z = 20;
     r->N_ghost_x = 1;     r->N_ghost_y = 1;     r->N_ghost_z = 0;
 
     // Initial conditions
diff --git a/examples/planetesimal_disk_migration/problem.c b/examples/planetesimal_disk_migration/problem.c
@@ -48,7 +48,9 @@ int main(int argc, char* argv[]){
     // Boundaries
     r->boundary = REB_BOUNDARY_OPEN;
     const double boxsize = 6;
-    reb_simulation_configure_box(r,boxsize,2,2,1);
+    r->root_size = boxsize;
+    r->N_root_x = 2;
+    r->N_root_y = 2;
     
     srand(12);
     double m_earth = 3.003e-6;
diff --git a/examples/profiling/problem.c b/examples/profiling/problem.c
@@ -44,7 +44,9 @@ int main(int argc, char* argv[]) {
     if (argc > 1) {       // Try to read root_size from command line
         root_size = atof(argv[1]);
     }
-    reb_simulation_configure_box(r, root_size, 2, 2, 1);
+    r->root_size = root_size;
+    r->N_root_x = 2;
+    r->N_root_y = 2;
     r->N_ghost_x = 2;
     r->N_ghost_y = 2;
     r->N_ghost_z = 0;
diff --git a/examples/restarting_simulation/problem.c b/examples/restarting_simulation/problem.c
@@ -24,7 +24,7 @@ int main(int argc, char* argv[]){
         r->dt         = 1e-4*2.*M_PI; 
         r->exact_finish_time = 1; // Finish exactly at tmax in reb_simulation_integrate(). Default is already 1.
         r->N_ghost_x = 1; r->N_ghost_y = 1; r->N_ghost_z = 0;
-        reb_simulation_configure_box(r,2.,1,1,1);
+        r->root_size = 2;
 
         while (r->N<50){
             struct reb_particle p = {0};
diff --git a/examples/restricted_threebody/problem.c b/examples/restricted_threebody/problem.c
@@ -30,7 +30,7 @@ int main(int argc, char* argv[]){
     r->N_active     = 2;    // Only the star and the planet have non-zero mass
     r->heartbeat    = heartbeat;
 
-    reb_simulation_configure_box(r,8.,1,1,1); // Box with size 8 AU
+    r->root_size = 8.;  // Box with size 8 AU
     
     // Initial conditions for star
     struct reb_particle star = {0};
diff --git a/examples/selfgravity_disc/problem.c b/examples/selfgravity_disc/problem.c
@@ -30,7 +30,7 @@ int main(int argc, char* argv[]){
     r->softening        = 0.02;         // Gravitational softening length
     r->dt               = 3e-2;         // Timestep
     const double boxsize = 10.2;
-    reb_simulation_configure_box(r,boxsize,1,1,1);
+    r->root_size = boxsize;
 
     // Setup particles
     double disc_mass = 2e-1;    // Total disc mass
diff --git a/examples/selfgravity_disc_mpi/problem.c b/examples/selfgravity_disc_mpi/problem.c
@@ -36,10 +36,11 @@ int main(int argc, char* argv[]){
     // Setup root boxes for gravity tree.
     // Here, we use 2x2=4 root boxes (each with length 'boxsize')
     // This allows you to use up to 4 MPI nodes.
-    reb_simulation_configure_box(r,boxsize,2,2,1);
+    r->root_size = boxsize;
+    r->N_root_x = 2;
+    r->N_root_y = 2;
 
     // Initialize MPI
-    // This can only be done after reb_simulation_configure_box.
     reb_mpi_init(r);
 
     // Setup particles only on master node
diff --git a/examples/selfgravity_plummer/problem.c b/examples/selfgravity_plummer/problem.c
@@ -40,7 +40,7 @@ int main(int argc, char* argv[]){
     r->softening     = 0.01*r0;    // Softening parameter
     r->heartbeat    = heartbeat;
     
-    reb_simulation_configure_box(r, 20.*r0, 1, 1, 1);
+    r->root_size = 20.*r0;
     reb_simulation_add_plummer(r, _N, M, R);    // Adds particles
     reb_simulation_move_to_com(r); 
     reb_simulation_integrate(r, INFINITY);
diff --git a/examples/shearing_sheet/problem.c b/examples/shearing_sheet/problem.c
@@ -47,7 +47,9 @@ int main(int argc, char* argv[]) {
     if (argc>1){                              // Try to read root_size from command line
         root_size = atof(argv[1]);
     }
-    reb_simulation_configure_box(r, root_size, 2, 2, 1);
+    r->root_size = root_size; 
+    r->N_root_x = 2;
+    r->N_root_y = 2;
     r->N_ghost_x = 2;
     r->N_ghost_y = 2;
     r->N_ghost_z = 0;
diff --git a/examples/shearing_sheet_2/problem.c b/examples/shearing_sheet_2/problem.c
@@ -54,7 +54,9 @@ int main(int argc, char* argv[]) {
     if (argc>1){                               // Try to read root_size from command line
         root_size = atof(argv[1]);
     }
-    reb_simulation_configure_box(r, root_size, 2, 2, 1);
+    r->root_size = root_size; 
+    r->N_root_x = 2;
+    r->N_root_y = 2;
     r->N_ghost_x = 2;
     r->N_ghost_y = 2;
     r->N_ghost_z = 0;
diff --git a/examples/shearing_sheet_diagnostics/problem.c b/examples/shearing_sheet_diagnostics/problem.c
@@ -56,7 +56,9 @@ int main(int argc, char* argv[]) {
     double particle_radius_max    = 4;          // m
     double particle_radius_slope  = -3;    
     double root_size                = 100;        // m
-    reb_simulation_configure_box(r, root_size, 2, 2, 1);
+    r->root_size = root_size; 
+    r->N_root_x = 2;
+    r->N_root_y = 2;
     r->N_ghost_x = 2;
     r->N_ghost_y = 2;
     r->N_ghost_z = 0;
diff --git a/examples/shearing_sheet_mpi/problem.c b/examples/shearing_sheet_mpi/problem.c
@@ -49,8 +49,10 @@ int main(int argc, char* argv[]) {
     }
     // Setup 2x2 root boxes.
     // This allows you to use up to 4 MPI nodes.
-    reb_simulation_configure_box(r, root_size, 2, 2, 1);
-    // Initialize MPI (this only works after reb_simulation_configure_box)
+    r->root_size = root_size; 
+    r->N_root_x = 2;
+    r->N_root_y = 2;
+    
     reb_mpi_init(r);
     r->N_ghost_x = 2;
     r->N_ghost_y = 2;
diff --git a/examples/spreading_ring/problem.c b/examples/spreading_ring/problem.c
@@ -35,7 +35,7 @@ int main(int argc, char* argv[]){
     r->heartbeat         = heartbeat;
     
     double boxsize = 4.8;
-    reb_simulation_configure_box(r, boxsize, 1, 1, 1);
+    r->root_size = boxsize;
 
     // Setup particles
     int _N = 1000;
diff --git a/examples/thermalhysteresis/problem.c b/examples/thermalhysteresis/problem.c
@@ -320,7 +320,8 @@ int main(int argc, char* argv[]) {
     r->dt                 = 1e-2*2.*M_PI/OMEGA;
     r->heartbeat          = heartbeat;
     double root_size        = 200; 
-    reb_simulation_configure_box(r, root_size, 8, 1, 1);
+    r->root_size = root_size;
+    r->N_root_x = 8;
     r->N_ghost_x = 1;
     r->N_ghost_y = 1;
     r->N_ghost_z = 0;
diff --git a/ipython_examples/EccentricComets.ipynb b/ipython_examples/EccentricComets.ipynb
@@ -51,7 +51,7 @@
     "sim.collision_resolve_keep_sorted = 1\n",
     "sim.boundary = \"open\"\n",
     "boxsize = 200.\n",
-    "sim.configure_box(boxsize)\n",
+    "sim.root_size = boxsize\n",
     "sim.track_energy_offset = 1\n",
     "\n",
     "#simulation time\n",
diff --git a/ipython_examples/SaturnsRings.ipynb b/ipython_examples/SaturnsRings.ipynb
@@ -135,7 +135,7 @@
    "outputs": [],
    "source": [
     "boxsize = 200.            # [m]\n",
-    "sim.configure_box(boxsize)"
+    "sim.root_size = boxsize"
    ]
   },
   {
diff --git a/rebound/simulation.py b/rebound/simulation.py
@@ -1207,25 +1207,6 @@ def ias15_timescale(self):
         clibrebound.reb_integrator_ias15_timescale.restype = c_double
         return clibrebound.reb_integrator_ias15_timescale(byref(self))
 
-    def configure_box(self, boxsize, N_root_x=1, N_root_y=1, N_root_z=1):
-        """
-        Initialize the simulation box.
-
-        This function only needs to be called it boundary conditions other than "none"
-        are used. In such a case the boxsize must be known and is set with this function.
-
-        Parameters
-        ----------
-        boxsize : float
-            The size of one root box.
-        N_root_x, N_root_y, N_root_z : int, optional
-            The number of root boxes in each direction. The total size of the simulation box
-            will be ``N_root_x * boxsize``, ``N_root_y * boxsize`` and ``N_root_z * boxsize``.
-            By default, there will be exactly one root box in each direction.
-        """
-        clibrebound.reb_simulation_configure_box(byref(self), c_double(boxsize), c_int(N_root_x), c_int(N_root_y), c_int(N_root_z))
-        return
-   
 # Output to file (Simulationarchive)
     def save_to_file(self, filename, interval=None, walltime=None, step=None, delete_file=False):
         """
diff --git a/rebound/tests/test_boundary.py b/rebound/tests/test_boundary.py
diff --git a/rebound/tests/test_collisions.py b/rebound/tests/test_collisions.py
diff --git a/rebound/tests/test_gravity.py b/rebound/tests/test_gravity.py
diff --git a/rebound/tests/test_mercurius.py b/rebound/tests/test_mercurius.py
diff --git a/rebound/tests/test_shearingsheet.py b/rebound/tests/test_shearingsheet.py
diff --git a/rebound/tests/test_simulation.py b/rebound/tests/test_simulation.py
diff --git a/rebound/tests/test_simulationarchive.py b/rebound/tests/test_simulationarchive.py
diff --git a/rebound/tests/test_trace.py b/rebound/tests/test_trace.py
diff --git a/rebound/tests/test_trace_full_bs.py b/rebound/tests/test_trace_full_bs.py
diff --git a/rebound/tests/test_trace_full_ias15.py b/rebound/tests/test_trace_full_ias15.py
diff --git a/src/rebound.h b/src/rebound.h
diff --git a/src/simulation.c b/src/simulation.c
diff --git a/src/tree.c b/src/tree.c

Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ int main(int argc, char* argv[]){`
`24`	`24`	`r->usleep = 1000; // Slow down integration (for visualization only)`
`25`	`25`	`r->dt = 1e-2;`
`26`	`26`
`27`		`- reb_simulation_configure_box(r, 3.0, 1, 1, 1);`
	`27`	`+ r->root_size = 3;`
`28`	`28`
`29`	`29`	`// Initial conditions`
`30`	`30`	`{`