Subversion Repositories public iLand

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

**    iLand - an individual based forest landscape and disturbance model

**    http://iland.boku.ac.at

**    Copyright (C) 2009-  Werner Rammer, Rupert Seidl

**

**    This program 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.

**

**    This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.

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

#ifndef ESTABLISHMENT_H

#define ESTABLISHMENT_H

#include <QtCore/QPoint>

class Climate;

class ResourceUnitSpecies;

class Establishment

{

public:

    Establishment();

    Establishment(const Climate *climate, const ResourceUnitSpecies *rus);

    /// setup function that links to a climate and the resource unit / species

    void setup(const Climate *climate, const ResourceUnitSpecies *rus);

    /// main function "calculate()": process the establishment routine

    void calculate();

    void clear();

    void calculateAbioticEnvironment(); ///< calculate the abiotic environment (TACA model)

    void writeDebugOutputs();

    // some informations after execution

    double avgSeedDensity() const { return mPxDensity;} ///< average seed density on the RU

    double abioticEnvironment() const {return mPAbiotic; } ///< integrated value of abiotic environment (i.e.: TACA-climate + total iLand environment)

    int numberEstablished() const { return mNumberEstablished; } ///< return number of newly established trees in the current year

    bool TACAminTemp() const { return mTACA_min_temp;} ///< TACA flag for minimum temperature

    bool TACAchill() const { return mTACA_chill;} ///< TACA flag chilling requirement

    bool TACgdd() const { return mTACA_gdd;} ///< TACA flag for growing degree days

    bool TACAfrostFree() const { return mTACA_frostfree;} ///< TACA flag for number of frost free days

    int TACAfrostDaysAfterBudBirst() const { return mTACA_frostAfterBuds; } ///< number of frost days after bud birst

    double avgLIFValue() const { return mLIFcount>0?mSumLIFvalue/double(mLIFcount):0.; } ///< average LIF value of LIF pixels where establishment is tested

    double waterLimitation() const { return mWaterLimitation; } ///< scalar value between 0 and 1 (1: no limitation, 0: no establishment)

    static void debugInfo();

private:

    double mPAbiotic; ///< abiotic probability for establishment (climate)

    double calculateWaterLimitation(const int veg_period_start, const int veg_period_end); ///< calculate effect of water limitation on establishment, returns scalar [0..1]

    inline bool establishTree(const QPoint &pos_lif, const float lif_value, const float seed_value); ///< do the final check whether a seedling can establish at given location

    // 2 different approaches for calculating the establishment

    void calculatePerSeedPixel(); ///< function that checks seed pixels first

    void calculatePerRU(); ///< function that starts with 2m LIF pixels

    const Climate *mClimate; ///< link to the current climate

    const ResourceUnitSpecies *mRUS; ///< link to the resource unit species (links to production data and species respones)

    // some statistics

    double mPxDensity;

    int mNumberEstablished; // number of established trees in the current year

    // TACA switches

    bool mTACA_min_temp; // minimum temperature threshold

    bool mTACA_chill;  // (total) chilling requirement

    bool mTACA_gdd;   // gdd-thresholds

    bool mTACA_frostfree; // frost free days in vegetation period

    int mTACA_frostAfterBuds; // frost days after bud birst

    double mSumLIFvalue;

    double mWaterLimitation; // scalar 0..1 signifying the drought limitation of establishment

    int mLIFcount;

};

#endif // ESTABLISHMENT_H