This class supports simple reads and writes in any libMesh-supported format, by dispatching to one of the other I/O classes based on filename. More...

#include <namebased_io.h>

Inheritance diagram for libMesh::NameBasedIO:

[legend]

Public Member Functions
	NameBasedIO (const MeshBase &)
	Constructor.

	NameBasedIO (MeshBase &)
	Constructor.

virtual void	read (const std::string &mesh_file) override
	This method implements reading a mesh from a specified file.

virtual void	write (const std::string &mesh_file) override
	This method implements writing a mesh to a specified file.

virtual void	write_equation_systems (const std::string &filename, const EquationSystems &es, const std::set< std::string > *system_names=nullptr) override
	This method implements writing a mesh with data to a specified file where the data is taken from the `EquationSystems` object.

virtual void	write_nodal_data (const std::string &, const std::vector< Number > &, const std::vector< std::string > &) override
	This method implements writing a mesh with nodal data to a specified file where the nodal data and variable names are provided.

bool	is_parallel_file_format (std::string_view filename)

bool	is_parallel_format () const
	Returns true iff this mesh file format and input class are parallelized, so that all processors can read their share of the data at once.

virtual void	write_discontinuous_equation_systems (const std::string &, const EquationSystems &, const std::set< std::string > *system_names=nullptr)
	This method implements writing a mesh with discontinuous data to a specified file where the data is taken from the `EquationSystems` object.

virtual void	write_nodal_data (const std::string &, const NumericVector< Number > &, const std::vector< std::string > &)
	This method may be overridden by "parallel" output formats for writing nodal data.

virtual void	write_nodal_data (const std::string &, const EquationSystems &, const std::set< std::string > *)
	This method should be overridden by "parallel" output formats for writing nodal data.

virtual void	write_nodal_data_discontinuous (const std::string &, const std::vector< Number > &, const std::vector< std::string > &)
	This method implements writing a mesh with discontinuous data to a specified file where the nodal data and variables names are provided.

unsigned int &	ascii_precision ()
	Return/set the precision to use when writing ASCII files.

Protected Member Functions
MeshBase &	mesh ()

void	set_n_partitions (unsigned int n_parts)
	Sets the number of partitions in the mesh.

void	skip_comment_lines (std::istream &in, const char comment_start)
	Reads input from `in`, skipping all the lines that start with the character `comment_start`.

const MeshBase &	mesh () const

virtual bool	get_add_sides ()

Protected Attributes
std::vector< bool >	elems_of_dimension
	A vector of bools describing what dimension elements have been encountered when reading a mesh.

const bool	_is_parallel_format
	Flag specifying whether this format is parallel-capable.

const bool	_serial_only_needed_on_proc_0
	Flag specifying whether this format can be written by only serializing the mesh to processor zero.

Private Attributes
MeshBase *	_obj
	A pointer to a non-const object object.

const bool	_is_parallel_format
	Flag specifying whether this format is parallel-capable.

unsigned int	_ascii_precision
	Precision to use when writing ASCII files.

Detailed Description

This class supports simple reads and writes in any libMesh-supported format, by dispatching to one of the other I/O classes based on filename.

Other I/O classes may have more advanced features that are not accessible via this interface.

Author: Roy H. Stogner

Date: 2015

Definition at line 44 of file namebased_io.h.

Constructor & Destructor Documentation

◆ NameBasedIO() [1/2]

libMesh::NameBasedIO::NameBasedIO ( const MeshBase & mesh )

inlineexplicit

Constructor.

Takes a reference to a constant mesh object. This constructor will only allow us to write the mesh.

Definition at line 110 of file namebased_io.h.

                                               :
  MeshOutput<MeshBase>    (mesh)
{
}

◆ NameBasedIO() [2/2]

libMesh::NameBasedIO::NameBasedIO ( MeshBase & mesh )

inlineexplicit

Constructor.

Takes a writable reference to a mesh object. This constructor is required to let us read in a mesh.

Definition at line 116 of file namebased_io.h.

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

Member Function Documentation

◆ ascii_precision()

unsigned int & libMesh::MeshOutput< MeshBase >::ascii_precision ( )

inlineinherited

Return/set the precision to use when writing ASCII files.

By default we use numeric_limits<Real>::max_digits10, which should be enough to write out to ASCII and get the exact same Real back when reading in.

Definition at line 160 of file mesh_output.h.

{
  return _ascii_precision;
}

◆ get_add_sides()

virtual bool libMesh::MeshOutput< MeshBase >::get_add_sides ( )

inlineprotectedvirtualinherited

