libMesh
Public Member Functions | Protected Member Functions | Protected Attributes | Private Attributes | List of all members
libMesh::MeshOutput< MT > Class Template Referenceabstract

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

#include <mesh_output.h>

Public Member Functions

virtual ~MeshOutput ()
 Destructor. More...
 
virtual void write (const std::string &)=0
 This method implements writing a mesh to a specified file. More...
 
virtual void write_equation_systems (const std::string &, const EquationSystems &, const std::set< std::string > *system_names=libmesh_nullptr)
 This method implements writing a mesh with data to a specified file where the data is taken from the EquationSystems object. More...
 
virtual void write_nodal_data (const std::string &, const std::vector< Number > &, const std::vector< std::string > &)
 This method implements writing a mesh with nodal data to a specified file where the nodal data and variable names are provided. More...
 
virtual void write_nodal_data (const std::string &, const NumericVector< Number > &, const std::vector< std::string > &)
 This method should be overridden by "parallel" output formats for writing nodal data. More...
 
unsigned intascii_precision ()
 Return/set the precision to use when writing ASCII files. More...
 

Protected Member Functions

 MeshOutput (const bool is_parallel_format=false, const bool serial_only_needed_on_proc_0=false)
 Default constructor. More...
 
 MeshOutput (const MT &, const bool is_parallel_format=false, const bool serial_only_needed_on_proc_0=false)
 Constructor. More...
 
const MT & mesh () const
 

Protected Attributes

const bool _is_parallel_format
 Flag specifying whether this format is parallel-capable. More...
 
const bool _serial_only_needed_on_proc_0
 Flag specifying whether this format can be written by only serializing the mesh to processor zero. More...
 

Private Attributes

const MT *const _obj
 A pointer to a constant object. More...
 
unsigned int _ascii_precision
 Precision to use when writing ASCII files. More...
 

Detailed Description

template<class MT>
class libMesh::MeshOutput< MT >

This class defines an abstract interface for Mesh output.

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

Author
Benjamin S. Kirk
Date
2004

Definition at line 53 of file mesh_output.h.

Constructor & Destructor Documentation

template<class MT >
libMesh::MeshOutput< MT >::MeshOutput ( const bool  is_parallel_format = false,
const bool  serial_only_needed_on_proc_0 = false 
)
explicitprotected

Default constructor.

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

Definition at line 176 of file mesh_output.h.

176  :
177  _is_parallel_format(is_parallel_format),
178  _serial_only_needed_on_proc_0(serial_only_needed_on_proc_0),
180  _ascii_precision (std::numeric_limits<Real>::digits10 + 2)
181 {}
const MT *const _obj
A pointer to a constant object.
Definition: mesh_output.h:159
const bool _is_parallel_format
Flag specifying whether this format is parallel-capable.
Definition: mesh_output.h:141
const class libmesh_nullptr_t libmesh_nullptr
unsigned int _ascii_precision
Precision to use when writing ASCII files.
Definition: mesh_output.h:164
const bool _serial_only_needed_on_proc_0
Flag specifying whether this format can be written by only serializing the mesh to processor zero...
Definition: mesh_output.h:150
template<class MT>
libMesh::MeshOutput< MT >::MeshOutput ( const MT &  obj,
const bool  is_parallel_format = false,
const bool  serial_only_needed_on_proc_0 = false 
)
explicitprotected

Constructor.

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

Definition at line 187 of file mesh_output.h.

References libMesh::MeshOutput< MT >::_is_parallel_format, libMesh::MeshOutput< MT >::mesh(), libMesh::out, and libMesh::processor_id().

187  :
188  _is_parallel_format(is_parallel_format),
189  _serial_only_needed_on_proc_0(serial_only_needed_on_proc_0),
190  _obj (&obj),
191  _ascii_precision (std::numeric_limits<Real>::digits10 + 2)
192 {
193  if (!_is_parallel_format && !this->mesh().is_serial())
194  {
195  if (this->mesh().processor_id() == 0)
196  {
197  libmesh_do_once(libMesh::out <<
198  "Warning: This MeshOutput subclass only supports meshes which have been serialized!"
199  << std::endl;);
200  }
201  }
202 }
const MT *const _obj
A pointer to a constant object.
Definition: mesh_output.h:159
const bool _is_parallel_format
Flag specifying whether this format is parallel-capable.
Definition: mesh_output.h:141
const MT & mesh() const
Definition: mesh_output.h:216
unsigned int _ascii_precision
Precision to use when writing ASCII files.
Definition: mesh_output.h:164
OStreamProxy out
const bool _serial_only_needed_on_proc_0
Flag specifying whether this format can be written by only serializing the mesh to processor zero...
Definition: mesh_output.h:150
processor_id_type processor_id()
Definition: libmesh_base.h:96
template<class MT >
libMesh::MeshOutput< MT >::~MeshOutput ( )
virtual

Destructor.

Definition at line 208 of file mesh_output.h.

