checkpoint_io.h

Go to the documentation of this file.

// The libMesh Finite Element Library.
// Copyright (C) 2002-2024 Benjamin S. Kirk, John W. Peterson, Roy H. Stogner

// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.

// This library 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
// Lesser General Public License for more details.

// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA



#ifndef LIBMESH_CHECKPOINT_IO_H
#define LIBMESH_CHECKPOINT_IO_H


// Local includes
#include "libmesh/compare_elems_by_level.h"
#include "libmesh/mesh_input.h"
#include "libmesh/mesh_output.h"
#include "libmesh/mesh_communication.h"
#include "libmesh/parallel_object.h"

// C++ includes
#include <string>
#include <vector>

namespace libMesh
{
// Forward declarations
class Xdr;
class CheckpointIO;

std::unique_ptr<CheckpointIO> split_mesh(MeshBase & mesh, processor_id_type nsplits);

class CheckpointIO : public MeshInput<MeshBase>,
                     public MeshOutput<MeshBase>,
                     public ParallelObject
{
public:
  // The size used for encoding all id types in this file
  typedef largest_id_type xdr_id_type;

  // The size type used to read header sizes (meta data information)
  typedef uint64_t header_id_type;

  explicit
  CheckpointIO (MeshBase &, const bool=false);

  explicit
  CheckpointIO (const MeshBase &, const bool=false);

  virtual ~CheckpointIO ();

  virtual void read (const std::string & input_name) override;

  virtual void write (const std::string & name) override;

  static void cleanup(const std::string & input_name, processor_id_type n_procs);

  bool   binary() const { return _binary; }
  bool & binary()       { return _binary; }

  bool   parallel() const { return _parallel; }
  bool & parallel()       { return _parallel; }

  const std::string & version () const { return _version; }
  std::string &       version ()       { return _version; }

  bool version_at_least_1_5() const;

  const std::vector<processor_id_type> & current_processor_ids() const { return _my_processor_ids; }
  std::vector<processor_id_type> & current_processor_ids() { return _my_processor_ids; }

  const processor_id_type & current_n_processors() const { return _my_n_processors; }
  processor_id_type & current_n_processors() { return _my_n_processors; }

private:
  //---------------------------------------------------------------------------
  // Write Implementation

  void write_subdomain_names(Xdr & io) const;

  void write_connectivity (Xdr & io,
                           const std::set<const Elem *, CompareElemIdsByLevel> & elements) const;

  void write_remote_elem (Xdr & io,
                          const std::set<const Elem *, CompareElemIdsByLevel> & elements) const;

  void write_nodes (Xdr & io,
                    const connected_node_set_type & nodeset) const;

  void write_bcs (Xdr & io,
                  const std::set<const Elem *, CompareElemIdsByLevel> & elements,
                  const std::vector<std::tuple<dof_id_type, unsigned short int, boundary_id_type>> & bc_triples) const;

  void write_nodesets (Xdr & io,
                       const connected_node_set_type & nodeset,
                       const std::vector<std::tuple<dof_id_type, boundary_id_type>> & bc_tuples) const;

  void write_bc_names (Xdr & io, const BoundaryInfo & info, bool is_sideset) const;


  //---------------------------------------------------------------------------
  // Read Implementation

  template <typename file_id_type>
  file_id_type read_header(const std::string & name);

  template <typename file_id_type>
  void read_subfile(Xdr & io, bool expect_all_remote);

  template <typename file_id_type>
  void read_subdomain_names(Xdr & io);

  template <typename file_id_type>
  void read_connectivity (Xdr & io);

  template <typename file_id_type>
  void read_remote_elem (Xdr & io, bool expect_all_remote);

  template <typename file_id_type>
  void read_nodes (Xdr & io);

  template <typename file_id_type>
  void read_bcs (Xdr & io);

  template <typename file_id_type>
  void read_nodesets (Xdr & io);

  template <typename file_id_type>
  void read_bc_names(Xdr & io, BoundaryInfo & info, bool is_sideset);

  template <typename file_id_type>
  void read_integers_names
    (Xdr & io,
     std::vector<std::string> & node_integer_names,
     std::vector<std::string> & elem_integer_names);

  unsigned int n_active_levels_in(MeshBase::const_element_iterator begin,
                                  MeshBase::const_element_iterator end) const;

  processor_id_type select_split_config(const std::string & input_name, header_id_type & data_size);

  bool _binary;
  bool _parallel;
  std::string _version;

  // The processor ids to write
  std::vector<processor_id_type> _my_processor_ids;

  // The largest processor id to write
  processor_id_type _my_n_processors;
};


} // namespace libMesh

#endif // LIBMESH_CHECKPOINT_IO_H