Returns: Whether or not added sides are expected to be output, to plot SIDE_DISCONTINUOUS data. Subclasses should override this if they are capable of plotting such data.

Reimplemented in libMesh::ExodusII_IO.

Definition at line 176 of file mesh_output.h.

176{ return false; }

◆ is_parallel_file_format()

bool libMesh::NameBasedIO::is_parallel_file_format ( std::string_view filename )

Definition at line 574 of file namebased_io.C.

{
  using Utility::contains;
  using Utility::ends_with;
  return (contains(name, ".xda") || contains(name, ".xdr") ||
          ends_with(name, ".nem") || ends_with(name, ".n") ||
          contains(name, ".cp"));
}

References libMesh::Utility::contains(), and libMesh::Utility::ends_with().

Referenced by read(), and write().

◆ is_parallel_format()

bool libMesh::MeshInput< MeshBase >::is_parallel_format ( ) const

inlineinherited

Returns true iff this mesh file format and input class are parallelized, so that all processors can read their share of the data at once.

Definition at line 87 of file mesh_input.h.

87{ return this->_is_parallel_format; }

libMesh::MeshInput< MeshBase >::_is_parallel_format

const bool _is_parallel_format

Flag specifying whether this format is parallel-capable.

Definition mesh_input.h:130

◆ mesh() [1/2]

MeshBase & libMesh::MeshInput< MeshBase >::mesh ( )

inlineprotectedinherited

Returns: The object as a writable reference.

Definition at line 94 of file mesh_input.h.

{
  libmesh_error_msg_if(_obj == nullptr, "ERROR: _obj should not be nullptr!");
  return *_obj;
}

◆ mesh() [2/2]

const MeshBase & libMesh::MeshOutput< MeshBase >::mesh ( ) const

inlineprotectedinherited

Returns: The object as a read-only reference.

Definition at line 168 of file mesh_output.h.

{
  libmesh_assert(_obj);
  return *_obj;
}

◆ read()

void libMesh::NameBasedIO::read ( const std::string & mesh_file )

overridevirtual

This method implements reading a mesh from a specified file.

Implements libMesh::MeshInput< MeshBase >.

Definition at line 69 of file namebased_io.C.

