mesh_input.h

Go to the documentation of this file.

// The libMesh Finite Element Library.
// Copyright (C) 2002-2026 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_MESH_INPUT_H
#define LIBMESH_MESH_INPUT_H
 
 
// Local includes
#include "libmesh/libmesh_common.h"
#include "libmesh/mesh_base.h"
 
// C++ includes
#include <cstddef>
#include <istream>
#include <string>
#include <vector>
 
namespace libMesh
{
 
 
 
template <class MT>
class MeshInput
{
protected:
 
  explicit
  MeshInput (bool is_parallel_format = false);
 
  explicit
  MeshInput (MT &, const bool is_parallel_format = false);
 
public:
 
  virtual ~MeshInput ();
 
  virtual void read (const std::string &) = 0;
 
  bool is_parallel_format () const { return this->_is_parallel_format; }
 
protected:
 
  MT & mesh ();
 
  void set_n_partitions (unsigned int n_parts) { this->mesh().set_n_partitions() = n_parts; }
 
  std::vector<bool> elems_of_dimension;
 
  void skip_comment_lines (std::istream & in,
                           const char comment_start);
 
private:
 
 
  MT * _obj;
 
  const bool _is_parallel_format;
};
 
 
 
// ------------------------------------------------------------
// MeshInput inline members
template <class MT>
inline
MeshInput<MT>::MeshInput (const bool is_parallel_format) :
  elems_of_dimension(),
  _obj (nullptr),
  _is_parallel_format(is_parallel_format)
{
}
 
 
 
template <class MT>
inline
MeshInput<MT>::MeshInput (MT & obj, const bool is_parallel_format) :
  elems_of_dimension(),
  _obj (&obj),
  _is_parallel_format(is_parallel_format)
{
  if (!_is_parallel_format && !this->mesh().is_serial())
    {
      if (this->mesh().processor_id() == 0)
        {
          libmesh_do_once(libMesh::out <<
                          "Warning:  This MeshOutput subclass only supports meshes which have been serialized!"
                          << std::endl;);
        }
    }
}
 
 
 
template <class MT>
inline
MeshInput<MT>::~MeshInput ()
{
}
 
 
 
template <class MT>
inline
MT & MeshInput<MT>::mesh ()
{
  libmesh_error_msg_if(_obj == nullptr, "ERROR: _obj should not be nullptr!");
  return *_obj;
}
 
 
 
template <class MT>
void MeshInput<MT>::skip_comment_lines (std::istream & in,
                                        const char comment_start)
{
  char c, line[256];
 
  while (in.get(c), c==comment_start)
    in.getline (line, 255);
 
  // put back first character of
  // first non-comment line
  in.putback (c);
}
 
 
} // namespace libMesh
 
 
#endif // LIBMESH_MESH_INPUT_H