Domain.h

/*
 * (C) Copyright 2013 ECMWF.
 *
 * This software is licensed under the terms of the Apache Licence Version 2.0
 * which can be obtained at http://www.apache.org/licenses/LICENSE-2.0.
 * In applying this licence, ECMWF does not waive the privileges and immunities
 * granted to it by virtue of its status as an intergovernmental organisation
 * nor does it submit to any jurisdiction.
 */

#pragma once

#include <array>
#include <string>

#include "atlas/library/config.h"
#include "atlas/util/ObjectHandle.h"

//---------------------------------------------------------------------------------------------------------------------

// Forward declarations
namespace eckit {
class Parametrisation;
class Hash;
}  // namespace eckit

//---------------------------------------------------------------------------------------------------------------------

namespace atlas {
class PointXY;

namespace util {
class Config;
}  // namespace util

#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace domain {
class Domain;
class GlobalDomain;
class ZonalBandDomain;
class RectangularDomain;
class RectangularLonLatDomain;
}  // namespace domain
#endif

//---------------------------------------------------------------------------------------------------------------------

class Domain : DOXYGEN_HIDE( public util::ObjectHandle<atlas::domain::Domain> ) {
public:
    using Spec = util::Config;

public:
    using Handle::Handle;
    Domain() = default;
    Domain( const eckit::Parametrisation& );

    std::string type() const;

    bool contains( double x, double y ) const;

    bool contains( const PointXY& p ) const;

    // Specification of Domain
    Spec spec() const;

    bool global() const;

    bool empty() const;

    void hash( eckit::Hash& ) const;

    bool containsNorthPole() const;

    bool containsSouthPole() const;

    std::string units() const;

private:
    void print( std::ostream& ) const;

    friend std::ostream& operator<<( std::ostream& s, const Domain& d );
};

//---------------------------------------------------------------------------------------------------------------------

class RectangularDomain : public Domain {
public:
    using Interval = std::array<double, 2>;

public:
    using Domain::Domain;
    RectangularDomain() : Domain() {}
    RectangularDomain( const Interval& x, const Interval& y, const std::string& units = "degrees" );

    RectangularDomain( const Domain& );

    operator bool() const { return domain_; }

    bool contains_x( double x ) const;

    bool contains_y( double y ) const;

    bool zonal_band() const;

    double xmin() const;
    double xmax() const;
    double ymin() const;
    double ymax() const;

private:
    const ::atlas::domain::RectangularDomain* domain_;
};

//---------------------------------------------------------------------------------------------------------------------

class RectangularLonLatDomain : public RectangularDomain {
public:
    using RectangularDomain::RectangularDomain;
    RectangularLonLatDomain( const Interval& x, const Interval& y ) : RectangularDomain( x, y, "degrees" ) {}
    RectangularLonLatDomain( const double& north, const double& west, const double& south, const double& east ) :
        RectangularLonLatDomain( {west, east}, {south, north} ) {}

    operator bool() const { return RectangularDomain::operator bool() && units() == "degrees"; }

    double west() const { return xmin(); }
    double east() const { return xmax(); }
    double north() const { return ymax(); }
    double south() const { return ymin(); }
};

//---------------------------------------------------------------------------------------------------------------------

class ZonalBandDomain : public RectangularLonLatDomain {
public:
    using Interval = std::array<double, 2>;

public:
    using RectangularLonLatDomain::RectangularLonLatDomain;
    ZonalBandDomain( const Interval& y, const double& west );
    ZonalBandDomain( const Interval& y );
    ZonalBandDomain( const Domain& );

    operator bool() const { return domain_; }

private:
    const ::atlas::domain::ZonalBandDomain* domain_;
};

//---------------------------------------------------------------------------------------------------------------------

class GlobalDomain : public ZonalBandDomain {
public:
    GlobalDomain( const double& west );
    GlobalDomain();
    GlobalDomain( const Domain& );

    operator bool() const { return domain_; }

private:
    const ::atlas::domain::GlobalDomain* domain_;
};

//---------------------------------------------------------------------------------------------------------------------

}  // namespace atlas