{
  MeshBase & mymesh = MeshInput<MeshBase>::mesh();
 
  const std::string_view basename = Utility::basename_of(name);
 
  using Utility::ends_with;
  using Utility::contains;
 
  // See if the file exists.  Perform this check on all processors
  // so that the code is terminated properly in the case that the
  // file does not exist.
 
  // For Nemesis files, the name we try to read will have suffixes
  // identifying processor rank
  if (ends_with(basename, ".nem") || ends_with(basename, ".n"))
    {
      std::ostringstream full_name;
 
      // Find the length of a string which represents the highest processor ID
      full_name << (mymesh.n_processors());
      int field_width = cast_int<int>(full_name.str().size());
 
      // reset the string stream
      full_name.str("");
 
      // And build up the full filename
      full_name << name
                << '.' << mymesh.n_processors()
                << '.' << std::setfill('0') << std::setw(field_width) << mymesh.processor_id();
 
      std::ifstream in (full_name.str().c_str());
      libmesh_error_msg_if(!in.good(), "ERROR: cannot locate specified file:\n\t" << full_name.str());
    }
  else if (contains(basename, ".cp")) {} // Do error checking in the reader
  else
    {
      std::ifstream in (name.c_str());
      libmesh_error_msg_if(!in.good(), "ERROR: cannot locate specified file:\n\t" << name);
    }
 
  // Look for parallel formats first
  if (is_parallel_file_format(basename))
    {
      // no need to handle bz2 files here -- the Xdr class does that.
      if (contains(basename, ".xda") ||
          contains(basename, ".xdr"))
        {
          XdrIO xdr_io(mymesh);
 
          // .xda* ==> bzip2/gzip/ASCII flavors
          if (contains(basename, ".xda"))
            {
              xdr_io.binary() = false;
              xdr_io.read (name);
            }
          else // .xdr* ==> true binary XDR file
            {
              xdr_io.binary() = true;
              xdr_io.read (name);
            }
 
          // The xdr_io object gets constructed with legacy() == false.
          // if legacy() == true then it means that a legacy file was detected and
          // thus processor 0 performed the read. We therefore need to broadcast the
          // mesh.  Further, for this flavor of mesh solution data ordering is tied
          // to the node ordering, so we better not reorder the nodes!
          if (xdr_io.legacy())
            {
              mymesh.allow_renumbering(false);
              MeshCommunication().broadcast(mymesh);
            }
 
          // libHilbert-enabled libMesh builds should construct files
          // with a canonical node ordering, which libHilbert-enabled
          // builds will be able to read in again regardless of any
          // renumbering.  So in that case we're free to renumber.
          // However, if either the writer or the reader of this file
          // don't have libHilbert, then we'll have to skip
          // renumbering because we need the numbering to remain
          // consistent with any solution file we read in next.
#ifdef LIBMESH_HAVE_LIBHILBERT
          // if (!xdr_io.libhilbert_ordering())
          //   skip_renumber_nodes_and_elements = true;
#else
          mymesh.allow_renumbering(false);
#endif
        }
      else if (contains(basename, ".nem") ||
               contains(basename, ".n"))
        Nemesis_IO(mymesh).read (name);
      else if (contains(basename, ".cp"))
        {
          if (contains(basename, ".cpa"))
            CheckpointIO(mymesh, false).read(name);
          else
            CheckpointIO(mymesh, true).read(name);
        }
    }
 
  // Serial mesh formats
  else
    {
      // Read the file based on extension.  Only processor 0
      // needs to read the mesh.  It will then broadcast it and
      // the other processors will pick it up
      if (mymesh.processor_id() == 0)
        {
          LOG_SCOPE("read()", "NameBasedIO");
 
          std::ostringstream pid_suffix;
          pid_suffix << '_' << getpid();
          // Nasty hack for reading/writing zipped files
          std::string new_name = name;
          if (ends_with(name, ".bz2"))
            {
#ifdef LIBMESH_HAVE_BZIP
              new_name.erase(new_name.end() - 4, new_name.end());
              new_name += pid_suffix.str();
              std::string system_string = "bunzip2 -f -k -c ";
              system_string += name + " > " + new_name;
              LOG_SCOPE("system(bunzip2)", "NameBasedIO");
              if (std::system(system_string.c_str()))
                libmesh_file_error(system_string);
#else
              libmesh_error_msg("ERROR: need bzip2/bunzip2 to open .bz2 file " << name);
#endif
            }
          else if (ends_with(name, ".xz"))
            {
#ifdef LIBMESH_HAVE_XZ
              new_name.erase(new_name.end() - 3, new_name.end());
              new_name += pid_suffix.str();
              std::string system_string = "xz -f -d -k -c ";
              system_string += name + " > " + new_name;
              LOG_SCOPE("system(xz -d)", "XdrIO");
              if (std::system(system_string.c_str()))
                libmesh_file_error(system_string);
#else
              libmesh_error_msg("ERROR: need xz to open .xz file " << name);
#endif
            }
 
          if (contains(basename, ".mat"))
            MatlabIO(mymesh).read(new_name);
 
          else if (contains(basename, ".ucd"))
            UCDIO(mymesh).read (new_name);
 
          else if (contains(basename, ".off") ||
                   contains(basename, ".ogl") ||
                   contains(basename, ".oogl"))
            OFFIO(mymesh).read (new_name);
 
          else if (contains(basename, ".unv"))
            UNVIO(mymesh).read (new_name);
 
          else if (contains(basename, ".node") ||
                   contains(basename, ".ele"))
            TetGenIO(mymesh).read (new_name);
 
          else if (contains(basename, ".exd") ||
                   contains(basename, ".exo") ||
                   contains(basename, ".e"))
            ExodusII_IO(mymesh).read (new_name);
 
          else if (contains(basename, ".msh"))
            GmshIO(mymesh).read (new_name);
 
          else if (contains(basename, ".gmv"))
            GMVIO(mymesh).read (new_name);
 
          else if (contains(basename, ".stl"))
            STLIO(mymesh).read (new_name);
 
          else if (contains(basename, ".pvtu") ||
                   contains(basename, ".vtu"))
            VTKIO(mymesh).read(new_name);
 
          else if (contains(basename, ".inp"))
            AbaqusIO(mymesh).read(new_name);
 
          else if (contains(basename, ".bext") ||
                   contains(basename, ".bxt"))
            DynaIO(mymesh).read (new_name);
 
          else if (contains(basename, ".bez"))
            DynaIO(mymesh, false).read (new_name);
 
          else
            {
              libmesh_error_msg(" ERROR: Unrecognized file extension: " \
                                << name                                 \
                                << "\n   I understand the following:\n\n" \
                                << "     *.bext -- Bezier files in DYNA format\n" \
                                << "     *.bez  -- Bezier DYNA files, omit spline nodes\n" \
                                << "     *.bxt  -- Bezier files in DYNA format\n" \
                                << "     *.cpa  -- libMesh Checkpoint ASCII format\n" \
                                << "     *.cpr  -- libMesh Checkpoint binary format\n" \
                                << "     *.e    -- Sandia's ExodusII format\n" \
                                << "     *.exo  -- Sandia's ExodusII format\n" \
                                << "     *.gmv  -- LANL's General Mesh Viewer format\n" \
                                << "     *.inp  -- Abaqus .inp format\n" \
                                << "     *.mat  -- Matlab triangular ASCII file\n" \
                                << "     *.n    -- Sandia's Nemesis format\n" \
                                << "     *.nem  -- Sandia's Nemesis format\n" \
                                << "     *.off  -- OOGL OFF surface format\n" \
                                << "     *.ogl  -- OOGL OFF surface format\n" \
                                << "     *.oogl -- OOGL OFF surface format\n" \
                                << "     *.pvtu -- Paraview VTK format\n" \
                                << "     *.stl  -- STereoLithography triangulation format\n" \
                                << "     *.ucd  -- AVS's ASCII UCD format\n" \
                                << "     *.unv  -- I-deas Universal format\n" \
                                << "     *.vtu  -- Paraview VTK format\n" \
                                << "     *.xda  -- libMesh ASCII format\n" \
                                << "     *.xdr  -- libMesh binary format\n" \
                                << "     *.gz   -- any above format gzipped\n" \
                                << "     *.bz2  -- any above format bzip2'ed\n" \
                                << "     *.xz   -- any above format xzipped\n" \
                                );
            }
 
          // If we temporarily decompressed a file, remove the
          // uncompressed version
          if (ends_with(basename, ".bz2"))
            std::remove(new_name.c_str());
          if (ends_with(basename, ".xz"))
            std::remove(new_name.c_str());
        }
 
      // Send the mesh & bcs (which are now only on processor 0) to the other
      // processors
      MeshCommunication().broadcast (mymesh);
    }
}

