speciesset.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 SPECIESSET_H
#define SPECIESSET_H
#include <QtSql>
 
#include "stampcontainer.h"
#include "expression.h"
class Species;
class SeedDispersal;
 
class SpeciesSet
{
public:
    SpeciesSet();
    ~SpeciesSet();
    const QString &name() const { return mName; } 
    // access
    QList<Species*> activeSpecies() const { return mActiveSpecies; } 
    Species *species(const QString &speciesId) const { return mSpecies.value(speciesId); }
    const Species *species(const int &index); 
    const StampContainer &readerStamps() { return mReaderStamp; }
    bool hasVar(const QString& varName); 
    QVariant var(const QString& varName); 
    int count() const { return mSpecies.count(); }
    void randomSpeciesOrder(QVector<int>::const_iterator &rBegin, QVector<int>::const_iterator &rEnd);
    // properties
    // calculations
    double nitrogenResponse(const double availableNitrogen, const double &responseClass) const;
    double co2Response(const double ambientCO2, const double nitrogenResponse, const double soilWaterResponse) const;
    double lightResponse(const double lightResourceIndex, const double lightResponseClass) const;
    double LRIcorrection(const double lightResourceIndex, const double relativeHeight) const  { return mLRICorrection.calculate(lightResourceIndex, relativeHeight);}
    // maintenance
    void clear();
    int setup();
    void setupRegeneration(); 
    // running
    void newYear(); 
    void regeneration(); 
    void clearSaplingSeedMap(); 
private:
    QString mName;
    double nitrogenResponse(const double &availableNitrogen, const double &NA, const double &NB) const;
    void createRandomSpeciesOrder();
    QList<Species*> mActiveSpecies; 
    QMap<QString, Species*> mSpecies;
    static const int mNRandomSets = 20;
    QVector<int> mRandomSpeciesOrder;
    QSqlQuery *mSetupQuery;
    StampContainer mReaderStamp;
    // nitrogen response classes
    double mNitrogen_1a, mNitrogen_1b; 
    double mNitrogen_2a, mNitrogen_2b; 
    double mNitrogen_3a, mNitrogen_3b; 
    // CO2 response
    double mCO2base, mCO2comp; 
    double mCO2p0, mCO2beta0; 
    // Light Response classes
    Expression mLightResponseIntolerant; 
    Expression mLightResponseTolerant; 
    Expression mLRICorrection; 
 
};
 
#endif // SPECIESSET_H