HybridElements.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 <map>

#include "atlas/util/Object.h"
#include "atlas/util/ObjectHandle.h"

#include "atlas/field/Field.h"
#include "atlas/util/Metadata.h"

#include "atlas/mesh/Connectivity.h"

namespace atlas {
namespace field {
class FieldImpl;
}
}  // namespace atlas

namespace atlas {
class Mesh;
}
namespace atlas {
namespace mesh {
class ElementType;
}
}  // namespace atlas
namespace atlas {
namespace mesh {
class Elements;
}
}  // namespace atlas

namespace atlas {
namespace mesh {
template <class T>
class ConnectivityInterface;
class MultiBlockConnectivityImpl;
using MultiBlockConnectivity = ConnectivityInterface<MultiBlockConnectivityImpl>;
}  // namespace mesh
}  // namespace atlas

namespace atlas {
namespace mesh {

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

class HybridElements : public util::Object {
    friend class Elements;

public:
    typedef MultiBlockConnectivity Connectivity;

public:  // methods
         //-- Constructors
    HybridElements();
    virtual ~HybridElements();

    //-- Accessors

    idx_t size() const;

    idx_t nb_nodes( idx_t elem_idx ) const;

    idx_t nb_edges( idx_t elem_idx ) const;

    idx_t type_idx( idx_t elem_idx ) const;

    const std::string& name( idx_t elem_idx ) const;

    const HybridElements::Connectivity& node_connectivity() const;
    HybridElements::Connectivity& node_connectivity();

    const HybridElements::Connectivity& edge_connectivity() const;
    HybridElements::Connectivity& edge_connectivity();

    const HybridElements::Connectivity& cell_connectivity() const;
    HybridElements::Connectivity& cell_connectivity();

    idx_t nb_types() const;

    const ElementType& element_type( idx_t type_idx ) const;

    const Elements& elements( idx_t type_idx ) const;
    Elements& elements( idx_t type_idx );

    const Field& field( const std::string& name ) const;
    Field& field( const std::string& name );
    bool has_field( const std::string& name ) const { return ( fields_.find( name ) != fields_.end() ); }

    const Field& field( idx_t ) const;
    Field& field( idx_t );
    idx_t nb_fields() const { return static_cast<idx_t>( fields_.size() ); }

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

    const Field& global_index() const { return field( "glb_idx" ); }
    Field& global_index() { return field( "glb_idx" ); }

    const Field& remote_index() const { return field( "remote_idx" ); }
    Field& remote_index() { return field( "remote_idx" ); }

    const Field& partition() const { return field( "partition" ); }
    Field& partition() { return field( "partition" ); }

    const Field& halo() const { return field( "halo" ); }
    Field& halo() { return field( "halo" ); }

    const Field& flags() const { return field( "flags" ); }
    Field& flags() { return field( "flags" ); }

    // -- Modifiers

    idx_t add( const ElementType*, idx_t nb_elements );

    idx_t add( const ElementType*, idx_t nb_elements, const std::vector<idx_t>& node_connectivity );

    idx_t add( const ElementType*, idx_t nb_elements, const idx_t node_connectivity[] );

    idx_t add( const ElementType*, idx_t nb_elements, const idx_t node_connectivity[], bool fortran_array );

    idx_t add( const Elements& );

    Field add( const Field& field );

    void remove_field( const std::string& name );

    void insert( idx_t type_idx, idx_t position, idx_t nb_elements = 1 );

    void updateDevice() const;

    void updateHost() const;

    void syncHostDevice() const;

    void clear();

    size_t footprint() const;

private:  // -- types
    typedef std::map<std::string, Field> FieldMap;
    typedef std::map<std::string, util::ObjectHandle<Connectivity>> ConnectivityMap;

private:  // -- methods
    void resize( idx_t size );

    idx_t elemtype_nb_nodes( idx_t elem_idx ) const;
    idx_t elemtype_nb_edges( idx_t elem_idx ) const;

    Connectivity& add( Connectivity* );

private:  // -- Data
          // -- Total number of elements
    idx_t size_;

    // -- Data: one value per type
    std::vector<idx_t> elements_size_;
    std::vector<idx_t> elements_begin_;
    std::vector<util::ObjectHandle<const ElementType>> element_types_;

