mesh_output.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_MESH_OUTPUT_H
#define LIBMESH_MESH_OUTPUT_H


// Local includes
#include "libmesh/libmesh_common.h"
#include "libmesh/libmesh_logging.h"
#include "libmesh/mesh_base.h"
#include "libmesh/mesh_serializer.h"

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

namespace libMesh
{

// Forward declares
class EquationSystems;
template <typename T> class NumericVector;


template <class MT>
class MeshOutput
{
protected:

  explicit
  MeshOutput (const bool is_parallel_format = false, const bool serial_only_needed_on_proc_0 = false);

  explicit
  MeshOutput (const MT &, const bool is_parallel_format = false, const bool serial_only_needed_on_proc_0 = false);


public:

  virtual ~MeshOutput ();

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

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

  virtual void write_discontinuous_equation_systems (const std::string &,
                                                     const EquationSystems &,
                                                     const std::set<std::string> * system_names=nullptr);

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

  virtual void write_nodal_data_discontinuous (const std::string &,
                                               const std::vector<Number> &,
                                               const std::vector<std::string> &)
  { libmesh_not_implemented(); }

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

  virtual void write_nodal_data (const std::string &,
                                 const EquationSystems &,
                                 const std::set<std::string> *);

  unsigned int & ascii_precision ();

protected:


  const MT & mesh() const;


  virtual bool get_add_sides() { return false; }


  const bool _is_parallel_format;

  const bool _serial_only_needed_on_proc_0;

private:


  const MT * const _obj;

  unsigned int _ascii_precision;
};






// ------------------------------------------------------------
// MeshOutput inline members
template <class MT>
inline
MeshOutput<MT>::MeshOutput (const bool is_parallel_format, const bool serial_only_needed_on_proc_0) :
  _is_parallel_format(is_parallel_format),
  _serial_only_needed_on_proc_0(serial_only_needed_on_proc_0),
  _obj(nullptr),
  _ascii_precision (std::numeric_limits<Real>::max_digits10)
{}



template <class MT>
inline
MeshOutput<MT>::MeshOutput (const MT & obj, const bool is_parallel_format, const bool serial_only_needed_on_proc_0) :
  _is_parallel_format(is_parallel_format),
  _serial_only_needed_on_proc_0(serial_only_needed_on_proc_0),
  _obj (&obj),
  _ascii_precision (std::numeric_limits<Real>::max_digits10)
{
  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
MeshOutput<MT>::~MeshOutput ()
{
}



template <class MT>
inline
const MT & MeshOutput<MT>::mesh () const
{
  libmesh_assert(_obj);
  return *_obj;
}



template <class MT>
inline
unsigned int & MeshOutput<MT>::ascii_precision ()
{
  return _ascii_precision;
}


} // namespace libMesh


#endif // LIBMESH_MESH_OUTPUT_H