rebound-bind 4.6.0

/**
 * @file 	integrator.c
 * @brief 	Integration schemes.
 * @author 	Hanno Rein <hanno@hanno-rein.de>
 * @details	This file manages the different integration scheme.  
 * 
 * @section 	LICENSE
 * Copyright (c) 2015 Hanno Rein
 * 
 * This file is part of rebound.
 *
 * rebound is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * rebound is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with rebound.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include "rebound.h"
#include "gravity.h"
#include "tree.h"
#include "boundary.h"
#include "output.h"
#include "integrator.h"
#include "integrator_whfast.h"
#include "integrator_whfast512.h"
#include "integrator_saba.h"
#include "integrator_ias15.h"
#include "integrator_mercurius.h"
#include "integrator_trace.h"
#include "integrator_leapfrog.h"
#include "integrator_sei.h"
#include "integrator_janus.h"
#include "integrator_eos.h"
#include "integrator_bs.h"
#define MAX(a, b) ((a) > (b) ? (a) : (b))
#define MIN(a, b) ((a) > (b) ? (b) : (a))   ///< Returns the minimum of a and b

void reb_integrator_step(struct reb_simulation* r){
    switch(r->integrator){
        case REB_INTEGRATOR_IAS15:
            reb_integrator_ias15_step(r);
            break;
        case REB_INTEGRATOR_LEAPFROG:
            reb_integrator_leapfrog_step(r);
            break;
        case REB_INTEGRATOR_SEI:
            reb_integrator_sei_step(r);
            break;
        case REB_INTEGRATOR_WHFAST:
            reb_integrator_whfast_step(r);
            break;
        case REB_INTEGRATOR_WHFAST512:
            reb_integrator_whfast512_step(r);
            break;
        case REB_INTEGRATOR_SABA:
            reb_integrator_saba_step(r);
            break;
        case REB_INTEGRATOR_MERCURIUS:
            reb_integrator_mercurius_step(r);
            break;
        case REB_INTEGRATOR_JANUS:
            reb_integrator_janus_step(r);
            break;
        case REB_INTEGRATOR_EOS:
            reb_integrator_eos_step(r);
            break;
        case REB_INTEGRATOR_BS:
            reb_integrator_bs_step(r);
            break;
        case REB_INTEGRATOR_TRACE:
            reb_integrator_trace_step(r);
            break;
        case REB_INTEGRATOR_NONE:
            r->t += r->dt;
            r->dt_last_done = r->dt;
            break;
        default:
            break;
    }

    // Integrate other ODEs
    if (r->integrator != REB_INTEGRATOR_BS && r->N_odes){
        if (r->ode_warnings==0 && (!r->ri_whfast.safe_mode || !r->ri_saba.safe_mode || !r->ri_eos.safe_mode || !r->ri_mercurius.safe_mode)){
            reb_simulation_warning(r, "Safe mode should be enabled when custom ODEs are being used.");
            r->ode_warnings = 1;
        }

        double dt = r->dt_last_done;
        double t = r->t - r->dt_last_done; // Note: floating point inaccuracy
        double forward = (dt>0.) ? 1. : -1.;
        r->ri_bs.first_or_last_step = 1;
        while(t*forward < r->t*forward && fabs((r->t - t)/(fabs(r->t)+1e-16))>1e-15){
            if (reb_sigint > 1){
                r->status = REB_STATUS_SIGINT;
                return;
            }
            if (r->ri_bs.dt_proposed !=0.){
                double max_dt = fabs(r->t - t);
                dt = fabs(r->ri_bs.dt_proposed);
                if (dt > max_dt){ // Don't overshoot N-body timestep
                    dt = max_dt;
                    r->ri_bs.first_or_last_step = 1;
                }
                dt *= forward;
            }
            int success = reb_integrator_bs_step_odes(r, dt);
            if (success){
                t += dt;
            }
        }
    }
}

void reb_simulation_synchronize(struct reb_simulation* r){
    switch(r->integrator){
        case REB_INTEGRATOR_IAS15:
            reb_integrator_ias15_synchronize(r);
            break;
        case REB_INTEGRATOR_LEAPFROG:
            reb_integrator_leapfrog_synchronize(r);
            break;
        case REB_INTEGRATOR_SEI:
            reb_integrator_sei_synchronize(r);
            break;
        case REB_INTEGRATOR_WHFAST:
            reb_integrator_whfast_synchronize(r);
            break;
        case REB_INTEGRATOR_WHFAST512:
            reb_integrator_whfast512_synchronize(r);
            break;
        case REB_INTEGRATOR_SABA:
            reb_integrator_saba_synchronize(r);
            break;
        case REB_INTEGRATOR_MERCURIUS:
            reb_integrator_mercurius_synchronize(r);
            break;
        case REB_INTEGRATOR_JANUS:
            reb_integrator_janus_synchronize(r);
            break;
        case REB_INTEGRATOR_EOS:
            reb_integrator_eos_synchronize(r);
            break;
        case REB_INTEGRATOR_BS:
            reb_integrator_bs_synchronize(r);
            break;
        case REB_INTEGRATOR_TRACE:
            reb_integrator_trace_synchronize(r);
            break;
        default:
            break;
    }
}

void reb_simulation_reset_integrator(struct reb_simulation* r){
    r->integrator = REB_INTEGRATOR_IAS15;
    r->gravity = REB_GRAVITY_BASIC; // Some integrators set their own gravity routine. Resetting.
    r->gravity_ignore_terms = 0;
    reb_integrator_ias15_reset(r);
    reb_integrator_mercurius_reset(r);
    reb_integrator_sei_reset(r);
    reb_integrator_whfast_reset(r);
    reb_integrator_whfast512_reset(r);
    reb_integrator_saba_reset(r);
    reb_integrator_janus_reset(r);
    reb_integrator_eos_reset(r);
    reb_integrator_bs_reset(r);
    reb_integrator_trace_reset(r);
    reb_integrator_leapfrog_reset(r);
}


void reb_simulation_update_acceleration(struct reb_simulation* r){
    /***********************************************************
     * Prepare TREE for force calculations
     **********************************************************/
    // Update and simplify tree. 
    // Prepare particles for distribution to other nodes. 
    // This function also creates the tree if called for the first time.
    if (r->tree_needs_update || r->gravity==REB_GRAVITY_TREE || r->collision==REB_COLLISION_TREE || r->collision==REB_COLLISION_LINETREE){
        // Check for root crossings.
        reb_boundary_check(r);     
        // Update tree (this will remove particles which left the box)
        reb_simulation_update_tree(r);          
    }