    // -- Data: one value per element
    std::vector<idx_t> type_idx_;

    // -- Sub elements
    std::vector<util::ObjectHandle<Elements>> elements_;

    // -- Fields and connectivities
    FieldMap fields_;
    ConnectivityMap connectivities_;

    // -- Metadata
    util::Metadata metadata_;

    // -- Cached shortcuts to specific connectivities in connectivities_
    Connectivity* node_connectivity_;
    Connectivity* edge_connectivity_;
    Connectivity* cell_connectivity_;
};

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

inline idx_t HybridElements::size() const {
    return size_;
}

inline idx_t HybridElements::nb_types() const {
    return static_cast<idx_t>( element_types_.size() );
}

inline const ElementType& HybridElements::element_type( idx_t type_idx ) const {
    return *element_types_[type_idx].get();
}

inline const HybridElements::Connectivity& HybridElements::node_connectivity() const {
    return *node_connectivity_;
}

inline HybridElements::Connectivity& HybridElements::node_connectivity() {
    return *node_connectivity_;
}

inline const HybridElements::Connectivity& HybridElements::edge_connectivity() const {
    return *edge_connectivity_;
}

inline HybridElements::Connectivity& HybridElements::edge_connectivity() {
    return *edge_connectivity_;
}

inline const HybridElements::Connectivity& HybridElements::cell_connectivity() const {
    return *cell_connectivity_;
}

inline HybridElements::Connectivity& HybridElements::cell_connectivity() {
    return *cell_connectivity_;
}

inline const Elements& HybridElements::elements( idx_t type_idx ) const {
    return *elements_[type_idx].get();
}

inline Elements& HybridElements::elements( idx_t type_idx ) {
    return *elements_[type_idx].get();
}

inline idx_t HybridElements::nb_nodes( idx_t elem_idx ) const {
    return node_connectivity_->rows() ? node_connectivity_->cols( elem_idx ) : elemtype_nb_nodes( elem_idx );
}

inline idx_t HybridElements::nb_edges( idx_t elem_idx ) const {
    return edge_connectivity_->rows() ? edge_connectivity_->cols( elem_idx ) : elemtype_nb_edges( elem_idx );
}

inline idx_t HybridElements::type_idx( idx_t elem_idx ) const {
    return type_idx_[elem_idx];
}

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

extern "C" {
HybridElements* atlas__mesh__HybridElements__create();
void atlas__mesh__HybridElements__delete( HybridElements* This );
MultiBlockConnectivity* atlas__mesh__HybridElements__node_connectivity( HybridElements* This );
MultiBlockConnectivity* atlas__mesh__HybridElements__edge_connectivity( HybridElements* This );
MultiBlockConnectivity* atlas__mesh__HybridElements__cell_connectivity( HybridElements* This );

idx_t atlas__mesh__HybridElements__size( const HybridElements* This );
void atlas__mesh__HybridElements__add_elements( HybridElements* This, ElementType* elementtype, idx_t nb_elements );
void atlas__mesh__HybridElements__add_elements_with_nodes( HybridElements* This, ElementType* elementtype,
                                                           idx_t nb_elements, idx_t node_connectivity[],
                                                           int fortran_array );
void atlas__mesh__HybridElements__add_field( HybridElements* This, field::FieldImpl* field );
int atlas__mesh__HybridElements__has_field( const HybridElements* This, char* name );
int atlas__mesh__HybridElements__nb_fields( const HybridElements* This );
int atlas__mesh__HybridElements__nb_types( const HybridElements* This );
field::FieldImpl* atlas__mesh__HybridElements__field_by_name( HybridElements* This, char* name );
field::FieldImpl* atlas__mesh__HybridElements__field_by_idx( HybridElements* This, idx_t idx );
field::FieldImpl* atlas__mesh__HybridElements__global_index( HybridElements* This );
field::FieldImpl* atlas__mesh__HybridElements__remote_index( HybridElements* This );
field::FieldImpl* atlas__mesh__HybridElements__partition( HybridElements* This );
field::FieldImpl* atlas__mesh__HybridElements__halo( HybridElements* This );

Elements* atlas__mesh__HybridElements__elements( HybridElements* This, idx_t idx );
}

}  // namespace mesh
}  // namespace atlas