Nektar::FieldUtils::OutputXml Class Reference

Converter from fld to vtk. More...

#include <OutputXml.h>

Inheritance diagram for Nektar::FieldUtils::OutputXml:

Public Member Functions
	OutputXml (FieldSharedPtr f)
virtual	~OutputXml ()
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< Module >	create (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, ConfigOption >	m_config
	List of configuration values. More...

Detailed Description

Converter from fld to vtk.

Definition at line 46 of file OutputXml.h.

Constructor & Destructor Documentation

OutputXml()

Nektar::FieldUtils::OutputXml::OutputXml

(

FieldSharedPtr

f

)

Definition at line 51 of file OutputXml.cpp.

                                     : OutputModule(f)
{
}

~OutputXml()

Nektar::FieldUtils::OutputXml::~OutputXml ( )

virtual

Definition at line 55 of file OutputXml.cpp.

{
}

Member Function Documentation

create()

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

inlinestatic

Creates an instance of this class.

Definition at line 50 of file OutputXml.h.

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

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

GetModuleDescription()

virtual std::string Nektar::FieldUtils::OutputXml::GetModuleDescription ( )

inlinevirtual

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 67 of file OutputXml.h.

    {
        return "Writing file";
    }

GetModuleName()

virtual std::string Nektar::FieldUtils::OutputXml::GetModuleName ( )

inlinevirtual

Implements Nektar::FieldUtils::Module.

Definition at line 62 of file OutputXml.h.

    {
        return "OutputXml";
    }

GetModulePriority()

virtual ModulePriority Nektar::FieldUtils::OutputXml::GetModulePriority ( )

inlinevirtual

Implements Nektar::FieldUtils::Module.

Definition at line 72 of file OutputXml.h.

References Nektar::FieldUtils::eOutput.

    {
        return eOutput;
    }

Process()

void Nektar::FieldUtils::OutputXml::Process ( po::variables_map &  vm )

virtual

Write fld to output file.

Implements Nektar::FieldUtils::Module.

Definition at line 59 of file OutputXml.cpp.

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

{
    boost::ignore_unused(vm);

    if (!m_f->m_exp.size()) // do nothing if no expansion defined
    {
        return;
    }

    // Extract the output filename and extension
    string filename = m_config["outfile"].as<string>();

    m_f->m_graph->WriteGeometry(filename);
    cout << "Written file: " << filename << endl;
}

Member Data Documentation

m_className

ModuleKey Nektar::FieldUtils::OutputXml::m_className

static

Initial value:

= GetModuleFactory().RegisterCreatorFunction(
    ModuleKey(eOutputModule, "xml"), OutputXml::create, "Writes an XML file.")

Definition at line 54 of file OutputXml.h.