Elements.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 "atlas/array/ArrayView.h"
#include "atlas/array/IndexView.h"
#include "atlas/mesh/Connectivity.h"
#include "atlas/mesh/HybridElements.h"
#include "atlas/util/Object.h"

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

namespace atlas {
namespace mesh {

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

class Elements : public util::Object {
public:
    //-- Constructors

    Elements( HybridElements& elements, idx_t type_idx );

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

    Elements( ElementType*, idx_t nb_elements, const idx_t node_connectivity[], bool fortran_array = false );

    virtual ~Elements();

    //-- Accessors

    idx_t size() const;

    const std::string& name() const;

    idx_t nb_nodes() const;

    idx_t nb_edges() const;

    const BlockConnectivity& node_connectivity() const;
    BlockConnectivity& node_connectivity();

    const BlockConnectivity& edge_connectivity() const;
    BlockConnectivity& edge_connectivity();

    const BlockConnectivity& cell_connectivity() const;
    BlockConnectivity& cell_connectivity();

    const ElementType& element_type() const;

    //  const HybridElements& hybrid_elements() const;

    //  idx_t type_idx() const;

    idx_t begin() const;

    idx_t end() const;

    const Field& field( const std::string& name ) const { return hybrid_elements_->field( name ); }
    Field& field( const std::string& name ) { return hybrid_elements_->field( name ); }
    bool has_field( const std::string& name ) const { return hybrid_elements_->has_field( name ); }

    const Field& field( idx_t idx ) const { return hybrid_elements_->field( idx ); }
    Field& field( idx_t idx ) { return hybrid_elements_->field( idx ); }
    idx_t nb_fields() const { return hybrid_elements_->nb_fields(); }

    const Field& global_index() const { return hybrid_elements_->global_index(); }
    Field& global_index() { return hybrid_elements_->global_index(); }

    const Field& remote_index() const { return hybrid_elements_->remote_index(); }
    Field& remote_index() { return hybrid_elements_->remote_index(); }

    const Field& partition() const { return hybrid_elements_->partition(); }
    Field& partition() { return hybrid_elements_->partition(); }

    const Field& halo() const { return hybrid_elements_->halo(); }
    Field& halo() { return hybrid_elements_->halo(); }

    const Field& flags() const { return hybrid_elements_->flags(); }
    Field& flags() { return hybrid_elements_->flags(); }

    template <typename DATATYPE, int RANK>
    array::LocalView<const DATATYPE, RANK> view( const Field& ) const;

    template <typename DATATYPE, int RANK>
    array::LocalView<DATATYPE, RANK> view( Field& ) const;

    template <typename DATATYPE, int RANK>
    array::LocalIndexView<DATATYPE, RANK> indexview( const Field& ) const;

    template <typename DATATYPE, int RANK>
    array::LocalIndexView<DATATYPE, RANK> indexview( Field& ) const;

    idx_t add( const idx_t nb_elements );

private:
    friend class HybridElements;
    void rebuild();

private:
    bool owns_;
    HybridElements* hybrid_elements_;
    idx_t size_;
    idx_t begin_;
    idx_t end_;
    idx_t type_idx_;
    idx_t nb_nodes_;
    idx_t nb_edges_;
};

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

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

inline idx_t Elements::nb_nodes() const {
    return nb_nodes_;
}

inline idx_t Elements::nb_edges() const {
    return nb_edges_;
}

// inline idx_t Elements::type_idx() const
//{
//  return type_idx_;
//}

// inline const HybridElements& Elements::hybrid_elements() const
//{
//  return *hybrid_elements_;
//}

inline const BlockConnectivity& Elements::node_connectivity() const {
    if ( hybrid_elements_->node_connectivity().blocks() ) {
        return hybrid_elements_->node_connectivity().block( type_idx_ );
    }
    else {
        static BlockConnectivity dummy;
        return dummy;
    }
}

inline BlockConnectivity& Elements::node_connectivity() {
    if ( hybrid_elements_->node_connectivity().blocks() ) {
        return hybrid_elements_->node_connectivity().block( type_idx_ );
    }
    else {
        static BlockConnectivity dummy;
        return dummy;
    }
}

inline const BlockConnectivity& Elements::edge_connectivity() const {
    if ( hybrid_elements_->edge_connectivity().blocks() ) {
        return hybrid_elements_->edge_connectivity().block( type_idx_ );
    }
    else {
        static BlockConnectivity dummy;
        return dummy;
    }
}

inline BlockConnectivity& Elements::edge_connectivity() {
    if ( hybrid_elements_->edge_connectivity().blocks() ) {
        return hybrid_elements_->edge_connectivity().block( type_idx_ );
    }
    else {
        static BlockConnectivity dummy;
        return dummy;
    }
}

inline const BlockConnectivity& Elements::cell_connectivity() const {
    if ( hybrid_elements_->cell_connectivity().blocks() ) {
        return hybrid_elements_->cell_connectivity().block( type_idx_ );
    }
    else {
        static BlockConnectivity dummy;
        return dummy;
    }
}

inline BlockConnectivity& Elements::cell_connectivity() {
    if ( hybrid_elements_->cell_connectivity().blocks() ) {
        return hybrid_elements_->cell_connectivity().block( type_idx_ );
    }
    else {
        static BlockConnectivity dummy;
        return dummy;
    }
}

inline const ElementType& Elements::element_type() const {
    return hybrid_elements_->element_type( type_idx_ );
}

inline idx_t Elements::begin() const {
    return begin_;
}

inline idx_t Elements::end() const {
    return end_;
}

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

extern "C" {
void atlas__mesh__Elements__delete( Elements* This );
idx_t atlas__mesh__Elements__size( const Elements* This );
idx_t atlas__mesh__Elements__begin( const Elements* This );
idx_t atlas__mesh__Elements__end( const Elements* This );
BlockConnectivity* atlas__mesh__Elements__node_connectivity( Elements* This );
BlockConnectivity* atlas__mesh__Elements__edge_connectivity( Elements* This );
BlockConnectivity* atlas__mesh__Elements__cell_connectivity( Elements* This );
int atlas__mesh__Elements__has_field( const Elements* This, char* name );
int atlas__mesh__Elements__nb_fields( const Elements* This );
field::FieldImpl* atlas__mesh__Elements__field_by_idx( Elements* This, idx_t idx );
field::FieldImpl* atlas__mesh__Elements__field_by_name( Elements* This, char* name );
field::FieldImpl* atlas__mesh__Elements__global_index( Elements* This );
field::FieldImpl* atlas__mesh__Elements__remote_index( Elements* This );
field::FieldImpl* atlas__mesh__Elements__partition( Elements* This );
field::FieldImpl* atlas__mesh__Elements__halo( Elements* This );
const ElementType* atlas__mesh__Elements__element_type( const Elements* This );
void atlas__mesh__Elements__add( Elements* This, idx_t nb_elements );
}

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

}  // namespace mesh
}  // namespace atlas