checkpoint_io.h

Go to the documentation of this file.

// The libMesh Finite Element Library.
// Copyright (C) 2002-2014 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/libmesh.h"
#include "libmesh/mesh_input.h"
#include "libmesh/mesh_output.h"
#include "libmesh/parallel_object.h"

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

namespace libMesh
{
// Forward declarations
class MeshBase;
class MeshData;
class Xdr;
class Elem;


// ------------------------------------------------------------
// CheckpointIO class definition
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 uint32_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&);

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

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


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

private:
  //---------------------------------------------------------------------------
  // Write Implementation
  void write_subdomain_names(Xdr &io) const;

  void write_connectivity (Xdr &io) const;

  void write_nodes (Xdr &io) const;

  void write_bcs (Xdr &io) const;

  void write_nodesets (Xdr &io) const;

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


  //---------------------------------------------------------------------------
  // Read Implementation
  void read_subdomain_names(Xdr &io);

  void read_connectivity (Xdr &io);

  void read_nodes (Xdr &io);

  void read_bcs (Xdr &io);

  void read_nodesets (Xdr &io);

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

  unsigned int n_active_levels_on_processor(const MeshBase &mesh) const;

  bool _binary;
  std::string _version;
};


} // namespace libMesh

#endif // LIBMESH_CHECKPOINT_IO_H