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

Abstract base class for output modules. More...

#include <Module.h>

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

Public Member Functions

 OutputModule (FieldSharedPtr p_f)
 
FIELD_UTILS_EXPORT void OpenStream ()
 Open a file for output. More...
 
- Public Member Functions inherited from Nektar::FieldUtils::Module
FIELD_UTILS_EXPORT Module (FieldSharedPtr p_f)
 
virtual void Process (po::variables_map &vm)=0
 
virtual std::string GetModuleName ()=0
 
virtual std::string GetModuleDescription ()
 
virtual ModulePriority GetModulePriority ()=0
 
FIELD_UTILS_EXPORT void RegisterConfig (std::string key, std::string value="")
 Register a configuration option with a module. More...
 
FIELD_UTILS_EXPORT void PrintConfig ()
 Print out all configuration options for a module. More...
 
FIELD_UTILS_EXPORT void SetDefaults ()
 Sets default configuration options for those which have not been set. More...
 
FIELD_UTILS_EXPORT void EvaluateTriFieldAtEquiSpacedPts (LocalRegions::ExpansionSharedPtr &exp, const Array< OneD, const NekDouble > &infield, Array< OneD, NekDouble > &outfield)
 

Protected Attributes

std::ofstream m_fldFile
 Output stream. More...
 
- Protected Attributes inherited from Nektar::FieldUtils::Module
FieldSharedPtr m_f
 Field object. More...
 
std::map< std::string, ConfigOptionm_config
 List of configuration values. More...
 

Additional Inherited Members

- Protected Member Functions inherited from Nektar::FieldUtils::Module
 Module ()
 

Detailed Description

Abstract base class for output modules.

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

Definition at line 260 of file FieldUtils/Module.h.

Constructor & Destructor Documentation

◆ OutputModule()

Nektar::FieldUtils::OutputModule::OutputModule ( FieldSharedPtr  p_f)

Definition at line 67 of file FieldUtils/Module.cpp.

References Nektar::FieldUtils::Module::m_config.

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

Member Function Documentation

◆ OpenStream()

void Nektar::FieldUtils::OutputModule::OpenStream ( )

Open a file for output.

Definition at line 86 of file FieldUtils/Module.cpp.

References Nektar::FieldUtils::Module::m_config, and m_fldFile.

87 {
88  string fname = m_config["outfile"].as<string>();
89  m_fldFile.open(fname.c_str());
90  if (!m_fldFile.good())
91  {
92  cerr << "Error opening file: " << fname << endl;
93  abort();
94  }
95 }
std::map< std::string, ConfigOption > m_config
List of configuration values.
std::ofstream m_fldFile
Output stream.

Member Data Documentation

◆ m_fldFile

std::ofstream Nektar::FieldUtils::OutputModule::m_fldFile
protected

Output stream.

Definition at line 268 of file FieldUtils/Module.h.

Referenced by OpenStream().