seeddispersal.h

Go to the documentation of this file.

/********************************************************************************************
**    iLand - an individual based forest landscape and disturbance model
**    http://iland-model.org
**    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 SEEDDISPERSAL_H
#define SEEDDISPERSAL_H
#include <QHash>
#include "grid.h"
class Species;
class Tree;
 
class SeedDispersal
{
public:
    SeedDispersal(Species *species=0): mIndexFactor(10), mSaplingMapCreated(false), mSetup(false), mSpecies(species)  {}
    ~SeedDispersal();
    bool isSetup() const { return mSetup; }
    void setup();
    //
    static void setupExternalSeeds();
    static void finalizeExternalSeeds();
    // access
    const Grid<float> &seedMap() const { return mSeedMap; } 
    const Species *species() const {return mSpecies; }
 
    void setMatureTree(const QPoint &lip_index, double leaf_area) {
       mSourceMap.valueAtIndex(lip_index.x()/mIndexFactor, lip_index.y()/mIndexFactor) += leaf_area;
    }
 
    void setSaplingTree(const QPoint &lip_index, float leaf_area);
 
    void seedProductionSerotiny(const Tree *tree);
 
    // operations
    void newYear(); 
    void clearSaplingMap(); 
 
    void execute(); 
 
    // debug and helpers
    void loadFromImage(const QString &fileName); 
    void dumpMapNextYear(QString file_name) { mDumpNextYearFileName = file_name; }
private:
    void createKernel(Grid<float> &kernel, const float scale_area); 
    double setupLDD(); 
    double treemig(const double &distance);
    // numerical integration of the treemig function up to a radius 'max_distance'
    double treemig_centercell(const double &max_distance);
    double treemig_distanceTo(const double value);
 
    void distributeSeeds(Grid<float> *seed_map=0);
 
 
    double mTM_as1, mTM_as2, mTM_ks; 
    double mTM_fecundity_cell; 
    double mTM_occupancy; 
    double mNonSeedYearFraction; 
    double mKernelThresholdArea, mKernelThresholdLDD; 
    int mIndexFactor; 
    Grid<float> mSeedMap; 
    Grid<float> mSourceMap; 
    Grid<float> mKernelSeedYear; 
    Grid<float> mKernelNonSeedYear; 
    Grid<float> mKernelSerotiny; 
    Grid<float> mSeedMapSerotiny; 
    Grid<float> mSaplingSourceMap; 
    bool mSaplingMapCreated; 
    QVector<double> mLDDDistance; 
    QVector<double> mLDDDensity;  
    int mLDDRings; 
    float mLDDSeedlings; 
    bool mHasPendingSerotiny; 
    bool mSetup;
    Species *mSpecies;
    bool mDumpSeedMaps; 
    bool mHasExternalSeedInput; 
    QString mDumpNextYearFileName; 
    unsigned int mExternalSeedDirection; 
    int mExternalSeedBuffer; 
    double mExternalSeedBackgroundInput; 
    // external seeds
    Grid<float> mExternalSeedMap; 
    void setupExternalSeedsForSpecies(Species *species); 
    static Grid<float> *mExternalSeedBaseMap; 
    static QHash<QString, QVector<double> > mExtSeedData; 
    static int mExtSeedSizeX, mExtSeedSizeY; 
};
 
#endif // SEEDDISPERSAL_H