References libMesh::MeshBase::allow_renumbering(), libMesh::Utility::basename_of(), libMesh::XdrIO::binary(), libMesh::MeshCommunication::broadcast(), libMesh::Utility::contains(), libMesh::Utility::ends_with(), is_parallel_file_format(), libMesh::XdrIO::legacy(), libMesh::MeshInput< MT >::mesh(), libMesh::ParallelObject::n_processors(), libMesh::ParallelObject::processor_id(), libMesh::TetGenIO::read(), libMesh::UCDIO::read(), libMesh::UNVIO::read(), libMesh::VTKIO::read(), libMesh::XdrIO::read(), libMesh::Nemesis_IO::read(), libMesh::CheckpointIO::read(), libMesh::GMVIO::read(), libMesh::STLIO::read(), libMesh::AbaqusIO::read(), libMesh::DynaIO::read(), libMesh::ExodusII_IO::read(), libMesh::GmshIO::read(), libMesh::MatlabIO::read(), and libMesh::OFFIO::read().

Referenced by libMesh::UnstructuredMesh::read().

◆ set_n_partitions()

void libMesh::MeshInput< MeshBase >::set_n_partitions ( unsigned int n_parts )

inlineprotectedinherited

Sets the number of partitions in the mesh.

Typically this gets done by the partitioner, but some parallel file formats begin "pre-partitioned".

Definition at line 101 of file mesh_input.h.

101{ this->mesh().set_n_partitions() = n_parts; }

mesh

MeshBase & mesh

Definition mesh_communication.C:1460

◆ skip_comment_lines()

void libMesh::MeshInput< MeshBase >::skip_comment_lines	(	std::istream &	in,
		const char	comment_start
	)

protectedinherited

Reads input from in, skipping all the lines that start with the character comment_start.

Definition at line 113 of file mesh_input.h.

{
  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);
}

◆ write()

void libMesh::NameBasedIO::write ( const std::string & mesh_file )

overridevirtual

This method implements writing a mesh to a specified file.

Implements libMesh::MeshOutput< MeshBase >.

Definition at line 306 of file namebased_io.C.

