Nektar++
Public Member Functions | Protected Attributes | List of all members
Nektar::NekMeshUtils::OutputModule Class Reference

Abstract base class for output modules. More...

#include <Module.h>

Inheritance diagram for Nektar::NekMeshUtils::OutputModule:
[legend]

Public Member Functions

NEKMESHUTILS_EXPORT OutputModule (MeshSharedPtr p_m)
 
NEKMESHUTILS_EXPORT void OpenStream ()
 Open a file for output. More...
 
- Public Member Functions inherited from Nektar::NekMeshUtils::Module
NEKMESHUTILS_EXPORT Module (MeshSharedPtr p_m)
 
virtual NEKMESHUTILS_EXPORT void Process ()=0
 
NEKMESHUTILS_EXPORT void RegisterConfig (std::string key, std::string value=std::string())
 Register a configuration option with a module. More...
 
NEKMESHUTILS_EXPORT void PrintConfig ()
 Print out all configuration options for a module. More...
 
NEKMESHUTILS_EXPORT void SetDefaults ()
 Sets default configuration options for those which have not been set. More...
 
NEKMESHUTILS_EXPORT MeshSharedPtr GetMesh ()
 
virtual NEKMESHUTILS_EXPORT void ProcessVertices ()
 Extract element vertices. More...
 
virtual NEKMESHUTILS_EXPORT void ProcessEdges (bool ReprocessEdges=true)
 Extract element edges. More...
 
virtual NEKMESHUTILS_EXPORT void ProcessFaces (bool ReprocessFaces=true)
 Extract element faces. More...
 
virtual NEKMESHUTILS_EXPORT void ProcessElements ()
 Generate element IDs. More...
 
virtual NEKMESHUTILS_EXPORT void ProcessComposites ()
 Generate composites. More...
 
virtual NEKMESHUTILS_EXPORT void ClearElementLinks ()
 

Protected Attributes

io::filtering_ostream m_mshFile
 Output stream. More...
 
std::ofstream m_mshFileStream
 Input stream. More...
 
- Protected Attributes inherited from Nektar::NekMeshUtils::Module
MeshSharedPtr m_mesh
 Mesh object. More...
 
std::map< std::string, ConfigOptionm_config
 List of configuration values. More...
 

Additional Inherited Members

- Protected Member Functions inherited from Nektar::NekMeshUtils::Module
NEKMESHUTILS_EXPORT void ReorderPrisms (PerMap &perFaces)
 Reorder node IDs so that prisms and tetrahedra are aligned correctly. More...
 
NEKMESHUTILS_EXPORT void PrismLines (int prism, PerMap &perFaces, std::set< int > &prismsDone, std::vector< ElementSharedPtr > &line)
 

Detailed Description

Abstract base class for output modules.

Output modules take the mesh #m and write to the file specified by the stream m_mshFile.

Definition at line 241 of file NekMeshUtils/Module/Module.h.

Constructor & Destructor Documentation

◆ OutputModule()

Nektar::NekMeshUtils::OutputModule::OutputModule ( MeshSharedPtr  p_m)

Definition at line 69 of file NekMeshUtils/Module/Module.cpp.

References Nektar::NekMeshUtils::Module::m_config.

69  : Module(m)
70 {
71  m_config["outfile"] = ConfigOption(false, "", "Output filename.");
72 }
std::map< std::string, ConfigOption > m_config
List of configuration values.
NEKMESHUTILS_EXPORT Module(MeshSharedPtr p_m)

Member Function Documentation

◆ OpenStream()

void Nektar::NekMeshUtils::OutputModule::OpenStream ( )

Open a file for output.

Definition at line 103 of file NekMeshUtils/Module/Module.cpp.

References Nektar::NekMeshUtils::Module::m_config, m_mshFile, and m_mshFileStream.

Referenced by Nektar::Utilities::OutputSTL::Process(), and Nektar::Utilities::OutputGmsh::Process().

104 {
105  string fname = m_config["outfile"].as<string>();
106 
107  if (fname.size() > 3 && fname.substr(fname.size() - 3, 3) == ".gz")
108  {
109  m_mshFileStream.open(fname.c_str(), ios_base::out | ios_base::binary);
110  m_mshFile.push(io::gzip_compressor());
112  }
113  else
114  {
115  m_mshFileStream.open(fname.c_str());
117  }
118 
119  if (!m_mshFile.good())
120  {
121  cerr << "Error opening file: " << fname << endl;
122  abort();
123  }
124 }
io::filtering_ostream m_mshFile
Output stream.
std::map< std::string, ConfigOption > m_config
List of configuration values.

Member Data Documentation

◆ m_mshFile

io::filtering_ostream Nektar::NekMeshUtils::OutputModule::m_mshFile
protected

◆ m_mshFileStream

std::ofstream Nektar::NekMeshUtils::OutputModule::m_mshFileStream
protected

Input stream.

Definition at line 252 of file NekMeshUtils/Module/Module.h.

Referenced by Nektar::NekMeshUtils::InputModule::OpenStream(), and OpenStream().