libMesh::MeshInput< MT > Class Template Referenceabstract

#include <mesh_base.h>

Public Member Functions

virtual ~MeshInput ()
virtual void read (const std::string &)=0

Protected Member Functions

 MeshInput (bool is_parallel_format=false)
 MeshInput (MT &, const bool is_parallel_format=false)
MT & mesh ()
void set_n_partitions (unsigned int n_parts)
void skip_comment_lines (std::istream &in, const char comment_start)

Protected Attributes

std::vector< bool > elems_of_dimension

Private Attributes

MT * _obj
const bool _is_parallel_format

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.

Benjamin S. Kirk

Definition at line 59 of file mesh_base.h.

Constructor & Destructor Documentation

◆ MeshInput() [1/2]

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

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

Definition at line 130 of file mesh_input.h.

130  :
132  _obj (nullptr),
133  _is_parallel_format(is_parallel_format)
134 {
135 }
const bool _is_parallel_format
Definition: mesh_input.h:121
std::vector< bool > elems_of_dimension
Definition: mesh_input.h:97

◆ MeshInput() [2/2]

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

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.

141  :
143  _obj (&obj),
144  _is_parallel_format(is_parallel_format)
145 {
146  if (!_is_parallel_format && !this->mesh().is_serial())
147  {
148  if (this->mesh().processor_id() == 0)
149  {
150  libmesh_do_once(libMesh::out <<
151  "Warning: This MeshOutput subclass only supports meshes which have been serialized!"
152  << std::endl;);
153  }
154  }
155 }
const bool _is_parallel_format
Definition: mesh_input.h:121
std::vector< bool > elems_of_dimension
Definition: mesh_input.h:97
OStreamProxy out(std::cout)

◆ ~MeshInput()

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


Definition at line 161 of file mesh_input.h.

162 {
163 }

Member Function Documentation

◆ mesh()

template<class MT >
MT & libMesh::MeshInput< MT >::mesh ( )
The object as a writable reference.

Definition at line 169 of file mesh_input.h.

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::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().

170 {
171  if (_obj == nullptr)
172  libmesh_error_msg("ERROR: _obj should not be nullptr!");
173  return *_obj;
174 }

◆ read()

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

◆ set_n_partitions()

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

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.

91 { 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 

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

Definition at line 179 of file mesh_input.h.

181 {
182  char c, line[256];
184  while (in.get(c), c==comment_start)
185  in.getline (line, 255);
187  // put back first character of
188  // first non-comment line
189  in.putback (c);
190 }

Member Data Documentation

◆ _is_parallel_format

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

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

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

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: