Nektar++
Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
Nektar::FieldUtils::OutputStdOut Class Reference

#include <OutputStdOut.h>

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

Public Member Functions

 OutputStdOut (FieldSharedPtr f)
 
virtual ~OutputStdOut ()
 
virtual void Process (po::variables_map &vm)
 Write fld to output file. More...
 
virtual std::string GetModuleName ()
 
virtual std::string GetModuleDescription ()
 
virtual ModulePriority GetModulePriority ()
 
- Public Member Functions inherited from Nektar::FieldUtils::OutputModule
 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)
 
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)
 

Static Public Member Functions

static std::shared_ptr< Modulecreate (FieldSharedPtr f)
 Creates an instance of this class. More...
 

Static Public Attributes

static ModuleKey m_className
 

Additional Inherited Members

- Protected Member Functions inherited from Nektar::FieldUtils::Module
 Module ()
 
- Protected Attributes inherited from Nektar::FieldUtils::OutputModule
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...
 

Detailed Description

Definition at line 46 of file OutputStdOut.h.

Constructor & Destructor Documentation

◆ OutputStdOut()

Nektar::FieldUtils::OutputStdOut::OutputStdOut ( FieldSharedPtr  f)

Definition at line 55 of file OutputStdOut.cpp.

55  : OutputModule(f)
56 {
57 }

◆ ~OutputStdOut()

Nektar::FieldUtils::OutputStdOut::~OutputStdOut ( )
virtual

Definition at line 59 of file OutputStdOut.cpp.

60 {
61 }

Member Function Documentation

◆ create()

static std::shared_ptr<Module> Nektar::FieldUtils::OutputStdOut::create ( FieldSharedPtr  f)
inlinestatic

Creates an instance of this class.

Definition at line 50 of file OutputStdOut.h.

References Nektar::MemoryManager< DataType >::AllocateSharedPtr().

51  {
53  }
static std::shared_ptr< DataType > AllocateSharedPtr(const Args &...args)
Allocate a shared pointer from the memory pool.

◆ GetModuleDescription()

virtual std::string Nektar::FieldUtils::OutputStdOut::GetModuleDescription ( )
inlinevirtual

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 67 of file OutputStdOut.h.

68  {
69  return "Output written to StdOut";
70  }

◆ GetModuleName()

virtual std::string Nektar::FieldUtils::OutputStdOut::GetModuleName ( )
inlinevirtual

Implements Nektar::FieldUtils::Module.

Definition at line 62 of file OutputStdOut.h.

63  {
64  return "OutputStdOut";
65  }

◆ GetModulePriority()

virtual ModulePriority Nektar::FieldUtils::OutputStdOut::GetModulePriority ( )
inlinevirtual

Implements Nektar::FieldUtils::Module.

Definition at line 72 of file OutputStdOut.h.

References Nektar::FieldUtils::eOutput.

73  {
74  return eOutput;
75  }

◆ Process()

void Nektar::FieldUtils::OutputStdOut::Process ( po::variables_map &  vm)
virtual

Write fld to output file.

Implements Nektar::FieldUtils::Module.

Definition at line 63 of file OutputStdOut.cpp.

64 {
65  boost::ignore_unused(vm);
66 }

Member Data Documentation

◆ m_className

ModuleKey Nektar::FieldUtils::OutputStdOut::m_className
static
Initial value:

Definition at line 54 of file OutputStdOut.h.