/****************************************************************************************
 *  pressureStar.c                                                                      *
 *  (formerly "star.for")                                                               *
 *  Determines the star pressure contributions for particle velocity components of a    *
 *  specific ray at a specify coordinate.                                               *
 *                                                                                      *
 * ------------------------------------------------------------------------------------ *
 * Website:                                                                             *
 *          https://github.com/EyNuel/cTraceo/wiki                                      *
 *                                                                                      *
 * License: This file is part of the cTraceo Raytracing Model and is released under the *
 *          Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported License  *
 *          http://creativecommons.org/licenses/by-nc-sa/3.0/                           *
 *                                                                                      *
 * NOTE:    cTraceo is research code under active development.                          *
 *          The code may contain bugs and updates are possible in the future.           *
 *                                                                                      *
 * Written for project SENSOCEAN by:                                                    *
 *          Emanuel Ey                                                                  *
 *          emanuel.ey@gmail.com                                                        *
 *          Copyright (C) 2011 - 2013                                                   *
 *          Signal Processing Laboratory                                                *
 *          Universidade do Algarve                                                     *
 *                                                                                      *
 * cTraceo is the C port of the FORTRAN 77 TRACEO code written by:                      *
 *          Orlando Camargo Rodriguez:                                                  *
 *          Copyright (C) 2010                                                          *
 *          Orlando Camargo Rodriguez                                                   *
 *          orodrig@ualg.pt                                                             *
 *          Universidade do Algarve                                                     *
 *          Physics Department                                                          *
 *          Signal Processing Laboratory                                                *
 *                                                                                      *
 * ------------------------------------------------------------------------------------ *
 * Inputs:                                                                              *
 *          settings:   Pointer to structure containing all input info.                 *
 *          ray:        Pointer the the ray, who's influence we are determining.        *
 *          rHyd:       Range coordinate of the hydrophone.                             *
 *          zHyd:       Depth coordinate of the hydrophone.                             *
 *          q0:         Value of q at beginning of ray.                                 *
 *                                                                                      *
 * Outputs:                                                                             *
 *          pressure_H: A 3 element array containing the horizontal                     *
 *                      pressure components ( LEFT, CENTER, RIGHT).                     *
 *          pressure_V: A 3 element array containing the vertical                       *
 *                      pressure components ( TOP, CENTER, BOTTOM).                     *
 *                      NOTE:   there is redundacy in the above arrays: the center      *
 *                              component is repeated for performance reasons.          *
 *                                                                                      *
 * Return Value:                                                                        *
 *          0:          At least one of the star coordinates (rLeft, rRight, zBottom,   *
 *                      zTop) is outside the rays' range or rBox.                       *
 *                      Do not use the outputs -doing so will result in a segfault      *
 *          1:          Outputs are valid.                                              *
 *                                                                                      *
 ****************************************************************************************/


#pragma once
#include "globals.h"
#include <complex.h>
#include "bracket.c"

uintptr_t   pressureStar(settings_t*, ray_t*, double, double, double, complex double*, complex double[]);

