nc_interface.H

Go to the documentation of this file.

#ifndef NC_INTERFACE_H
#define NC_INTERFACE_H
 
#ifdef AMR_WIND_USE_NETCDF
#include <string>
#include <unordered_map>
#include <vector>
 
#include "netcdf.h"
#include "netcdf_par.h"
#include "AMReX_REAL.H"
 
using namespace amrex::literals;
 
namespace ncutils {

struct NCDType
{
    static constexpr nc_type Int = NC_INT;
#ifdef AMREX_USE_FLOAT
    static constexpr nc_type Real = NC_FLOAT;
#else
    static constexpr nc_type Real = NC_DOUBLE;
#endif
};

struct NCDim
{
    const int ncid;

    const int dimid;

    std::string name() const;

    size_t len() const;
};

struct NCVar
{
    const int ncid;

    const int varid;

    std::string name() const;

    int ndim() const;

    std::vector<size_t> shape() const;

    void put(const amrex::Real* /*ptr*/) const;
    void put(const float* /*ptr*/) const;
    void put(const int* /*ptr*/) const;

    void
    put(const amrex::Real* /*dptr*/,
        const std::vector<size_t>& /*start*/,
        const std::vector<size_t>& /*count*/) const;

    void
    put(const amrex::Real* /*dptr*/,
        const std::vector<size_t>& /*start*/,
        const std::vector<size_t>& /*count*/,
        const std::vector<ptrdiff_t>& /*stride*/) const;
    void
    put(const float* /*dptr*/,
        const std::vector<size_t>& /*start*/,
        const std::vector<size_t>& /*count*/) const;

    void
    put(const float* /*dptr*/,
        const std::vector<size_t>& /*start*/,
        const std::vector<size_t>& /*count*/,
        const std::vector<ptrdiff_t>& /*stride*/) const;
    void
    put(const int* /*dptr*/,
        const std::vector<size_t>& /*start*/,
        const std::vector<size_t>& /*count*/) const;
    void
    put(const int* /*dptr*/,
        const std::vector<size_t>& /*start*/,
        const std::vector<size_t>& /*count*/,
        const std::vector<ptrdiff_t>& /*stride*/) const;

    void get(amrex::Real* /*ptr*/) const;
    void get(float* /*ptr*/) const;
    void get(int* /*ptr*/) const;

    void
    get(amrex::Real* /*dptr*/,
        const std::vector<size_t>& /*start*/,
        const std::vector<size_t>& /*count*/) const;

    void
    get(amrex::Real* /*dptr*/,
        const std::vector<size_t>& /*start*/,
        const std::vector<size_t>& /*count*/,
        const std::vector<ptrdiff_t>& /*stride*/) const;

    void
    get(float* /*dptr*/,
        const std::vector<size_t>& /*start*/,
        const std::vector<size_t>& /*count*/) const;

    void
    get(float* /*dptr*/,
        const std::vector<size_t>& /*start*/,
        const std::vector<size_t>& /*count*/,
        const std::vector<ptrdiff_t>& /*stride*/) const;
 
    void
    get(int* /*dptr*/,
        const std::vector<size_t>& /*start*/,
        const std::vector<size_t>& /*count*/) const;
    void
    get(int* /*dptr*/,
        const std::vector<size_t>& /*start*/,
        const std::vector<size_t>& /*count*/,
        const std::vector<ptrdiff_t>& /*stride*/) const;
 
    bool has_attr(const std::string& name) const;
    void put_attr(const std::string& name, const std::string& value) const;
    void put_attr(
        const std::string& name, const std::vector<amrex::Real>& value) const;
    void
    put_attr(const std::string& name, const std::vector<float>& value) const;
    void put_attr(const std::string& name, const std::vector<int>& value) const;
 