#ifdef MPI
    // Distribute particles and add newly received particles to tree.
    reb_communication_mpi_distribute_particles(r);
#endif // MPI

    if (r->tree_root!=NULL && r->gravity==REB_GRAVITY_TREE){
        // Update center of mass and quadrupole moments in tree in preparation of force calculation.
        reb_simulation_update_tree_gravity_data(r); 
#ifdef MPI
        // Prepare essential tree (and particles close to the boundary needed for collisions) for distribution to other nodes.
        reb_tree_prepare_essential_tree_for_gravity(r);

        // Transfer essential tree and particles needed for collisions.
        reb_communication_mpi_distribute_essential_tree_for_gravity(r);
#endif // MPI
    }

    /***********************************************************
     * Main gravity calculation
     * This first sets accelerations to zero even if
     * REB_GRAVITY_NONE is used.
     **********************************************************/
    reb_simulation_update_acceleration_gravity(r);
    if (r->N_var){
        reb_simulation_update_acceleration_gravity_var(r);
    }

    /***********************************************************
     * Additional forces
     **********************************************************/
    if (r->additional_forces  && (r->integrator != REB_INTEGRATOR_MERCURIUS || r->ri_mercurius.mode==0) && (r->integrator != REB_INTEGRATOR_TRACE || r->ri_trace.mode==REB_TRACE_MODE_INTERACTION || r->ri_trace.mode==REB_TRACE_MODE_FULL)){
        // For Mercurius:
        // Additional forces are only calculated in the kick step, not during close encounter
        if (r->integrator==REB_INTEGRATOR_MERCURIUS){
            // shift pos and velocity so that external forces are calculated in inertial frame
            // Note: Copying avoids degrading floating point performance
            if(r->N>r->ri_mercurius.N_allocated_additional_forces){
                r->ri_mercurius.particles_backup_additional_forces = realloc(r->ri_mercurius.particles_backup_additional_forces, r->N*sizeof(struct reb_particle));
                r->ri_mercurius.N_allocated_additional_forces = r->N;
            }
            memcpy(r->ri_mercurius.particles_backup_additional_forces,r->particles,r->N*sizeof(struct reb_particle)); 
            reb_integrator_mercurius_dh_to_inertial(r);
        }
        if (r->integrator==REB_INTEGRATOR_TRACE){
            // shift pos and velocity so that external forces are calculated in inertial frame
            // Note: Copying avoids degrading floating point performance
            if(r->N>r->ri_trace.N_allocated_additional_forces){
                r->ri_trace.particles_backup_additional_forces = realloc(r->ri_trace.particles_backup_additional_forces, r->N*sizeof(struct reb_particle));
                r->ri_trace.N_allocated_additional_forces = r->N;
            }
            memcpy(r->ri_trace.particles_backup_additional_forces,r->particles,r->N*sizeof(struct reb_particle));
            reb_integrator_trace_dh_to_inertial(r);
        }
        r->additional_forces(r);
        if (r->integrator==REB_INTEGRATOR_MERCURIUS){
            struct reb_particle* restrict const particles = r->particles;
            struct reb_particle* restrict const backup = r->ri_mercurius.particles_backup_additional_forces;
            for (unsigned int i=0;i<r->N;i++){
                particles[i].x = backup[i].x;
                particles[i].y = backup[i].y;
                particles[i].z = backup[i].z;
                particles[i].vx = backup[i].vx;
                particles[i].vy = backup[i].vy;
                particles[i].vz = backup[i].vz;
            }
        }
        if (r->integrator==REB_INTEGRATOR_TRACE){
            struct reb_particle* restrict const particles = r->particles;
            struct reb_particle* restrict const backup = r->ri_trace.particles_backup_additional_forces;
            for (unsigned int i=0;i<r->N;i++){
                particles[i].x = backup[i].x;
                particles[i].y = backup[i].y;
                particles[i].z = backup[i].z;
                particles[i].vx = backup[i].vx;
                particles[i].vy = backup[i].vy;
                particles[i].vz = backup[i].vz;
            }
        }
    }
}