{
  const MeshBase & mymesh = MeshOutput<MeshBase>::mesh();
 
  const std::string_view basename = Utility::basename_of(name);
 
  using Utility::contains;
  using Utility::ends_with;
 
  // parallel formats are special -- they may choose to write
  // separate files, let's not try to handle the zipping here.
  if (is_parallel_file_format(basename))
    {
      // no need to handle bz2 files here -- the Xdr class does that.
      if (contains(basename, ".xda"))
        XdrIO(mymesh).write(name);
 
      else if (contains(basename, ".xdr"))
        XdrIO(mymesh,true).write(name);
 
      else if (contains(basename, ".nem") ||
               contains(basename, ".n"))
        Nemesis_IO(mymesh).write(name);
 
      else if (contains(basename, ".cpa"))
        CheckpointIO(mymesh,false).write(name);
 
      else if (contains(basename, ".cpr"))
        CheckpointIO(mymesh,true).write(name);
 
      else
        libmesh_error_msg("Couldn't deduce filetype for " << name);
    }
 
  // serial file formats
  else
    {
      // Nasty hack for reading/writing zipped files
      std::string new_name = name;
      int pid_0 = 0;
      if (mymesh.processor_id() == 0)
        pid_0 = getpid();
      mymesh.comm().broadcast(pid_0);
      std::ostringstream pid_suffix;
      pid_suffix << '_' << pid_0;
 
      if (ends_with(name, ".bz2"))
        {
          new_name.erase(new_name.end() - 4, new_name.end());
          new_name += pid_suffix.str();
        }
      else if (ends_with(name, ".xz"))
        {
          new_name.erase(new_name.end() - 3, new_name.end());
          new_name += pid_suffix.str();
        }
 
      // New scope so that io will close before we try to zip the file
      {
        // Write the file based on extension
        if (contains(basename, ".dat"))
          TecplotIO(mymesh).write (new_name);
 
        else if (contains(basename, ".plt"))
          TecplotIO(mymesh,true).write (new_name);
 
        else if (contains(basename, ".ucd"))
          UCDIO (mymesh).write (new_name);
 
        else if (contains(basename, ".gmv"))
          if (mymesh.n_partitions() > 1)
            GMVIO(mymesh).write (new_name);
          else
            {
              GMVIO io(mymesh);
              io.partitioning() = false;
              io.write (new_name);
            }
 
        else if (contains(basename, ".exd") ||
                 contains(basename, ".exo") ||
                 contains(basename, ".e"))
          ExodusII_IO(mymesh).write(new_name);
 
        else if (contains(basename, ".unv"))
          UNVIO(mymesh).write (new_name);
 
        else if (contains(basename, ".mesh"))
          MEDITIO(mymesh).write (new_name);
 
        else if (contains(basename, ".poly"))
          TetGenIO(mymesh).write (new_name);
 
        else if (contains(basename, ".msh"))
          GmshIO(mymesh).write (new_name);
 
        else if (contains(basename, ".fro"))
          FroIO(mymesh).write (new_name);
 
        else if (contains(basename, ".pvtu"))
          VTKIO(mymesh).write (name);
 
        else if (contains(basename, ".stl"))
          STLIO(mymesh).write (new_name);
 
        else
          {
            libMesh::err
              << " ERROR: Unrecognized file extension: " << name
              << "\n   I understand the following:\n\n"
              << "     *.cpa   -- libMesh ASCII checkpoint format\n"
              << "     *.cpr   -- libMesh binary checkpoint format,\n"
              << "     *.dat   -- Tecplot ASCII file\n"
              << "     *.e     -- Sandia's ExodusII format\n"
              << "     *.exo   -- Sandia's ExodusII format\n"
              << "     *.fro   -- ACDL's surface triangulation file\n"
              << "     *.gmv   -- LANL's GMV (General Mesh Viewer) format\n"
              << "     *.mesh  -- MEdit mesh format\n"
              << "     *.msh   -- GMSH ASCII file\n"
              << "     *.n     -- Sandia's Nemesis format\n"
              << "     *.nem   -- Sandia's Nemesis format\n"
              << "     *.plt   -- Tecplot binary file\n"
              << "     *.poly  -- TetGen ASCII file\n"
              << "     *.pvtu  -- VTK (paraview-readable) format\n"
              << "     *.stl   -- STereoLithography triangulation format\n" \
              << "     *.ucd   -- AVS's ASCII UCD format\n"
              << "     *.unv   -- I-deas Universal format\n"
              << "     *.xda   -- libMesh ASCII format\n"
              << "     *.xdr   -- libMesh binary format,\n"
              << std::endl
              << "\n Exiting without writing output\n";
          }
      }
 
      // Nasty hack for reading/writing zipped files
      if (ends_with(basename, ".bz2"))
        {
          LOG_SCOPE("system(bzip2)", "NameBasedIO");
          if (mymesh.processor_id() == 0)
            {
              std::string system_string = "bzip2 -f -c ";
              system_string += new_name + " > " + name;
              if (std::system(system_string.c_str()))
                libmesh_file_error(system_string);
              std::remove(new_name.c_str());
            }
          mymesh.comm().barrier();
        }
      if (ends_with(basename, ".xz"))
        {
          LOG_SCOPE("system(xz)", "NameBasedIO");
          if (mymesh.processor_id() == 0)
            {
              std::string system_string = "xz -f -c ";
              system_string += new_name + " > " + name;
              if (std::system(system_string.c_str()))
                libmesh_file_error(system_string);
              std::remove(new_name.c_str());
            }
          mymesh.comm().barrier();
        }
    }
}

