hdf5/Hdf5ReaderWriter.h

// -*- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature -*-
//-----------------------------------------------------------------------------
// Copyright 2000-2026 CEA (www.cea.fr) IFPEN (www.ifpenergiesnouvelles.com)
// See the top-level COPYRIGHT file for details.
// SPDX-License-Identifier: Apache-2.0
//-----------------------------------------------------------------------------
/*---------------------------------------------------------------------------*/
/* Hdf5ReaderWriter.h                                          (C) 2000-2023 */
/*                                                                           */
/* Tools for reading/writing in an HDF5 file.                                */
/*---------------------------------------------------------------------------*/
#ifndef ARCANE_HDF5_HDF5READERWRITER_H
#define ARCANE_HDF5_HDF5READERWRITER_H
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#include "arcane/core/IDataReader.h"
#include "arcane/core/IDataWriter.h"
 
#include "arcane/hdf5/Hdf5Utils.h"
#include "arcane/core/VariableTypes.h"
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane
{
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

class Hdf5ReaderWriter
: public TraceAccessor
, public IDataReader
, public IDataWriter
{
 
 public:
 
  enum eOpenMode
  {
    OpenModeRead,
    OpenModeTruncate,
    OpenModeAppend
  };
 
 public:
 
  Hdf5ReaderWriter(ISubDomain* sd, const String& filename, const String& m_sub_group_name,
                   Integer fileset_size,
                   Integer write_index, Integer index_modulo,
                   eOpenMode om, bool do_verif = false);
  ~Hdf5ReaderWriter();
 
 public:
 
  virtual void initialize();
 
  virtual void beginWrite(const VariableCollection& vars)
  {
    ARCANE_UNUSED(vars);
  }
  virtual void endWrite();
  virtual void beginRead(const VariableCollection& vars)
  {
    ARCANE_UNUSED(vars);
  }
  virtual void endRead() {}
 
  virtual void setMetaData(const String& meta_data);
  virtual String metaData();
 
  virtual void write(IVariable* v, IData* data);
  virtual void read(IVariable* v, IData* data);
 
 public:
 
  herr_t iterateMe(hid_t group_id, const char* member_name);
 
 private:
 
  IParallelMng* m_parallel_mng; 
  eOpenMode m_open_mode; 
  String m_filename; 
  String m_sub_group_name; 
  bool m_is_initialized; 
 
  Hdf5Utils::StandardTypes m_types;
 
  Hdf5Utils::HFile m_file_id; 
  Hdf5Utils::HGroup m_sub_group_id; 
  Hdf5Utils::HGroup m_variable_group_id; 
 
  StringList m_variables_name; 
  Timer m_io_timer;
 
 private:

  bool m_is_parallel;
  Int32 m_my_rank;
  Int32 m_send_rank;
  Int32 m_last_recv_rank;
 
  Integer m_fileset_size;
  Integer m_index_write;
  Integer m_index_modulo;
 
 private:
 
  void _writeVal(const String& var_group_name,
                 const String& sub_group_name,
                 const ISerializedData* sdata,
                 const Int32 from_rank = 0);
  void _writeValParallel(IVariable* v, const ISerializedData* sdata);
  void _readVal(IVariable* var, IData* data);
 
  Ref<ISerializedData> _readDim2(IVariable* v);
 
  void _directReadVal(IVariable* v, IData* data);
  void _directWriteVal(IVariable* v, IData* data);
  void _checkValid();
  String _variableGroupName(IVariable* var);
 
  void _receiveRemoteVariables();
  void _writeRemoteVariable(ISerializer* sb);
  void _setMetaData(const String& meta_data, const String& sub_group_name);
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // End namespace Arcane
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#endif