Unstructured.h

Go to the documentation of this file.

/*
 * (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 <cstddef>
#include <memory>
#include <vector>

#include "atlas/grid/detail/grid/Grid.h"
#include "atlas/runtime/Exception.h"
#include "atlas/util/Point.h"

namespace atlas {
class Mesh;
}

namespace atlas {
namespace grid {
namespace detail {
namespace grid {

class Unstructured : public Grid {
private:
    struct ComputePointXY {
        void update_value( idx_t n ) {}
        void compute_value( idx_t n, PointXY& point ) { grid_.xy( n, point.data() ); }
        const PointXY& get_reference( idx_t n ) const { return grid_.xy( n ); }

        ComputePointXY( const Unstructured& grid ) : grid_( grid ) {}
        const Unstructured& grid_;
    };

    struct ComputePointLonLat {
        void update_value( idx_t n ) {
            if ( n < size_ ) {
                grid_.lonlat( n, point_.data() );
            }
        }
        void compute_value( idx_t n, PointLonLat& point ) { grid_.lonlat( n, point.data() ); }
        const PointLonLat& get_reference( idx_t n ) const { return point_; }

        ComputePointLonLat( const Unstructured& grid ) : grid_( grid ), size_( grid_.size() ) {}
        const Unstructured& grid_;
        idx_t size_;
        PointLonLat point_;
    };

    template <typename Base, typename ComputePoint>
    class UnstructuredIterator : public Base {
    public:
        UnstructuredIterator( const Unstructured& grid, bool begin = true ) :
            grid_( grid ),
            size_( static_cast<idx_t>( grid_.points_->size() ) ),
            n_( begin ? 0 : size_ ),
            point_computer_{grid_} {
            point_computer_.update_value( n_ );
        }

        virtual bool next( typename Base::value_type& point ) {
            if ( n_ < size_ ) {
                point_computer_.compute_value( n_, point );
                ++n_;
                return true;
            }
            else {
                return false;
            }
        }

        virtual typename Base::reference operator*() const { return point_computer_.get_reference( n_ ); }

        virtual const Base& operator++() {
            ++n_;
            point_computer_.update_value( n_ );
            return *this;
        }


        virtual const Base& operator+=( typename Base::difference_type distance ) {
            n_ += distance;
            point_computer_.update_value( n_ );
            return *this;
        }

        virtual bool operator==( const Base& other ) const {
            return n_ == static_cast<const UnstructuredIterator&>( other ).n_;
        }

        virtual bool operator!=( const Base& other ) const {
            return n_ != static_cast<const UnstructuredIterator&>( other ).n_;
        }

        virtual typename Base::difference_type distance( const Base& other ) const {
            const auto& _other = static_cast<const UnstructuredIterator&>( other );
            return _other.n_ - n_;
        }

        virtual std::unique_ptr<Base> clone() const {
            auto result = new UnstructuredIterator( grid_, false );
            result->n_  = n_;
            result->point_computer_.update_value( n_ );
            return std::unique_ptr<Base>( result );
        }

    protected:
        const Unstructured& grid_;
        idx_t size_;
        idx_t n_;
        ComputePoint point_computer_;
    };

public:
    using IteratorXY     = UnstructuredIterator<Grid::IteratorXY, ComputePointXY>;
    using IteratorLonLat = UnstructuredIterator<Grid::IteratorLonLat, ComputePointLonLat>;

public:  // methods
    static std::string static_type() { return "unstructured"; }
    virtual std::string name() const override;
    virtual std::string type() const override { return static_type(); }

    Unstructured( const Grid&, Domain );

    Unstructured( const Config& );

    Unstructured( std::vector<PointXY>* pts );

    Unstructured( std::vector<PointXY>&& pts );

    Unstructured( const std::vector<PointXY>& pts );

    Unstructured( const Mesh& m );

    Unstructured( std::initializer_list<PointXY> );

    virtual ~Unstructured() override;

    virtual idx_t size() const override;

    virtual Spec spec() const override;

    const PointXY& xy( idx_t n ) const { return ( *points_ )[n]; }

    PointLonLat lonlat( idx_t n ) const { return projection_.lonlat( ( *points_ )[n] ); }

    void xy( idx_t n, double crd[] ) const {
        PointXY& p = ( *points_ )[n];
        crd[0]     = p[0];
        crd[1]     = p[1];
    }

    void lonlat( idx_t n, double crd[] ) const {
        xy( n, crd );
        projection_.xy2lonlat( crd );
    }

    virtual std::unique_ptr<Grid::IteratorXY> xy_begin() const override {
        return std::unique_ptr<Grid::IteratorXY>( new IteratorXY( *this ) );
    }
    virtual std::unique_ptr<Grid::IteratorXY> xy_end() const override {
        return std::unique_ptr<Grid::IteratorXY>( new IteratorXY( *this, false ) );
    }
    virtual std::unique_ptr<Grid::IteratorLonLat> lonlat_begin() const override {
        return std::unique_ptr<Grid::IteratorLonLat>( new IteratorLonLat( *this ) );
    }
    virtual std::unique_ptr<Grid::IteratorLonLat> lonlat_end() const override {
        return std::unique_ptr<Grid::IteratorLonLat>( new IteratorLonLat( *this, false ) );
    }

    Config meshgenerator() const override;
    Config partitioner() const override;

private:  // methods
    virtual void print( std::ostream& ) const override;

    virtual void hash( eckit::Hash& ) const override;

    virtual RectangularLonLatDomain lonlatBoundingBox() const override;

protected:
    std::unique_ptr<std::vector<PointXY>> points_;

    mutable std::string shortName_;

    mutable std::unique_ptr<Grid::Spec> cached_spec_;
};

extern "C" {
const Unstructured* atlas__grid__Unstructured__points( const double lonlat[], int shapef[], int stridesf[] );
const Unstructured* atlas__grid__Unstructured__config( util::Config* conf );
}


}  // namespace grid
}  // namespace detail
}  // namespace grid
}  // namespace atlas