    std::string get_attr(const std::string& name) const;
    void
    get_attr(const std::string& name, std::vector<amrex::Real>& value) const;
    void get_attr(const std::string& name, std::vector<float>& value) const;
    void get_attr(const std::string& name, std::vector<int>& value) const;
    void par_access(const int cmode) const;
};

class NCGroup
{
public:
    const int ncid;

    bool is_root() const { return (m_parent != nullptr); }

    const NCGroup& parent() const { return (is_root() ? *this : *m_parent); }

    const NCGroup& root() const
    {
        return (is_root() ? *this : m_parent->root());
    }

    std::string name() const;

    std::string full_name() const;

    int num_groups() const;

    int num_dimensions() const;

    int num_variables() const;

    int num_attributes() const;

    bool has_group(const std::string& /*name*/) const;

    bool has_dim(const std::string& /*name*/) const;

    bool has_var(const std::string& /*name*/) const;

    bool has_attr(const std::string& /*name*/) const;

    NCGroup group(const std::string& /*name*/) const;

    NCDim dim(const std::string& /*name*/) const;

    NCVar var(const std::string& /*name*/) const;

    NCGroup def_group(const std::string& /*name*/) const;

    NCDim def_dim(const std::string& /*name*/, const size_t len) const;

    NCVar def_scalar(const std::string& name, const nc_type dtype) const;

    NCVar def_array(
        const std::string& name,
        const nc_type dtype,
        const std::vector<std::string>& /*dnames*/) const;

    NCVar def_var(
        const std::string& name,
        const nc_type dtype,
        const std::vector<std::string>& dnames) const
    {
        return def_array(name, dtype, dnames);
    }
 
    void put_attr(const std::string& name, const std::string& value) const;
    void put_attr(
        const std::string& name, const std::vector<amrex::Real>& value) const;
    void
    put_attr(const std::string& name, const std::vector<float>& value) const;
    void put_attr(const std::string& name, const std::vector<int>& value) const;
 
    std::string get_attr(const std::string& name) const;
    void
    get_attr(const std::string& name, std::vector<amrex::Real>& value) const;
    void get_attr(const std::string& name, std::vector<float>& value) const;
    void get_attr(const std::string& name, std::vector<int>& value) const;

    std::vector<NCGroup> all_groups() const;

    std::vector<NCDim> all_dims() const;

    std::vector<NCVar> all_vars() const;

    void enter_def_mode() const;

    void exit_def_mode() const;
 
protected:
    explicit NCGroup(const int id) : ncid(id) {}
    NCGroup(const int id, const NCGroup* par) : ncid(id), m_parent(par) {}
 
    const NCGroup* m_parent{nullptr};
};

class NCFile : public NCGroup
{
public:
    static NCFile
    create(const std::string& name, const int cmode = NC_CLOBBER | NC_NETCDF4);
 
    static NCFile open(const std::string& name, const int cmode = NC_NOWRITE);
 
    static NCFile create_par(
        const std::string& name,
        const int cmode = NC_CLOBBER | NC_NETCDF4 | NC_MPIIO,
        MPI_Comm comm = MPI_COMM_WORLD,
        MPI_Info info = MPI_INFO_NULL);
 
    static NCFile open_par(
        const std::string& name,
        const int cmode = NC_NOWRITE,
        MPI_Comm comm = MPI_COMM_WORLD,
        MPI_Info info = MPI_INFO_NULL);
 
    ~NCFile();
 
    void close();
 
protected:
    explicit NCFile(const int id) : NCGroup(id), m_is_open{true} {}
 
    bool m_is_open{false};
};
 
} // namespace ncutils
 
#else
 
namespace ncutils {
 
struct NCDim
{
    const int ncid{-1};
    const int dimid{-1};
};
 
struct NCVar
{
    const int ncid{-1};
    const int varid{-1};
};
 
class NCGroup
{
public:
    const int ncid{-1};
};
 
class NCFile : public NCGroup
{};
 
} // namespace ncutils
 
#endif
 
#endif /* NC_INTERFACE_H */