PrognosticData.hpp

Go to the documentation of this file.

 
#ifndef PROGNOSTICDATA_HPP
#define PROGNOSTICDATA_HPP
 
#include "ModelComponent.hpp"
#include "include/Configured.hpp"
#include "include/IAtmosphereBoundary.hpp"
#include "include/IDynamics.hpp"
#include "include/IOceanBoundary.hpp"
#include "include/IceGrowth.hpp"
#include "include/Time.hpp"
 
namespace Nextsim {
 
class PrognosticData : public ModelComponent, public Configured<PrognosticData> {
public:
    PrognosticData();
    virtual ~PrognosticData() = default;
 
    void configure() override;
 
    std::string getName() const override { return "PrognosticData"; };
 
    void setData(const ModelState::DataMap& ms) override;
    ModelState getState() const override;
    ModelState getState(const OutputLevel& lvl) const override { return getState(); }
    ModelState getStateRecursive(const OutputSpec& os) const override;
 
    static HelpMap& getHelpText(HelpMap& map, bool getAll);
    static HelpMap& getHelpRecursive(HelpMap& map, bool getAll);
 
    std::unordered_set<std::string> hFields() const override
    {
        return { "h_ice", "c_cice", "h_snow" };
    };
    std::unordered_set<std::string> uFields() const override { return { "u" }; }
    std::unordered_set<std::string> vFields() const override { return { "v" }; }
    std::unordered_set<std::string> zFields() const override { return { "tice" }; }
 
    void update(const TimestepTime& tsTime);
 
    const HField& iceThickness() { return m_thick; }
 
    const HField& iceConcentration() { return m_conc; }
 
    const HField& snowThickness() { return m_snow; }
 
    const ZField& iceTemperature() { return m_tice; }
 
private:
    HField m_thick;
    HField m_conc;
    ZField m_tice;
    HField m_snow;
    double m_dt;
 
    IAtmosphereBoundary* pAtmBdy;
    IOceanBoundary* pOcnBdy;
    IDynamics* pDynamics;
    IceGrowth iceGrowth;
 
    void updatePrognosticFields();
};
 
} /* namespace Nextsim */
 
#endif /* PROGNOSTICDATA_HPP */