---

FireYear.c

Go to the documentation of this file.

#include "FireYear.h"

FireYear * InitFireYearFuels(int year, GridData * fuels, ChHashTable * fmtble)  {
    FireYear * fy   = NULL;
    FuelModel * fm  = NULL;
    int cell_fm_num;
    int i, j;
    
    /* check args */
    if ( fuels == NULL )    {
        ERR_ERROR_CONTINUE("Unable to initialize FireYear, fuels not initialized. \n", ERR_EINVAL);
        return fy;
        }
    if ( year < 0 ) {
        ERR_ERROR_CONTINUE("Unable to intialize FireYear, year cannot be less than 0. \n", ERR_EINVAL);
        return fy;
        }
        
    /* allocate memory for structure */
    if ( (fy = (FireYear *) malloc(sizeof(FireYear))) == NULL ) {
        ERR_ERROR_CONTINUE("Unable to allocate memory for FireYear. \n", ERR_ENOMEM);   
        return fy;
        }
        
    /* initialize structure members */
    fy->year = year;
    fy->num_fires = FIRE_YEAR_ID_DEFAULT;
    fy->xllcorner = fuels->ghdr->xllcorner;
    fy->yllcorner = fuels->ghdr->yllcorner;
    fy->cellsize = fuels->ghdr->cellsize;
    
    /* allocate memory for fire ids */
    fy->id  = InitIntTwoDArraySizeIniValue(fuels->ghdr->nrows, fuels->ghdr->ncols, FIRE_YEAR_ID_DEFAULT);
    if ( fy->id == NULL )   {
        ERR_ERROR_CONTINUE("Unable to allocate memory for fire ID array underlying FireYear. \n", ERR_ENOMEM);  
        if ( fy != NULL )
            free(fy);
        fy = NULL;
        return fy;
        }

    /* initialize fire ids */
    for(i = 0; i < fuels->ghdr->nrows; i++) {
        for(j = 0; j < fuels->ghdr->ncols; j++) {
            /* retrieve fuel model attribute data */
            GRID_DATA_GET_DATA(fuels, i, j, cell_fm_num);
            if ( ChHashTableRetrieve(fmtble, &cell_fm_num, (void *)&fm) )   {
                ERR_ERROR_CONTINUE("Unable to retrieve fuel model from fuels GridData. \n", ERR_EBADFUNC);
                continue;
                }
            /* set fire id to unburnable */         
            if ( fm->type == EnumRoth && fm->rfm->brntype == EnumRothUnBurnable )   {
                INTTWODARRAY_SET_DATA(fy->id, i, j, FIRE_YEAR_ID_UNBURNABLE);
                }
            else if ( fm->type == EnumPhys && fm->pfm->brntype == EnumPhysUnBurnable )  {
                INTTWODARRAY_SET_DATA(fy->id, i, j, FIRE_YEAR_ID_UNBURNABLE);
                }
            }
        }
                
    return fy;
    }   

int FireYearGetCellIDRowCol(FireYear * fy, int i, int j, int * id)  {
    /* check args */
    if ( fy == NULL || fy->id == NULL ) {
        ERR_ERROR("Unable to get FireYear ID at cell, ID array not initialized. \n", ERR_EINVAL);
        }
        
    *id = INTTWODARRAY_GET_DATA(fy->id, i, j);
        
    return ERR_SUCCESS;
    }

int FireYearGetCellIDRealWorld(FireYear * fy, double rwx, double rwy, int * id) {
    int i,j;
    
    /* check args */
    if ( fy == NULL || fy->id == NULL ) {
        ERR_ERROR("Unable to get FireYear ID at cell, ID array not initialized. \n", ERR_EINVAL);
        }
        
    /* transform real world coordinates to cell indecies */
    if ( CoordTransRealWorldToRaster(rwx, rwy, fy->cellsize, fy->cellsize, 
            COORD_TRANS_XLLCORNER_TO_XULCNTR(fy->xllcorner, fy->cellsize), 
            COORD_TRANS_YLLCORNER_TO_YULCNTR(fy->yllcorner, fy->cellsize, INTTWODARRAY_SIZE_ROW(fy->id)), &i, &j) ) {
        ERR_ERROR("Unable to get FireYear ID at cell, real world coordinates out of range. \n", ERR_ERANGE);
        }
        
    *id = INTTWODARRAY_GET_DATA(fy->id, i, j);
        
    return ERR_SUCCESS;
    }
    
