namebased_io.h

Go to the documentation of this file.

// The libMesh Finite Element Library.
// Copyright (C) 2002-2025 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_NAMEBASED_IO_H
#define LIBMESH_NAMEBASED_IO_H

// Local includes
#include "libmesh/mesh_output.h"
#include "libmesh/mesh_input.h"

namespace libMesh
{

// Forward declarations
class MeshBase;

class NameBasedIO : public MeshInput<MeshBase>,
                    public MeshOutput<MeshBase>
{
public:

  explicit
  NameBasedIO (const MeshBase &);

  explicit
  NameBasedIO (MeshBase &);

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

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

  virtual void write_equation_systems (const std::string & filename,
                                       const EquationSystems & es,
                                       const std::set<std::string> * system_names=nullptr) override;

  using MeshOutput<MeshBase>::write_nodal_data;

  virtual void write_nodal_data (const std::string &,
                                 const std::vector<Number> &,
                                 const std::vector<std::string> &) override;

  // Certain mesh formats can support parallel I/O, including the
  // "new" Xdr format and the Nemesis format.
  bool is_parallel_file_format (std::string_view filename);
};



// ------------------------------------------------------------
// NameBasedIO inline members
inline
NameBasedIO::NameBasedIO (const MeshBase & mesh) :
  MeshOutput<MeshBase>    (mesh)
{
}

inline
NameBasedIO::NameBasedIO (MeshBase & mesh) :
  MeshInput<MeshBase> (mesh),
  MeshOutput<MeshBase>(mesh)
{
}

inline
bool
NameBasedIO::is_parallel_file_format (std::string_view name)
{
  return ((name.rfind(".xda") < name.size()) ||
          (name.rfind(".xdr") < name.size()) ||
          (name.rfind(".nem") == name.size() - 4) ||
          (name.rfind(".n") == name.size() - 2) ||
          (name.rfind(".cp") < name.size())
          );
}


} // namespace libMesh


#endif // LIBMESH_NAMEBASED_IO_H