libMesh::MeshInput< MT > Class Template Reference

This class defines an abstract interface for Mesh input. More...

#include <mesh_base.h>

Public Member Functions
virtual	~MeshInput ()
	Destructor. More...
virtual void	read (const std::string &)=0
	This method implements reading a mesh from a specified file. More...

Protected Member Functions
	MeshInput (bool is_parallel_format=false)
	Default constructor. More...
	MeshInput (MT &, const bool is_parallel_format=false)
	Constructor. More...
MT &	mesh ()
void	set_n_partitions (unsigned int n_parts)
	Sets the number of partitions in the mesh. More...
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. More...

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

Private Attributes
MT *	_obj
	A pointer to a non-const object object. More...
const bool	_is_parallel_format
	Flag specifying whether this format is parallel-capable. More...

Detailed Description

template<class MT>
class libMesh::MeshInput< MT >

This class defines an abstract interface for Mesh input.

Specific classes derived from this class actually implement reading various mesh formats.

Author

Benjamin S. Kirk

Date

2004

Definition at line 60 of file mesh_base.h.

Constructor & Destructor Documentation

MeshInput() [1/2]

template<class MT >

libMesh::MeshInput< MT >::MeshInput ( bool  is_parallel_format = false )

inlineexplicitprotected

Default constructor.

Will set the _obj to nullptr, effectively rendering this object useless.

Definition at line 130 of file mesh_input.h.

                                                       :
  elems_of_dimension(),
  _obj (nullptr),
  _is_parallel_format(is_parallel_format)
{
}

MeshInput() [2/2]

template<class MT>

libMesh::MeshInput< MT >::MeshInput ( MT &  obj, const bool  is_parallel_format = false  )

inlineexplicitprotected

Constructor.

Takes a writable reference to an object. This is the constructor required to read an object.

Definition at line 141 of file mesh_input.h.

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

~MeshInput()

template<class MT >

libMesh::MeshInput< MT >::~MeshInput ( )

inlinevirtual

Destructor.

Definition at line 161 of file mesh_input.h.

{
}

Member Function Documentation

mesh()

template<class MT >

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

inlineprotected

Returns

The object as a writable reference.

Definition at line 169 of file mesh_input.h.

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

Referenced by libMesh::GMVIO::_read_nodes(), libMesh::GMVIO::_read_one_cell(), libMesh::AbaqusIO::assign_boundary_node_ids(), libMesh::AbaqusIO::assign_sideset_ids(), libMesh::AbaqusIO::assign_subdomain_ids(), libMesh::ExodusII_IO::copy_elemental_solution(), libMesh::ExodusII_IO::copy_nodal_solution(), libMesh::GMVIO::copy_nodal_solution(), libMesh::TetGenIO::element_in(), libMesh::UNVIO::elements_in(), libMesh::UNVIO::groups_in(), libMesh::TetGenIO::node_in(), libMesh::UNVIO::nodes_in(), libMesh::AbaqusIO::read(), libMesh::NameBasedIO::read(), libMesh::TetGenIO::read(), libMesh::Nemesis_IO::read(), libMesh::ExodusII_IO::read(), libMesh::GMVIO::read(), libMesh::XdrIO::read(), libMesh::CheckpointIO::read(), libMesh::VTKIO::read(), libMesh::CheckpointIO::read_bcs(), libMesh::CheckpointIO::read_connectivity(), libMesh::ExodusII_IO::read_elemental_variable(), libMesh::AbaqusIO::read_elements(), libMesh::CheckpointIO::read_header(), libMesh::XdrIO::read_header(), libMesh::UCDIO::read_implementation(), libMesh::UNVIO::read_implementation(), libMesh::DynaIO::read_mesh(), libMesh::GmshIO::read_mesh(), libMesh::AbaqusIO::read_nodes(), libMesh::CheckpointIO::read_nodes(), libMesh::CheckpointIO::read_nodesets(), libMesh::CheckpointIO::read_remote_elem(), libMesh::XdrIO::read_serialized_bcs_helper(), libMesh::XdrIO::read_serialized_connectivity(), libMesh::XdrIO::read_serialized_nodes(), libMesh::XdrIO::read_serialized_nodesets(), libMesh::XdrIO::read_serialized_subdomain_names(), libMesh::OFFIO::read_stream(), libMesh::MatlabIO::read_stream(), libMesh::CheckpointIO::read_subdomain_names(), libMesh::MeshInput< MeshBase >::set_n_partitions(), libMesh::NameBasedIO::write(), and libMesh::NameBasedIO::write_nodal_data().

read()

template<class MT>

virtual void libMesh::MeshInput< MT >::read ( const std::string &  )

pure virtual

This method implements reading a mesh from a specified file.

Implemented in libMesh::MatlabIO, libMesh::DynaIO, libMesh::GmshIO, libMesh::ExodusII_IO, libMesh::AbaqusIO, libMesh::OFFIO, libMesh::GMVIO, libMesh::NameBasedIO, libMesh::CheckpointIO, libMesh::Nemesis_IO, libMesh::VTKIO, libMesh::XdrIO, libMesh::UCDIO, libMesh::UNVIO, and libMesh::TetGenIO.

set_n_partitions()

template<class MT>

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

inlineprotected

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 91 of file mesh_input.h.

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

skip_comment_lines()

template<class MT >

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

protected

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

Definition at line 179 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);
}

Member Data Documentation

_is_parallel_format

template<class MT>

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

private

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 121 of file mesh_input.h.

_obj

template<class MT>

MT* libMesh::MeshInput< MT >::_obj

private

A pointer to a non-const object object.

This allows us to read the object from file.

Definition at line 114 of file mesh_input.h.

elems_of_dimension

template<class MT>

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

protected

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

Definition at line 97 of file mesh_input.h.

---

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

• include/mesh/mesh_base.h
• include/mesh/mesh_input.h