int FireYearIsCellBurnedRowCol(FireYear * fy, int i, int j) {
    int id;
    
    /* check args */
    if ( fy == NULL || fy->id == NULL ) {
        ERR_ERROR_CONTINUE("Unable to determine if cell burned, ID array not initialized. \n", ERR_EINVAL);
        return 0;
        }
        
    id = INTTWODARRAY_GET_DATA(fy->id, i, j);
    
    if ( id == FIRE_YEAR_ID_UNBURNABLE || id == FIRE_YEAR_ID_DEFAULT )  {
        return 0;
        }
        
    return 1;
    }

int FireYearIsCellBurnedRealWorld(FireYear * fy, double rwx, double rwy)    {
    int id, i, j;
    
    /* check args */
    if ( fy == NULL || fy->id == NULL ) {
        ERR_ERROR_CONTINUE("Unable to determine if cell burned, ID array not initialized. \n", ERR_EINVAL);
        return 0;
        }

    /* transform real world coordinates to cell indecies */
    if ( CoordTransRealWorldToRaster(rwx, rwy, fy->cellsize, fy->cellsize, 
            COORD_TRANS_XLLCORNER_TO_XULCNTR(fy->xllcorner, fy->cellsize), 
            COORD_TRANS_YLLCORNER_TO_YULCNTR(fy->yllcorner, fy->cellsize, INTTWODARRAY_SIZE_ROW(fy->id)), &i, &j) ) {
        ERR_ERROR_CONTINUE("Unable to get FireYear ID at cell, real world coordinates out of range. \n", ERR_ERANGE);
        return 0;
        }       
    
    id = INTTWODARRAY_GET_DATA(fy->id, i, j);
    
    if ( id == FIRE_YEAR_ID_UNBURNABLE || id == FIRE_YEAR_ID_DEFAULT )  {
        return 0;
        }
        
    return 1;
    }

void FireYearSetCellNewFireIDRowCol(FireYear * fy, int i, int j)    {
    /* check args */
    if ( fy == NULL || fy->id == NULL ) {
        ERR_ERROR_CONTINUE("Unable to set cell fire ID, ID array not initialized. \n", ERR_EINVAL);
        return;
        }
        
    /* if cell is burnable, increment num_fires and assign cell new fire id */  
    if ( INTTWODARRAY_GET_DATA(fy->id, i, j) != FIRE_YEAR_ID_UNBURNABLE )   {
        fy->num_fires += 1;
        INTTWODARRAY_SET_DATA(fy->id, i, j, fy->num_fires);
        }
        
    return;
    }

void FireYearSetCellNewFireIDRealWorld(FireYear * fy, double rwx, double rwy)   {
    int i, j;
    
    /* check args */
    if ( fy == NULL || fy->id == NULL ) {
        ERR_ERROR_CONTINUE("Unable to set cell fire ID, ID array not initialized. \n", ERR_EINVAL);
        return;
        }

    /* transform real world coordinates to cell indecies */
    if ( CoordTransRealWorldToRaster(rwx, rwy, fy->cellsize, fy->cellsize, 
            COORD_TRANS_XLLCORNER_TO_XULCNTR(fy->xllcorner, fy->cellsize), 
            COORD_TRANS_YLLCORNER_TO_YULCNTR(fy->yllcorner, fy->cellsize, INTTWODARRAY_SIZE_ROW(fy->id)), &i, &j) ) {
        ERR_ERROR_CONTINUE("Unable to set cell fire ID, real world coordinates out of range. \n", ERR_ERANGE);
        return;
        }       

    /* if cell is burnable, increment num_fires and assign cell new fire id */  
    if ( INTTWODARRAY_GET_DATA(fy->id, i, j) != FIRE_YEAR_ID_UNBURNABLE )   {
        fy->num_fires += 1;
        INTTWODARRAY_SET_DATA(fy->id, i, j, fy->num_fires);
        }   

    return;
    }

void FreeFireYear(FireYear * fy)    {
    if ( fy != NULL )   {
        if ( fy->id != NULL )   {
            FreeIntTwoDArray(fy->id);
            }
        free(fy);
        }       
    fy = NULL;
    return;
    }
    
/* end of FireYear.c */

---