Main Page   Compound List   File List   Compound Members   File Members  

StandAge.c File Reference

#include "StandAge.h"

Go to the source code of this file.

Functions

int IncrementStandAge (FireYear * fy, GridData * std_age)
 If cell was unburned during recent fire season, age of cell incremented. Otherwise age of cell reset to 0. More...


Detailed Description

Author(s):
Marco Morais
Date:
2000-2001

HFire (Highly Optmized Tolerance Fire Spread Model) Library Copyright (C) 2001 Marco Morais

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

This library 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 Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

Definition in file StandAge.c.


Function Documentation

int IncrementStandAge ( FireYear * fy,
GridData * std_age )
 

If cell was unburned during recent fire season, age of cell incremented. Otherwise age of cell reset to 0.

See also:
FireYear , GridData , Check the config file documentation
Parameters:
fy   FireYear of fire perimeters for completed fire season
std_age   raster of current stand age, values will be updated upon successful return
Return values:
ERR_SUCCESS   (0) if operation successful, an error code otherwise
Note:
Best use of this facility is as follows:
            int error_status = SomeFunctionXXX();
            if ( error_status )
                // something bad happened

Definition at line 27 of file StandAge.c.


Generated at Fri Jun 22 00:46:53 2001 for HFire by doxygen1.2.3 written by Dimitri van Heesch, © 1997-2000