RectangularGrid.hpp

Go to the documentation of this file.

 
#ifndef RECTANGULARGRID_HPP
#define RECTANGULARGRID_HPP
 
#include "IStructure.hpp"
 
#include "include/ModelMetadata.hpp"
#include "include/ModelState.hpp"
 
namespace Nextsim {
 
class RectGridIO;
 
class RectangularGrid : public IStructure {
public:
    struct GridDimensions {
        int nx;
        int ny;
        int nz;
    };
 
    RectangularGrid()
        : pio(nullptr)
        , nx(0)
        , ny(0)
        , nz(0)
    {
    }
 
    RectangularGrid(const GridDimensions& dims)
        : pio(nullptr)
    {
        setDimensions(dims);
    }
 
    virtual ~RectangularGrid()
    {
        if (pio) {
            delete pio;
        }
    }
 
    // Read/write override functions
    ModelState getModelState(const std::string& filePath) override
    {
        return pio ? pio->getModelState(filePath) : ModelState();
    }
 
    void dumpModelState(
        const ModelState& state, const ModelMetadata& metadata, const std::string& filePath, bool isRestart = false) const override
    {
        if (pio)
            pio->dumpModelState(state, metadata, filePath, isRestart);
    }
    const std::string& structureType() const override { return structureName; };
 
    int nIceLayers() const override { return nz; };
 
    void setDimensions(const GridDimensions& dims)
    {
        nx = dims.nx;
        ny = dims.ny;
        nz = dims.nz;
    }
 
    class IRectGridIO {
    public:
        IRectGridIO(RectangularGrid& grid)
            : grid(&grid)
        {
        }
        virtual ~IRectGridIO() = default;
 
        virtual ModelState getModelState(const std::string& filePath) = 0;
 
        virtual void dumpModelState(
            const ModelState& state, const ModelMetadata& metadata, const std::string& filePath, bool isRestart) const = 0;
 
    protected:
        IRectGridIO() = default;
 
    private:
        RectangularGrid* grid;
    };
 
    void setIO(IRectGridIO* p) { pio = p; }
 
    const static std::string structureName;
 
private:
    int nx;
    int ny;
    int nz; // Number of ice layers
 
    const static std::string xDimName;
    const static std::string yDimName;
    const static std::string nIceLayersName;
 
    IRectGridIO* pio;
 
    friend RectGridIO;
};
 
} /* namespace Nextsim */
 
#endif /* RECTANGULARGRID_HPP */