Referenced by libMesh::UnstructuredMesh::find_neighbors(), and libMesh::UnstructuredMesh::write().

◆ write_discontinuous_equation_systems()

void libMesh::MeshOutput< MeshBase >::write_discontinuous_equation_systems	(	const std::string &	fname,
		const EquationSystems &	es,
		const std::set< std::string > *	system_names = `nullptr`
	)

virtualinherited

This method implements writing a mesh with discontinuous data to a specified file where the data is taken from the EquationSystems object.

Definition at line 101 of file mesh_output.C.

{
  LOG_SCOPE("write_discontinuous_equation_systems()", "MeshOutput");
 
  // We may need to gather and/or renumber a DistributedMesh to output
  // it, making that const qualifier in our constructor a dirty lie
  MT & my_mesh = const_cast<MT &>(*_obj);
 
  // If we're asked to write data that's associated with a different
  // mesh, output files full of garbage are the result.
  libmesh_assert_equal_to(&es.get_mesh(), _obj);
 
  // A non-renumbered mesh may not have a contiguous numbering, and
  // that needs to be fixed before we can build a solution vector.
  if (my_mesh.max_elem_id() != my_mesh.n_elem() ||
      my_mesh.max_node_id() != my_mesh.n_nodes())
    {
      // If we were allowed to renumber then we should have already
      // been properly renumbered...
      libmesh_assert(!my_mesh.allow_renumbering());
 
      libmesh_do_once(libMesh::out <<
                      "Warning:  This MeshOutput subclass only supports meshes which are contiguously renumbered!"
                      << std::endl;);
 
      my_mesh.allow_renumbering(true);
 
      my_mesh.renumber_nodes_and_elements();
 
      // Not sure what good going back to false will do here, the
      // renumbering horses have already left the barn...
      my_mesh.allow_renumbering(false);
    }
 
  MeshSerializer serialize(const_cast<MT &>(*_obj), !_is_parallel_format, _serial_only_needed_on_proc_0);
 
  // Build the list of variable names that will be written.
  std::vector<std::string> names;
  es.build_variable_names  (names, nullptr, system_names);
 
  if (!_is_parallel_format)
    {
      // Build the nodal solution values & get the variable
      // names from the EquationSystems object
      std::vector<Number> soln;
      es.build_discontinuous_solution_vector (soln, system_names,
                                              nullptr, false, /* defaults */
                                              this->get_add_sides());
 
      this->write_nodal_data_discontinuous (fname, soln, names);
    }
  else // _is_parallel_format
    {
      libmesh_not_implemented();
    }
}

◆ write_equation_systems()

void libMesh::NameBasedIO::write_equation_systems	(	const std::string &	filename,
		const EquationSystems &	es,
		const std::set< std::string > *	system_names = `nullptr`
	)

overridevirtual

This method implements writing a mesh with data to a specified file where the data is taken from the EquationSystems object.

We override the default MeshOutput::write_equation_systems because it only outputs nodal data by default, whereas we want to output a proper restart file if the requested filename is an XDA or XDR type.

Reimplemented from libMesh::MeshOutput< MeshBase >.

Definition at line 541 of file namebased_io.C.

{
  // XDA/XDR require a separate code path, and currently only support
  // writing complete restarts
  if (!system_names)
    {
      const std::string_view basename =
        Utility::basename_of(filename);
 
      if (Utility::contains(basename, ".xda"))
        {
          es.write(filename,WRITE,
                   EquationSystems::WRITE_DATA |
                   EquationSystems::WRITE_ADDITIONAL_DATA);
          return;
        }
      else if (Utility::contains(basename, ".xdr"))
        {
          es.write(filename,ENCODE,
                   EquationSystems::WRITE_DATA |
                   EquationSystems::WRITE_ADDITIONAL_DATA);
          return;
        }
    }
 
  // Other formats just use the default "write nodal values" path
  MeshOutput<MeshBase>::write_equation_systems
    (filename, es, system_names);
}