209 {
210 }

Member Function Documentation

template<class MT >
unsigned int & libMesh::MeshOutput< MT >::ascii_precision ( )

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

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

Definition at line 226 of file mesh_output.h.

References libMesh::MeshOutput< MT >::_ascii_precision.

Referenced by libMesh::MeshOutput< MeshBase >::write_nodal_data().

227 {
228  return _ascii_precision;
229 }
unsigned int _ascii_precision
Precision to use when writing ASCII files.
Definition: mesh_output.h:164
template<class MT >
const MT & libMesh::MeshOutput< MT >::mesh ( ) const
protected
Returns
The object as a read-only reference.

Definition at line 216 of file mesh_output.h.

References libMesh::MeshOutput< MT >::_obj, and libMesh::libmesh_assert().

Referenced by libMesh::VTKIO::cells_to_vtk(), libMesh::TecplotIO::elem_dimension(), libMesh::UNVIO::elements_out(), libMesh::MeshOutput< MT >::MeshOutput(), libMesh::UNVIO::nodes_out(), libMesh::VTKIO::nodes_to_vtk(), libMesh::Nemesis_IO::prepare_to_write_nodal_data(), libMesh::FroIO::write(), libMesh::PostscriptIO::write(), libMesh::TetGenIO::write(), libMesh::Nemesis_IO::write(), libMesh::ExodusII_IO::write(), libMesh::CheckpointIO::write(), libMesh::XdrIO::write(), libMesh::MEDITIO::write_ascii(), libMesh::TecplotIO::write_ascii(), libMesh::GMVIO::write_ascii_new_impl(), libMesh::GMVIO::write_ascii_old_impl(), libMesh::CheckpointIO::write_bcs(), libMesh::TecplotIO::write_binary(), libMesh::GMVIO::write_binary(), libMesh::GMVIO::write_discontinuous_gmv(), libMesh::ExodusII_IO::write_element_data(), libMesh::EnsightIO::write_geometry_ascii(), libMesh::UCDIO::write_implementation(), libMesh::GmshIO::write_mesh(), libMesh::UCDIO::write_nodal_data(), libMesh::VTKIO::write_nodal_data(), libMesh::MeshOutput< MeshBase >::write_nodal_data(), libMesh::ExodusII_IO::write_nodal_data(), libMesh::ExodusII_IO::write_nodal_data_common(), libMesh::ExodusII_IO::write_nodal_data_discontinuous(), libMesh::CheckpointIO::write_nodesets(), libMesh::XdrIO::write_parallel(), libMesh::GmshIO::write_post(), libMesh::EnsightIO::write_scalar_ascii(), libMesh::XdrIO::write_serialized_bcs_helper(), libMesh::XdrIO::write_serialized_connectivity(), libMesh::XdrIO::write_serialized_nodes(), libMesh::XdrIO::write_serialized_nodesets(), libMesh::XdrIO::write_serialized_subdomain_names(), libMesh::GnuPlotIO::write_solution(), libMesh::CheckpointIO::write_subdomain_names(), and libMesh::EnsightIO::write_vector_ascii().

217 {
219  return *_obj;
220 }
const MT *const _obj
A pointer to a constant object.
Definition: mesh_output.h:159
libmesh_assert(j)
template<class MT>
virtual void libMesh::MeshOutput< MT >::write ( const std::string &  )
pure virtual
template<class MT >
void libMesh::MeshOutput< MT >::write_equation_systems ( const std::string &  fname,
const EquationSystems es,
const std::set< std::string > *  system_names = libmesh_nullptr 
)
virtual

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

Reimplemented in libMesh::NameBasedIO.

Definition at line 31 of file mesh_output.C.

References libMesh::EquationSystems::build_parallel_solution_vector(), libMesh::EquationSystems::build_solution_vector(), libMesh::EquationSystems::build_variable_names(), libMesh::EquationSystems::get_mesh(), libMesh::libmesh_assert(), libmesh_nullptr, and libMesh::out.

Referenced by main(), libMesh::ErrorVector::plot_error(), libMesh::RBEIMConstruction::plot_parametrized_functions_in_training_set(), scale_mesh_and_plot(), WriteVecAndScalar::testWrite(), transform_mesh_and_plot(), libMesh::TransientRBConstruction::truth_solve(), libMesh::RBEIMConstruction::truth_solve(), libMesh::RBConstruction::truth_solve(), libMesh::NameBasedIO::write_equation_systems(), and write_output().

