Success.c

Go to the documentation of this file.

/* General notes on revisions to this source file. 
       Nov/Dec 2004 v2.3.2: documentation upgrade 
                - Doxygen tags added 
       Sep 2011 v2.8.5: added salinity responses 
                - added succession in response to salinity  
        
*/

#include "success.h"


void HabSwitch_Init(void)
{
  int ii;
  
        /* put these habitat-specific parameters into a concise data struct for use here */
  for( ii = 0; ii < habNumTot; ii++) {
        Habi[ii].Water.Llo = HP_SfDepthLo[ii+1];
        Habi[ii].Water.Lhi = HP_SfDepthHi[ii+1];
        Habi[ii].Water.Pin = HP_SfDepthInt[ii+1];
        Habi[ii].Nutrient.Llo = HP_PhosLo[ii+1];
        Habi[ii].Nutrient.Lhi = HP_PhosHi[ii+1];
        Habi[ii].Nutrient.Pin = HP_PhosInt[ii+1];
        Habi[ii].PFin = HP_FireInt[ii+1];
        Habi[ii].Salinity.Llo = HP_SalinLo[ii+1];
        Habi[ii].Salinity.Lhi = HP_SalinHi[ii+1];
        Habi[ii].Salinity.Pin = HP_SalinInt[ii+1];
  }
   
   alloc_hab_hist( );
   sprintf (msgStr, "Succession ON, module OK for %d habitats...", ii ); usrErr(msgStr); WriteMsg(msgStr,1);

   return; 
}


unsigned char HabSwitch(int ix, int iy, float *Water, float *Nutrient, int *Fire, float *Salinity, unsigned char *HAB)
{
 int StateW, StateN, StateS, i;
 int HabW[MAX_NHAB], HabN[MAX_NHAB], HabS[MAX_NHAB], DW, DN, DS;
 int cell =  T(ix,iy);
 int hab = HAB[cell];   /* current habitat in the cell */

 /* define the habitat type that matches the existing water conditions */
 
 /* HabHist is an array of integers : ssSnnNwwW, where 
    ww are the two digits for the number of weeks in the water level favorable conditions,
    W the number of days in those conditions during the current week;
    nn are the two digits for the number of weeks being in the nutrient favorable conditions, 
    N the number of days in those conditions during the current week; 
    ss are the two digits for the number of weeks in the salinity favorable conditions,
    S the number of days in those conditions during the current week;
    
    The switching occurs when all of these histories exceed the habitat specific 
        periods Pin.
 */
 for ( i = 0; i < habNumTot; i++ )
        {
         DW = HabHist[cell*habNumTot +i]%10;
         HabW[i] = (HabHist[cell*habNumTot +i]/10)%100;
         DN = (HabHist[cell*habNumTot +i]/1000)%10;
         HabN[i] = HabHist[cell*habNumTot +i]/10000;
         DS = (HabHist[cell*habNumTot +i]/1000000)%10;
         HabS[i] = HabHist[cell*habNumTot +i]/10000000;
         
         /* when the averaging time elapses, if #favorable days exceeds a threshold (using 4 for 7 day AV_PER), increment the period (weeks) history */
         if ((int)SimTime.TIME%AV_PER == 0)
           { 
                if (DW > SW_TIME_TH_W) HabHist[cell*habNumTot +i] = HabHist[cell*habNumTot +i] - DW + 100;
                else HabHist[cell*habNumTot +i] = 0;
                if (DN > SW_TIME_TH_N) HabHist[cell*habNumTot +i] = HabHist[cell*habNumTot +i] - DN*1000 + 10000;
                else HabHist[cell*habNumTot +i] = 0;
                if (DS > SW_TIME_TH_S) HabHist[cell*habNumTot +i] = HabHist[cell*habNumTot +i] - DS*1000000 + 10000000;
                else HabHist[cell*habNumTot +i] = 0;
           }    

        /* check what habitat type the existing conditions match; increment the day# if conditions are favorable */
         if ( InHab (Water[cell], Habi[i].Water) )                    HabHist[cell*habNumTot + i] = HabHist[cell*habNumTot + i] + 1;
         if ( InHab (Nutrient[cell]*conv_kgTOmg, Habi[i].Nutrient) )  HabHist[cell*habNumTot + i] = HabHist[cell*habNumTot + i] + 1000;
         if ( InHab (Salinity[cell], Habi[i].Salinity) )              HabHist[cell*habNumTot + i] = HabHist[cell*habNumTot + i] + 1000000;
        } 
   
         /* check if the historical conditions for switching hold */
 for ( i = 0; i < habNumTot; i++ )  
        if ( HabW[i] >= Habi[i].Water.Pin && HabN[i] >= Habi[i].Nutrient.Pin && HabS[i] >= Habi[i].Salinity.Pin ) 
                { HabHist[cell*habNumTot +i] = 0;
                  return (i+1); /* returns new hab, HAB[] is offset by 1 from these array IDs */
                }
                
 return hab;    
}



int InHab(float Var, struct HabData Params )
{
  if ( (Var <= Params.Lhi || Params.Lhi >= MAX_SW) && Var >= Params.Llo ) 
          return 1;
  else return 0;
}


void alloc_hab_hist( void )
{
  HabHist = (unsigned long *) nalloc(sizeof(unsigned long)*(s0+2)*(s1+2)*(habNumTot),"HabHist");
  init_pvar(HabHist,NULL,'i',0);
}


 /**********************/