uintptr_t   pressureStar( settings_t* settings, ray_t* ray, double rHyd, double zHyd, double q0, complex double* pressure_H, complex double* pressure_V){

    double          rLeft, rRight, zTop, zBottom;
    uintptr_t       iHyd;
    double          dzdr, tauRay, zRay, qRay, width;
    complex double  ampRay;
    
    /* start with determining the coordinates for which we will need to calculate
     * acoustic pressure.
     */
    rLeft   = rHyd - settings->output.dr;
    rRight  = rHyd + settings->output.dr;
    zBottom = zHyd - settings->output.dz;
    zTop    = zHyd + settings->output.dz;
    
    DEBUG(9,"rL: %.2lf; rR: %.2lf; zD: %.2lf; zU: %.2lf;\n", rLeft, rRight, zBottom, zTop);
    
    //we have to check that these points are within the rBox:
    if( rLeft   <   settings->source.rbox1 ||
        rRight  >=  settings->source.rbox2 ){
        DEBUG(8, "Either rLeft or rRight are outside rBox\n");
        return 0;
    }
    
    
    //find out at what index of the ray coordinates the hydrophone is located:
    if( bracket(ray->nCoords, ray->r, rLeft, &iHyd) ){
        // NOTE:    this block will not be run if the index returned by bracket() is out of bounds.
        DEBUG(8, "iHyd: %u => iRefl: %u\n", (uint32_t)iHyd, (uint32_t)ray->iRefl[iHyd]);
        if ( iHyd<ray->nCoords-1 ){
            getRayParameters(ray, iHyd, q0, rLeft, &dzdr, &tauRay, &zRay, &ampRay, &qRay, &width);
            DEBUG(8, "dzdr: %e, tauRay: %e, zRay: %e, ampRay: %e, qRay: %e, w: %e\n", dzdr, tauRay, zRay, cabs(ampRay), qRay, width);
            getRayPressureExplicit(settings, ray, iHyd, zHyd, tauRay, zRay, dzdr, ampRay, width, &pressure_H[LEFT]);
        }
    }else{
        DEBUG(6, "rLeft (%lf) can not be bracketed.\n", rLeft);
        return 0;
    }
    
    
    
    if( bracket(ray->nCoords, ray->r, rHyd, &iHyd)){
        /* NOTE:    this block will not be run if the index returned by
         *          bracket() is out of bounds.
         */
         
        DEBUG(8, "iHyd: %u => iRefl: %u\n", (uint32_t)iHyd, (uint32_t)ray->iRefl[iHyd]);
        if ( iHyd<ray->nCoords-1 ){
            getRayParameters(ray, iHyd, q0, rHyd, &dzdr, &tauRay, &zRay, &ampRay, &qRay, &width);
            DEBUG(8, "dzdr: %e, tauRay: %e, zRay: %e, ampRay: %e, qRay: %e, w: %e\n", dzdr, tauRay, zRay, cabs(ampRay), qRay, width);
            getRayPressureExplicit(settings, ray, iHyd, zTop,   tauRay, zRay, dzdr, ampRay, width, &pressure_V[TOP]);
            getRayPressureExplicit(settings, ray, iHyd, zHyd,   tauRay, zRay, dzdr, ampRay, width, &pressure_V[CENTER]);
            getRayPressureExplicit(settings, ray, iHyd, zBottom,tauRay, zRay, dzdr, ampRay, width, &pressure_V[BOTTOM]);
            pressure_H[CENTER] = pressure_V[CENTER];
        }
    }else{
        DEBUG(6, "rHyd (%lf) can not be bracketed.\n", rHyd);
        return 0;
    }
    
    
    
    if( bracket(ray->nCoords, ray->r, rRight, &iHyd)){
        /* NOTE:    this block will not be run if the index returned by
         *          bracket() is out of bounds.
         */
         
        DEBUG(8, "iHyd: %u => iRefl: %u\n", (uint32_t)iHyd, (uint32_t)ray->iRefl[iHyd]);
        if ( iHyd<ray->nCoords-1 ){
            //DEBUG(3, "r: %lf, z: %lf, amp:%lf, iHyd: %u\n", ray->r[iHyd], ray->z[iHyd], cabs(ray->amp[iHyd]), (uint32_t)iHyd);
            getRayParameters(ray, iHyd, q0, rRight, &dzdr, &tauRay, &zRay, &ampRay, &qRay, &width);
            DEBUG(8, "dzdr: %e, tauRay: %e, zRay: %e, ampRay: %e, qRay: %e, w: %e\n", dzdr, tauRay, zRay, cabs(ampRay), qRay, width);
            getRayPressureExplicit(settings, ray, iHyd, zHyd,   tauRay, zRay, dzdr, ampRay, width, &pressure_H[RIGHT]);
        }
    }else{
        DEBUG(6, "rRight (%lf) can not be bracketed.\n", rRight);
        return 0;
    }
    
    //success
    return 1;
}