References libMesh::Utility::basename_of(), libMesh::Utility::contains(), libMesh::ENCODE, libMesh::WRITE, libMesh::EquationSystems::write(), libMesh::EquationSystems::WRITE_ADDITIONAL_DATA, libMesh::EquationSystems::WRITE_DATA, and libMesh::MeshOutput< MT >::write_equation_systems().

Referenced by main().

◆ write_nodal_data() [1/3]

void libMesh::MeshOutput< MeshBase >::write_nodal_data	(	const std::string &	fname,
		const EquationSystems &	es,
		const std::set< std::string > *	system_names
	)

virtualinherited

This method should be overridden by "parallel" output formats for writing nodal data.

Instead of getting a localized copy of the nodal solution vector, it directly uses EquationSystems current_local_solution vectors to look up nodal values.

If not implemented, reorders the solutions into a nodal-only NumericVector and calls the above version of this function.

Reimplemented in libMesh::Nemesis_IO.

Definition at line 149 of file mesh_output.C.

{
  std::vector<std::string> names;
  es.build_variable_names  (names, nullptr, system_names);
 
  std::unique_ptr<NumericVector<Number>> parallel_soln =
    es.build_parallel_solution_vector(system_names);
 
  this->write_nodal_data (fname, *parallel_soln, names);
}

◆ write_nodal_data() [2/3]

void libMesh::MeshOutput< MeshBase >::write_nodal_data	(	const std::string &	fname,
		const NumericVector< Number > &	parallel_soln,
		const std::vector< std::string > &	names
	)

virtualinherited

This method may be overridden by "parallel" output formats for writing nodal data.

Instead of getting a localized copy of the nodal solution vector, it is passed a NumericVector of type=PARALLEL which is in node-major order i.e. (u0,v0,w0, u1,v1,w1, u2,v2,w2, u3,v3,w3, ...) and contains n_nodes*n_vars total entries. Then, it is up to the individual I/O class to extract the required solution values from this vector and write them in parallel.

If not implemented, localizes the parallel vector into a std::vector and calls the other version of this function.

Reimplemented in libMesh::Nemesis_IO.

Definition at line 136 of file mesh_output.C.

{
  // This is the fallback implementation for parallel I/O formats that
  // do not yet implement proper writing in parallel, and instead rely
  // on the full solution vector being available on all processors.
  std::vector<Number> soln;
  parallel_soln.localize(soln);
  this->write_nodal_data(fname, soln, names);
}

◆ write_nodal_data() [3/3]

void libMesh::NameBasedIO::write_nodal_data	(	const std::string &	name,
		const std::vector< Number > &	v,
		const std::vector< std::string > &	vn
	)

overridevirtual

This method implements writing a mesh with nodal data to a specified file where the nodal data and variable names are provided.

Reimplemented from libMesh::MeshOutput< MeshBase >.

Definition at line 471 of file namebased_io.C.

{
  const MeshBase & mymesh = MeshOutput<MeshBase>::mesh();
 
  using Utility::contains;
  using Utility::ends_with;
 
  // Write the file based on extension
  if (contains(name, ".dat"))
    TecplotIO(mymesh).write_nodal_data (name, v, vn);
 
  else if (contains(name, ".exd") ||
           contains(name, ".exo") ||
           contains(name, ".e"))
    ExodusII_IO(mymesh).write_nodal_data(name, v, vn);
 
  else if (contains(name, ".gmv"))
    {
      if (mymesh.n_subdomains() > 1)
        GMVIO(mymesh).write_nodal_data (name, v, vn);
      else
        {
          GMVIO io(mymesh);
          io.partitioning() = false;
          io.write_nodal_data (name, v, vn);
        }
    }
 
  else if (contains(name, ".mesh"))
    MEDITIO(mymesh).write_nodal_data (name, v, vn);
 
  else if (contains(name, ".msh"))
    GmshIO(mymesh).write_nodal_data (name, v, vn);
 
  else if (contains(name, ".nem") ||
           contains(name, ".n"))
    Nemesis_IO(mymesh).write_nodal_data(name, v, vn);
 
  else if (contains(name, ".plt"))
    TecplotIO(mymesh,true).write_nodal_data (name, v, vn);
 
  else if (contains(name, ".pvtu"))
    VTKIO(mymesh).write_nodal_data (name, v, vn);
 
  else if (contains(name, ".ucd"))
    UCDIO (mymesh).write_nodal_data (name, v, vn);
 
  else
    {
      libMesh::err
        << " ERROR: Unrecognized file extension: " << name
        << "\n   I understand the following:\n\n"
        << "     *.dat  -- Tecplot ASCII file\n"
        << "     *.e    -- Sandia's ExodusII format\n"
        << "     *.exo  -- Sandia's ExodusII format\n"
        << "     *.gmv  -- LANL's GMV (General Mesh Viewer) format\n"
        << "     *.mesh -- MEdit mesh format\n"
        << "     *.msh  -- GMSH ASCII file\n"
        << "     *.n    -- Sandia's Nemesis format\n"
        << "     *.nem  -- Sandia's Nemesis format\n"
        << "     *.plt  -- Tecplot binary file\n"
        << "     *.pvtu -- Paraview VTK file\n"
        << "     *.ucd  -- AVS's ASCII UCD format\n"
        << "\n Exiting without writing output\n";
    }
}

