File.hh

Go to the documentation of this file.

// Copyright (C) 2012, 2013, 2014, 2015, 2016, 2017, 2019, 2020, 2023, 2024, 2025 PISM Authors
//
// This file is part of PISM.
//
// PISM is free software; you can redistribute it and/or modify it under the
// terms of the GNU General Public License as published by the Free Software
// Foundation; either version 3 of the License, or (at your option) any later
// version.
//
// PISM is distributed in the hope that it will be useful, but WITHOUT ANY
// WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
// FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
// details.
//
// You should have received a copy of the GNU General Public License
// along with PISM; if not, write to the Free Software
// Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 
#ifndef _PISM_FILE_ACCESS_H_
#define _PISM_FILE_ACCESS_H_
 
#include <vector>
#include <string>
#include <mpi.h>
 
#include "pism/util/Units.hh"
 
namespace pism {
 
enum AxisType : int;
 
namespace io {
enum Type : int;
enum Backend : int;
enum Mode : int;
} // namespace io
 
namespace grid {
class DistributedGridInfo;
}
 
/*!
 * Convert a string to PISM's backend type.
 */
io::Backend string_to_backend(const std::string &backend);
 
struct VariableLookupData {
  bool exists;
  std::string name;
};
 
//! \brief High-level PISM I/O class.
/*!
 * Hides the low-level NetCDF wrapper.
 */
class File
{
public:
  File(MPI_Comm com, const std::string &filename, io::Backend backend, io::Mode mode);
  ~File();
 
  MPI_Comm com() const;
 
  void close();
 
  void redef() const;
 
  void enddef() const;
 
  void sync() const;
 
  std::string name() const;
 
  unsigned int nrecords() const;
 
  unsigned int nrecords(const std::string &name, const std::string &std_name,
                        units::System::Ptr unit_system) const;
 
  unsigned int nvariables() const;
 
  unsigned int nattributes(const std::string &var_name) const;
 
  // dimensions
 
  void define_dimension(const std::string &name, size_t length) const;
 
  unsigned int dimension_length(const std::string &name) const;
 
  std::vector<std::string> dimensions(const std::string &variable_name) const;
 
  bool dimension_exists(const std::string &name) const;
 
  AxisType dimension_type(const std::string &name,
                          units::System::Ptr unit_system) const;
 
  // variables
 
  std::string variable_name(unsigned int id) const;
 
  void define_variable(const std::string &name, io::Type nctype,
                       const std::vector<std::string> &dims) const;
 
  VariableLookupData find_variable(const std::string &short_name, const std::string &std_name) const;
 
  bool variable_exists(const std::string &short_name) const;
 
  void read_variable(const std::string &variable_name,
                       const std::vector<unsigned int> &start,
                       const std::vector<unsigned int> &count,
                       double *ip) const;
 
  void write_variable(const std::string &variable_name,
                      const std::vector<unsigned int> &start,
                      const std::vector<unsigned int> &count,
                      const double *op) const;
 
  void write_text_variable(const std::string &variable_name, const std::vector<unsigned int> &start,
                           const std::vector<unsigned int> &count, const std::string &input) const;
 
  void set_variable_was_written(const std::string &name) const;
  bool get_variable_was_written(const std::string &name) const;
 
  void write_distributed_array(const std::string &variable_name,
                               const grid::DistributedGridInfo &grid,
                               unsigned int z_count,
                               bool time_dependent,
                               const double *input) const;
 
  void set_compression_level(int level) const;
 
  // attributes
 
  void remove_attribute(const std::string &variable_name, const std::string &att_name) const;
 
  std::string attribute_name(const std::string &var_name, unsigned int n) const;
 
  io::Type attribute_type(const std::string &var_name, const std::string &att_name) const;
 
  void write_attribute(const std::string &var_name, const std::string &att_name,
                      io::Type nctype, const std::vector<double> &values) const;
 
  void write_attribute(const std::string &var_name, const std::string &att_name,
                       const std::string &value) const;
 
  std::vector<double> read_double_attribute(const std::string &var_name,
                                            const std::string &att_name) const;
 
  std::string read_text_attribute(const std::string &var_name, const std::string &att_name) const;
 
  void append_history(const std::string &history) const;
private:
  struct Impl;
  Impl *m_impl;
 
  void open(const std::string &filename, io::Mode mode);
 
  // disable copying and assignments
  File(const File &other);
  File & operator=(const File &);
};
 
} // end of namespace pism
 
#endif /* _PISM_FILE_ACCESS_H_ */