34 {
35  LOG_SCOPE("write_equation_systems()", "MeshOutput");
36 
37  // We may need to gather and/or renumber a DistributedMesh to output
38  // it, making that const qualifier in our constructor a dirty lie
39  MT & my_mesh = const_cast<MT &>(*_obj);
40 
41  // If we're asked to write data that's associated with a different
42  // mesh, output files full of garbage are the result.
43  libmesh_assert_equal_to(&es.get_mesh(), _obj);
44 
45  // A non-renumbered mesh may not have a contiguous numbering, and
46  // that needs to be fixed before we can build a solution vector.
47  if (my_mesh.max_elem_id() != my_mesh.n_elem() ||
48  my_mesh.max_node_id() != my_mesh.n_nodes())
49  {
50  // If we were allowed to renumber then we should have already
51  // been properly renumbered...
52  libmesh_assert(!my_mesh.allow_renumbering());
53 
54  libmesh_do_once(libMesh::out <<
55  "Warning: This MeshOutput subclass only supports meshes which are contiguously renumbered!"
56  << std::endl;);
57 
58  my_mesh.allow_renumbering(true);
59 
60  my_mesh.renumber_nodes_and_elements();
61 
62  // Not sure what good going back to false will do here, the
63  // renumbering horses have already left the barn...
64  my_mesh.allow_renumbering(false);
65  }
66 
67  MeshSerializer serialize(const_cast<MT &>(*_obj), !_is_parallel_format, _serial_only_needed_on_proc_0);
68 
69  // Build the list of variable names that will be written.
70  std::vector<std::string> names;
71  es.build_variable_names (names, libmesh_nullptr, system_names);
72 
74  {
75  // Build the nodal solution values & get the variable
76  // names from the EquationSystems object
77  std::vector<Number> soln;
78  es.build_solution_vector (soln, system_names);
79 
80  this->write_nodal_data (fname, soln, names);
81  }
82  else // _is_parallel_format
83  {
84  UniquePtr<NumericVector<Number>> parallel_soln =
85  es.build_parallel_solution_vector(system_names);
86 
87  this->write_nodal_data (fname, *parallel_soln, names);
88  }
89 }
virtual void write_nodal_data(const std::string &, const std::vector< Number > &, const std::vector< std::string > &)
This method implements writing a mesh with nodal data to a specified file where the nodal data and va...
Definition: mesh_output.h:96
const MT *const _obj
A pointer to a constant object.
Definition: mesh_output.h:159
const bool _is_parallel_format
Flag specifying whether this format is parallel-capable.
Definition: mesh_output.h:141
const class libmesh_nullptr_t libmesh_nullptr
libmesh_assert(j)
OStreamProxy out
const bool _serial_only_needed_on_proc_0
Flag specifying whether this format can be written by only serializing the mesh to processor zero...
Definition: mesh_output.h:150
template<class MT>
virtual void libMesh::MeshOutput< MT >::write_nodal_data ( const std::string &  ,
const std::vector< Number > &  ,
const std::vector< std::string > &   
)
virtual

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

Reimplemented in libMesh::ExodusII_IO, libMesh::NameBasedIO, libMesh::GmshIO, libMesh::Nemesis_IO, libMesh::VTKIO, libMesh::UCDIO, libMesh::GMVIO, libMesh::MEDITIO, libMesh::GnuPlotIO, and libMesh::TecplotIO.

Definition at line 96 of file mesh_output.h.

Referenced by libMesh::MeshOutput< MeshBase >::write_nodal_data().

99  { libmesh_not_implemented(); }
template<class MT >
void libMesh::MeshOutput< MT >::write_nodal_data ( const std::string &  fname,
const NumericVector< Number > &  parallel_soln,
const std::vector< std::string > &  names 
)
virtual

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 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 94 of file mesh_output.C.

References libMesh::NumericVector< T >::localize().

97 {
98  // This is the fallback implementation for parallel I/O formats that
99  // do not yet implement proper writing in parallel, and instead rely
100  // on the full solution vector being available on all processors.
101  std::vector<Number> soln;
102  parallel_soln.localize(soln);
103  this->write_nodal_data(fname, soln, names);
104 }
virtual void write_nodal_data(const std::string &, const std::vector< Number > &, const std::vector< std::string > &)
This method implements writing a mesh with nodal data to a specified file where the nodal data and va...
Definition: mesh_output.h:96
virtual void localize(std::vector< T > &v_local) const =0
Creates a copy of the global vector in the local vector v_local.

Member Data Documentation

template<class MT>
unsigned int libMesh::MeshOutput< MT >::_ascii_precision
private

Precision to use when writing ASCII files.

Definition at line 164 of file mesh_output.h.

Referenced by libMesh::MeshOutput< MT >::ascii_precision().

template<class MT>
const bool libMesh::MeshOutput< MT >::_is_parallel_format
protected

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 141 of file mesh_output.h.

Referenced by libMesh::MeshOutput< MT >::MeshOutput().

template<class MT>
const MT* const libMesh::MeshOutput< MT >::_obj
private

A pointer to a constant object.

This allows us to write the object to file.

Definition at line 159 of file mesh_output.h.

Referenced by libMesh::MeshOutput< MT >::mesh().

template<class MT>
const bool libMesh::MeshOutput< MT >::_serial_only_needed_on_proc_0
protected

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 150 of file mesh_output.h.


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