MeshImpl.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 <iosfwd>
#include <memory>

#include "atlas/grid/Grid.h"
#include "atlas/mesh/PartitionPolygon.h"
#include "atlas/mesh/detail/PartitionGraph.h"
#include "atlas/projection/Projection.h"
#include "atlas/util/Metadata.h"
#include "atlas/util/Object.h"
#include "atlas/util/ObjectHandle.h"

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

namespace eckit {
class Stream;
}

namespace atlas {
namespace util {
class PartitionPolygons;
}
class Mesh;
namespace mesh {
class PartitionPolygon;
class Nodes;
class HybridElements;
typedef HybridElements Edges;
typedef HybridElements Cells;
}  // namespace mesh
}  // namespace atlas

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

namespace atlas {
namespace mesh {
namespace detail {

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

class MeshObserver;

class MeshImpl : public util::Object {
public:  // methods
    explicit MeshImpl();

    explicit MeshImpl( eckit::Stream& );

    void encode( eckit::Stream& s ) const;

    ~MeshImpl();

    util::Metadata& metadata() { return metadata_; }
    const util::Metadata& metadata() const { return metadata_; }

    void print( std::ostream& ) const;

    const Nodes& nodes() const { return *nodes_; }
    Nodes& nodes() { return *nodes_; }

    const Cells& cells() const { return *cells_; }
    Cells& cells() { return *cells_; }

    const Edges& edges() const { return *edges_; }
    Edges& edges() { return *edges_; }

    const HybridElements& facets() const { return *facets_; }
    HybridElements& facets() { return *facets_; }

    const HybridElements& ridges() const { return *ridges_; }
    HybridElements& ridges() { return *ridges_; }

    const HybridElements& peaks() const { return *peaks_; }
    HybridElements& peaks() { return *peaks_; }

    bool generated() const;

    size_t footprint() const;

    idx_t partition() const;
    idx_t nb_partitions() const;

    void updateDevice() const;

    void updateHost() const;

    void syncHostDevice() const;

    const Projection& projection() const { return projection_; }

    const PartitionGraph& partitionGraph() const;

    PartitionGraph::Neighbours nearestNeighbourPartitions() const;

    const PartitionPolygon& polygon( idx_t halo = 0 ) const;
    const util::PartitionPolygons& polygons() const;

    const Grid grid() const { return grid_; }

    void attachObserver( MeshObserver& ) const;
    void detachObserver( MeshObserver& ) const;

private:  // methods
    friend class ::atlas::Mesh;

    friend std::ostream& operator<<( std::ostream& s, const MeshImpl& p ) {
        p.print( s );
        return s;
    }

    void createElements();

    void setProjection( const Projection& );
    void setGrid( const Grid& );

private:  // members
    util::Metadata metadata_;

    util::ObjectHandle<Nodes> nodes_;
    // dimensionality : 2D | 3D
    //                  --------
    util::ObjectHandle<HybridElements> cells_;   //                  2D | 3D
    util::ObjectHandle<HybridElements> facets_;  //                  1D | 2D
    util::ObjectHandle<HybridElements> ridges_;  //                  0D | 1D
    util::ObjectHandle<HybridElements> peaks_;   //                  NA | 0D

    util::ObjectHandle<HybridElements> edges_;  // alias to facets of 2D mesh, ridges of 3D mesh

    idx_t dimensionality_;

    Projection projection_;

    Grid grid_;

    mutable util::ObjectHandle<PartitionGraph> partition_graph_;

    mutable std::vector<util::ObjectHandle<PartitionPolygon>> polygons_;

    mutable util::PartitionPolygons all_polygons_;  // from all partitions

    mutable std::vector<MeshObserver*> mesh_observers_;
};

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

class MeshObserver {
private:
    std::vector<const MeshImpl*> registered_meshes_;

public:
    void registerMesh( const MeshImpl& mesh ) {
        if ( std::find( registered_meshes_.begin(), registered_meshes_.end(), &mesh ) == registered_meshes_.end() ) {
            registered_meshes_.push_back( &mesh );
            mesh.attachObserver( *this );
        }
    }
    void unregisterMesh( const MeshImpl& mesh ) {
        auto found = std::find( registered_meshes_.begin(), registered_meshes_.end(), &mesh );
        if ( found != registered_meshes_.end() ) {
            registered_meshes_.erase( found );
            mesh.detachObserver( *this );
        }
    }
    virtual ~MeshObserver() {
        for ( auto mesh : registered_meshes_ ) {
            mesh->detachObserver( *this );
        }
    }

    virtual void onMeshDestruction( MeshImpl& ) = 0;
};

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

}  // namespace detail
}  // namespace mesh
}  // namespace atlas