FieldImpl.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 <functional>
#include <string>
#include <vector>

#include "atlas/util/Object.h"

#include "atlas/array.h"
#include "atlas/array/ArrayUtil.h"
#include "atlas/array/DataType.h"
#include "atlas/util/Metadata.h"

namespace eckit {
class Parametrisation;
}

namespace atlas {
class FunctionSpace;
}  // namespace atlas

namespace atlas {
namespace field {

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

class FieldImpl : public util::Object {
public:  // Static methods
    static FieldImpl* create( const eckit::Parametrisation& );

    static FieldImpl* create( const std::string& name, array::DataType,
                              const array::ArrayShape& = array::ArrayShape() );

    static FieldImpl* create( const std::string& name, array::DataType, array::ArraySpec&& );

    template <typename DATATYPE>
    static FieldImpl* create( const std::string& name, const array::ArrayShape& = array::ArrayShape() );

    static FieldImpl* create( const std::string& name, array::Array* );

    template <typename DATATYPE>
    static FieldImpl* wrap( const std::string& name, DATATYPE* data, const array::ArraySpec& );

    template <typename DATATYPE>
    static FieldImpl* wrap( const std::string& name, DATATYPE* data, const array::ArrayShape& );

private:  // Private constructors to force use of static create functions
    FieldImpl( const std::string& name, array::DataType, const array::ArrayShape& );

    FieldImpl( const std::string& name, array::DataType, array::ArraySpec&& );

    FieldImpl( const std::string& name, array::Array* );

public:  // Destructor
    virtual ~FieldImpl();

    // -- Conversion

    operator const array::Array&() const { return *array_; }
    operator array::Array&() { return *array_; }

    const array::Array& array() const { return *array_; }
    array::Array& array() { return *array_; }

    // -- Accessors

    void* storage() { return array_->storage(); }

    array::DataType datatype() const { return array_->datatype(); }

    const std::string& name() const;

    void rename( const std::string& name ) { metadata().set( "name", name ); }

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

    void resize( const array::ArrayShape& );

    void insert( idx_t idx1, idx_t size1 );

    const std::vector<int>& shapef() const { return array_->shapef(); }

    const std::vector<int>& stridesf() const { return array_->stridesf(); }

    const array::ArrayShape& shape() const { return array_->shape(); }

    const array::ArrayStrides& strides() const { return array_->strides(); }

    idx_t shape( idx_t i ) const { return array_->shape( i ); }

    idx_t stride( idx_t i ) const { return array_->stride( i ); }

    size_t size() const { return array_->size(); }

    idx_t rank() const { return array_->rank(); }

    size_t bytes() const { return array_->bytes(); }

    friend std::ostream& operator<<( std::ostream& os, const FieldImpl& v );

    void dump( std::ostream& os ) const;

    void set_levels( idx_t n ) { metadata().set( "levels", n ); }
    void set_variables( idx_t n ) { metadata().set( "variables", n ); }
    idx_t levels() const { return metadata().get<idx_t>( "levels" ); }
    idx_t variables() const { return metadata().get<idx_t>( "variables" ); }

    void set_functionspace( const FunctionSpace& );
    const FunctionSpace& functionspace() const;

    size_t footprint() const;

    bool dirty() const;

    void set_dirty( bool = true ) const;

    // -- dangerous methods
    template <typename DATATYPE>
    DATATYPE const* host_data() const {
        return array_->host_data<DATATYPE>();
    }
    template <typename DATATYPE>
    DATATYPE* host_data() {
        return array_->host_data<DATATYPE>();
    }
    template <typename DATATYPE>
    DATATYPE const* device_data() const {
        return array_->device_data<DATATYPE>();
    }
    template <typename DATATYPE>
    DATATYPE* device_data() {
        return array_->device_data<DATATYPE>();
    }
    template <typename DATATYPE>
    DATATYPE const* data() const {
        return array_->host_data<DATATYPE>();
    }
    template <typename DATATYPE>
    DATATYPE* data() {
        return array_->host_data<DATATYPE>();
    }

    // -- Methods related to host-device synchronisation, requires
    // gridtools_storage
    void updateHost() const { array_->updateHost(); }
    void updateDevice() const { array_->updateDevice(); }
    void syncHostDevice() const { array_->syncHostDevice(); }
    bool hostNeedsUpdate() const { return array_->hostNeedsUpdate(); }
    bool deviceNeedsUpdate() const { return array_->deviceNeedsUpdate(); }
    void reactivateDeviceWriteViews() const { array_->reactivateDeviceWriteViews(); }
    void reactivateHostWriteViews() const { array_->reactivateHostWriteViews(); }

    void haloExchange( bool on_device = false ) const;
    void adjointHaloExchange( bool on_device = false ) const;


    void callbackOnDestruction( std::function<void()>&& f ) { callback_on_destruction_.emplace_back( std::move( f ) ); }

private:  // methods
    void print( std::ostream& os, bool dump = false ) const;

private:  // members
    mutable std::string name_;
    util::Metadata metadata_;
    array::Array* array_;
    FunctionSpace* functionspace_;
    std::vector<std::function<void()>> callback_on_destruction_;
};

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

template <typename DATATYPE>
FieldImpl* FieldImpl::create( const std::string& name, const array::ArrayShape& shape ) {
    return create( name, array::DataType::create<DATATYPE>(), shape );
}

template <typename DATATYPE>
FieldImpl* FieldImpl::wrap( const std::string& name, DATATYPE* data, const array::ArraySpec& spec ) {
    FieldImpl* wrapped = create( name, array::Array::wrap( data, spec ) );
    wrapped->set_dirty( false );
    return wrapped;
}

template <typename DATATYPE>
FieldImpl* FieldImpl::wrap( const std::string& name, DATATYPE* data, const array::ArrayShape& shape ) {
    FieldImpl* wrapped = create( name, array::Array::wrap( data, shape ) );
    wrapped->set_dirty( false );
    return wrapped;
}

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

}  // namespace field
}  // namespace atlas