resourceunit.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 RESOURCEUNIT_H
#define RESOURCEUNIT_H
 
#include "tree.h"
#include "resourceunitspecies.h"
#include "standstatistics.h"
#include <QtCore/QVector>
#include <QtCore/QRectF>
// forward declarations
class SpeciesSet;
class Climate;
class WaterCycle;
class Snag;
class Soil;
struct SaplingCell;
class SVDStates; class SVDStateOut;
 
struct ResourceUnitVariables
{
    ResourceUnitVariables(): nitrogenAvailable(0.), cumCarbonUptake(0.), cumCarbonToAtm(0.), cumNEP(0.), carbonUptake(0.), carbonToAtm(0.), NEP(0.) { nitrogenAvailableDelta=0.; }
    double nitrogenAvailable; 
    double cumCarbonUptake; 
    double cumCarbonToAtm; 
    double cumNEP; 
    double carbonUptake, carbonToAtm, NEP; 
    static double nitrogenAvailableDelta; 
};
 
class ResourceUnit
{
public:
    ResourceUnit(const int index);
    ~ResourceUnit();
    // setup/maintenance
    void setup(); 
    void setSpeciesSet(SpeciesSet *set);
    void setClimate(Climate* climate) { mClimate = climate; }
    void setBoundingBox(const QRectF &bb);
    void setID(const int id) { mID = id; }
 
    // access to elements
    const Climate *climate() const { return mClimate; } 
    SpeciesSet *speciesSet() const { return  mSpeciesSet; } 
    const WaterCycle *waterCycle() const { return mWater; } 
    Snag *snag() const { return mSnag; } 
    Soil *soil() const { return mSoil; } 
    SaplingCell *saplingCellArray() const { return mSaplings; } 
    SaplingCell *saplingCell(const QPoint &lifCoords) const; 
    double saplingCoveredArea(bool below130cm) const;
 
    ResourceUnitSpecies &resourceUnitSpecies(const Species *species); 
    const ResourceUnitSpecies *constResourceUnitSpecies(const Species *species) const; 
    ResourceUnitSpecies *resourceUnitSpecies(const int species_index) const { return mRUSpecies[species_index]; } 
    const QList<ResourceUnitSpecies*> &ruSpecies() const { return mRUSpecies; }
    QVector<Tree> &trees() { return mTrees; } 
    const QVector<Tree> &constTrees() const { return mTrees; } 
    Tree *tree(const int index) { return &(mTrees[index]);} 
    const ResourceUnitVariables &resouceUnitVariables() const { return mUnitVariables; } 
    const StandStatistics &statistics() const {return mStatistics; }
 
    // properties
    int index() const { return mIndex; }
    int id() const { return mID; }
    const QRectF &boundingBox() const { return mBoundingBox; }
    const QPoint &cornerPointOffset() const { return mCornerOffset; } 
    double area() const { return mPixelCount*100; } 
    double stockedArea() const { return mStockedArea; } 
    double stockableArea() const { return mStockableArea; } 
    double productiveArea() const { return mEffectiveArea; } 
    double leafAreaIndex() const { return stockableArea()?mAggregatedLA / stockableArea():0.; }
    double leafArea() const { return mAggregatedLA; } 
    double interceptedArea(const double LA, const double LightResponse) { return mEffectiveArea_perWLA * LA * LightResponse; }
    const double &LRImodifier() const { return mLRI_modification; }
    double averageAging() const { return mAverageAging; } 
    double topHeight(bool &rIrregular) const;
    int svdStateId() const { return mSVDState.stateId; }
    int svdPreviousStateId() const { return mSVDState.previousStateId; }
    int svdStateTime() const {return mSVDState.time; }
    int svdPreviousTime() const {return mSVDState.previousTime; }
 
    // actions
    Tree &newTree();  
    int newTreeIndex(); 
    void cleanTreeList(); 
    void treeDied() { mHasDeadTrees = true; } 
    bool hasDiedTrees() const { return mHasDeadTrees; } 
    void addWLA(const float LA, const float LRI) { mAggregatedWLA += LA*LRI; mAggregatedLA += LA; }
    void addLR(const float LA, const float LightResponse) { mAggregatedLR += LA*LightResponse; }
    void calculateInterceptedArea();
    void addTreeAging(const double leaf_area, const double aging_factor) { mAverageAging += leaf_area*aging_factor; } 
    void addTreeAgingForAllTrees(); 
    // stocked area calculation
    void countStockedPixel(bool pixelIsStocked) { mPixelCount++; if (pixelIsStocked) mStockedPixelCount++; }
    void createStandStatistics(); 
    void recreateStandStatistics(bool recalculate_stats); 
    void setStockableArea(const double area) { mStockableArea = area; } 
    void setCreateDebugOutput(const bool do_dbg) { mCreateDebugOutput = do_dbg; } 
    bool shouldCreateDebugOutput() const { return mCreateDebugOutput; } 
 
    // snag / snag dynamics
    // snag dynamics, soil carbon and nitrogen cycle
    void snagNewYear() { if (snag()) snag()->newYear(); } 
    void calculateCarbonCycle(); 
    // model flow
    void newYear(); 
    // LIP/LIF-cylcle -> Model
    void production(); 
    void beforeGrow(); 
    // the growth of individuals -> Model
    void afterGrow(); 
    void yearEnd(); 
 
private:
    void updateSVDState(); 
    int mIndex; 
    int mID; 
    bool mHasDeadTrees; 
    Climate *mClimate; 
    SpeciesSet *mSpeciesSet; 
    WaterCycle *mWater; 
    Snag *mSnag; 
    Soil *mSoil; 
    QList<ResourceUnitSpecies*> mRUSpecies; 
    QVector<Tree> mTrees; 
    SaplingCell *mSaplings; 
    QRectF mBoundingBox; 
    QPoint mCornerOffset; 
    double mAggregatedLA; 
    double mAggregatedWLA; 
    double mAggregatedLR; 
    double mEffectiveArea; 
    double mEffectiveArea_perWLA; 
    double mLRI_modification;
    double mAverageAging; 
    float *mSaplingHeightMap; 
    struct RUSVDState {
        RUSVDState(): localComposition(0), midDistanceComposition(0) {}
        ~RUSVDState() { if (localComposition) {delete localComposition; delete midDistanceComposition; } }
        qint16 stateId; 
        qint16 previousStateId; 
        qint16 time; 
        qint16 previousTime; 
        QVector<float> *localComposition; 
        QVector<float> *midDistanceComposition; 
 
        void clear() { stateId=previousStateId=time=previousTime=0; }
    } mSVDState;
 
 
    int mPixelCount; 
    int mStockedPixelCount;  
    double mStockedArea; 
    double mStockableArea; 
    StandStatistics mStatistics; 
    ResourceUnitVariables mUnitVariables;
    bool mCreateDebugOutput; 
 
    friend class RUWrapper;
    friend class SVDStates;
    friend class SVDStateOut;
    friend class SVDIndicatorOut;
};
 
 
#endif // RESOURCEUNIT_H