References libMesh::Utility::contains(), libMesh::Utility::ends_with(), libMesh::err, libMesh::MeshOutput< MT >::mesh(), libMesh::MeshBase::n_subdomains(), libMesh::GMVIO::partitioning(), libMesh::ExodusII_IO::write_nodal_data(), libMesh::GmshIO::write_nodal_data(), libMesh::GMVIO::write_nodal_data(), libMesh::MEDITIO::write_nodal_data(), libMesh::TecplotIO::write_nodal_data(), libMesh::VTKIO::write_nodal_data(), libMesh::Nemesis_IO::write_nodal_data(), and libMesh::UCDIO::write_nodal_data().

Referenced by libMesh::UnstructuredMesh::write().

◆ write_nodal_data_discontinuous()

virtual void libMesh::MeshOutput< MeshBase >::write_nodal_data_discontinuous	(	const std::string &	,
		const std::vector< Number > &	,
		const std::vector< std::string > &
	)

inlinevirtualinherited

This method implements writing a mesh with discontinuous data to a specified file where the nodal data and variables names are provided.

Reimplemented in libMesh::ExodusII_IO.

Definition at line 118 of file mesh_output.h.

121 { libmesh_not_implemented(); }

Member Data Documentation

◆ _ascii_precision

unsigned int libMesh::MeshOutput< MeshBase >::_ascii_precision

privateinherited

Precision to use when writing ASCII files.

Definition at line 207 of file mesh_output.h.

◆ _is_parallel_format [1/2]

const bool libMesh::MeshInput< MeshBase >::_is_parallel_format

privateinherited

Flag specifying whether this format is parallel-capable.

If this is false (default) I/O is only permitted when the mesh has been serialized.

Definition at line 130 of file mesh_input.h.

◆ _is_parallel_format [2/2]

const bool libMesh::MeshOutput< MeshBase >::_is_parallel_format

protectedinherited

Flag specifying whether this format is parallel-capable.

If this is false (default) I/O is only permitted when the mesh has been serialized.

Definition at line 184 of file mesh_output.h.

◆ _obj

MeshBase * libMesh::MeshInput< MeshBase >::_obj

privateinherited

A pointer to a non-const object object.

This allows us to read the object from file.

Definition at line 123 of file mesh_input.h.

◆ _serial_only_needed_on_proc_0

const bool libMesh::MeshOutput< MeshBase >::_serial_only_needed_on_proc_0

protectedinherited

Flag specifying whether this format can be written by only serializing the mesh to processor zero.

If this is false (default) the mesh will be serialized to all processors

Definition at line 193 of file mesh_output.h.

◆ elems_of_dimension

std::vector<bool> libMesh::MeshInput< MeshBase >::elems_of_dimension

protectedinherited

A vector of bools describing what dimension elements have been encountered when reading a mesh.

Definition at line 107 of file mesh_input.h.

The documentation for this class was generated from the following files:

include/mesh/namebased_io.h
src/mesh/namebased_io.C

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ NameBasedIO() [1/2]

◆ NameBasedIO() [2/2]

Member Function Documentation

◆ ascii_precision()

◆ get_add_sides()

◆ is_parallel_file_format()

◆ is_parallel_format()

◆ mesh() [1/2]

◆ mesh() [2/2]

◆ read()

◆ set_n_partitions()

◆ skip_comment_lines()

◆ write()

◆ write_discontinuous_equation_systems()

◆ write_equation_systems()

◆ write_nodal_data() [1/3]

◆ write_nodal_data() [2/3]

◆ write_nodal_data() [3/3]

◆ write_nodal_data_discontinuous()

Member Data Documentation

◆ _ascii_precision

◆ _is_parallel_format [1/2]

◆ _is_parallel_format [2/2]

◆ _obj

◆ _serial_only_needed_on_proc_0

◆ elems_of_dimension