Nektar::FieldUtils::OutputStdOut Class Reference

#include <OutputStdOut.h>

Inheritance diagram for Nektar::FieldUtils::OutputStdOut:

Public Member Functions
	OutputStdOut (FieldSharedPtr f)
	~OutputStdOut () override
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)
virtual	~Module ()=default
void	Process (po::variables_map &vm)
std::string	GetModuleName ()
std::string	GetModuleDescription ()
const ConfigOption &	GetConfigOption (const std::string &key) const
ModulePriority	GetModulePriority ()
std::vector< ModuleKey >	GetModulePrerequisites ()
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	AddFile (std::string fileType, std::string fileName)
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< Module >	create (FieldSharedPtr f)
	Creates an instance of this class. More...

Static Public Attributes
static ModuleKey	m_className

Protected Member Functions
void	v_Process (po::variables_map &vm) override
	Write fld to output file. More...
std::string	v_GetModuleName () override
std::string	v_GetModuleDescription () override
ModulePriority	v_GetModulePriority () override
Protected Member Functions inherited from Nektar::FieldUtils::Module
	Module ()
virtual void	v_Process (po::variables_map &vm)
virtual std::string	v_GetModuleName ()
virtual std::string	v_GetModuleDescription ()
virtual ModulePriority	v_GetModulePriority ()
virtual std::vector< ModuleKey >	v_GetModulePrerequisites ()

Additional Inherited Members
Public Attributes inherited from Nektar::FieldUtils::Module
FieldSharedPtr	m_f
	Field object. More...
Protected Attributes inherited from Nektar::FieldUtils::OutputModule
std::ofstream	m_fldFile
	Output stream. More...
Protected Attributes inherited from Nektar::FieldUtils::Module
std::map< std::string, ConfigOption >	m_config
	List of configuration values. More...
std::set< std::string >	m_allowedFiles
	List of allowed file formats. More...

Detailed Description

Definition at line 44 of file OutputStdOut.h.

Constructor & Destructor Documentation

OutputStdOut()

Nektar::FieldUtils::OutputStdOut::OutputStdOut

(

FieldSharedPtr

f

)

Definition at line 51 of file OutputStdOut.cpp.

                                           : OutputModule(f)
{
}

~OutputStdOut()

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

override

Definition at line 55 of file OutputStdOut.cpp.

{
}

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 48 of file OutputStdOut.h.

    {
        return MemoryManager<OutputStdOut>::AllocateSharedPtr(f);
    }

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

v_GetModuleDescription()

std::string Nektar::FieldUtils::OutputStdOut::v_GetModuleDescription ( )

inlineoverrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 66 of file OutputStdOut.h.

    {
        return "Output written to StdOut";
    }

v_GetModuleName()

std::string Nektar::FieldUtils::OutputStdOut::v_GetModuleName ( )

inlineoverrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 61 of file OutputStdOut.h.

    {
        return "OutputStdOut";
    }

v_GetModulePriority()

ModulePriority Nektar::FieldUtils::OutputStdOut::v_GetModulePriority ( )

inlineoverrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 71 of file OutputStdOut.h.

    {
        return eOutput;
    }

References Nektar::FieldUtils::eOutput.

v_Process()

void Nektar::FieldUtils::OutputStdOut::v_Process ( po::variables_map &  vm )

overrideprotectedvirtual

Write fld to output file.

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 59 of file OutputStdOut.cpp.

{
}

Member Data Documentation

m_className

ModuleKey Nektar::FieldUtils::OutputStdOut::m_className

static

Initial value:

=
    GetModuleFactory().RegisterCreatorFunction(
        ModuleKey(eOutputModule, "stdout"), OutputStdOut::create,
        "Writes to stdout")

Definition at line 52 of file OutputStdOut.h.