Nektar::FieldUtils::OutputPts Class Reference

Converter from fld to pts. More...

#include <OutputPts.h>

Inheritance diagram for Nektar::FieldUtils::OutputPts:

Public Member Functions
	OutputPts (FieldSharedPtr f)
	~OutputPts () override
Public Member Functions inherited from Nektar::FieldUtils::OutputFileBase
	OutputFileBase (FieldSharedPtr f)
	~OutputFileBase () 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
std::string	v_GetModuleName () override
void	v_OutputFromPts (po::variables_map &vm) override
	Write from pts to output file. More...
void	v_OutputFromExp (po::variables_map &vm) override
	Write from m_exp to output file. More...
void	v_OutputFromData (po::variables_map &vm) override
	Write from data to output file. More...
fs::path	v_GetPath (std::string &filename, po::variables_map &vm) override
fs::path	v_GetFullOutName (std::string &filename, po::variables_map &vm) override
Protected Member Functions inherited from Nektar::FieldUtils::OutputFileBase
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
virtual void	v_OutputFromPts (po::variables_map &vm)=0
	Write from pts to output file. More...
virtual void	v_OutputFromExp (po::variables_map &vm)=0
	Write from m_exp to output file. More...
virtual void	v_OutputFromData (po::variables_map &vm)=0
	Write from data to output file. More...
virtual fs::path	v_GetPath (std::string &filename, po::variables_map &vm)
fs::path	GetPath (std::string &filename, po::variables_map &vm)
virtual fs::path	v_GetFullOutName (std::string &filename, po::variables_map &vm)
fs::path	GetFullOutName (std::string &filename, po::variables_map &vm)
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::OutputFileBase
bool	m_requireEquiSpaced
bool	m_prohibitWrite = false
bool	m_equispacedSetup = false
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

Converter from fld to pts.

Definition at line 45 of file OutputPts.h.

Constructor & Destructor Documentation

OutputPts()

Nektar::FieldUtils::OutputPts::OutputPts

(

FieldSharedPtr

f

)

Definition at line 58 of file OutputPts.cpp.

                                     : OutputFileBase(f)
{
}

~OutputPts()

Nektar::FieldUtils::OutputPts::~OutputPts ( )

override

Definition at line 62 of file OutputPts.cpp.

{
}

Member Function Documentation

create()

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

inlinestatic

Creates an instance of this class.

Definition at line 49 of file OutputPts.h.

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

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

v_GetFullOutName()

fs::path Nektar::FieldUtils::OutputPts::v_GetFullOutName ( std::string &  filename, po::variables_map &  vm  )

overrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::OutputFileBase.

Definition at line 130 of file OutputPts.cpp.

{
    return fs::path(filename);
}

v_GetModuleName()

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

inlineoverrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::OutputFileBase.

Definition at line 59 of file OutputPts.h.

    {
        return "OutputPts";
    }

v_GetPath()

fs::path Nektar::FieldUtils::OutputPts::v_GetPath ( std::string &  filename, po::variables_map &  vm  )

overrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::OutputFileBase.

Definition at line 124 of file OutputPts.cpp.

{
    return fs::path(filename);
}

v_OutputFromData()

void Nektar::FieldUtils::OutputPts::v_OutputFromData ( po::variables_map &  vm )

overrideprotectedvirtual

Write from data to output file.

Implements Nektar::FieldUtils::OutputFileBase.

Definition at line 119 of file OutputPts.cpp.

{
    NEKERROR(ErrorUtil::efatal, "OutputPts can't write using only FieldData.");
}

References Nektar::ErrorUtil::efatal, and NEKERROR.

v_OutputFromExp()

void Nektar::FieldUtils::OutputPts::v_OutputFromExp ( po::variables_map &  vm )

overrideprotectedvirtual

Write from m_exp to output file.

Implements Nektar::FieldUtils::OutputFileBase.

Definition at line 83 of file OutputPts.cpp.

{
    Array<OneD, Array<OneD, NekDouble>> tmp(m_f->m_exp[0]->GetCoordim(0) +
                                            m_f->m_variables.size());
 
    switch (m_f->m_exp[0]->GetCoordim(0))
    {
        case 1:
            tmp[0] = Array<OneD, NekDouble>(m_f->m_exp[0]->GetTotPoints());
            m_f->m_exp[0]->GetCoords(tmp[0]);
            break;
 
        case 2:
            tmp[1] = Array<OneD, NekDouble>(m_f->m_exp[0]->GetTotPoints());
            tmp[0] = Array<OneD, NekDouble>(m_f->m_exp[0]->GetTotPoints());
            m_f->m_exp[0]->GetCoords(tmp[0], tmp[1]);
            break;
 
        case 3:
            tmp[2] = Array<OneD, NekDouble>(m_f->m_exp[0]->GetTotPoints());
            tmp[1] = Array<OneD, NekDouble>(m_f->m_exp[0]->GetTotPoints());
            tmp[0] = Array<OneD, NekDouble>(m_f->m_exp[0]->GetTotPoints());
            m_f->m_exp[0]->GetCoords(tmp[0], tmp[1], tmp[2]);
            break;
    }
 
    for (int i = 0; i < m_f->m_variables.size(); ++i)
    {
        tmp[i + m_f->m_exp[0]->GetCoordim(0)] = m_f->m_exp[i]->GetPhys();
    }
    m_f->m_fieldPts = MemoryManager<LibUtilities::PtsField>::AllocateSharedPtr(
        m_f->m_exp[0]->GetCoordim(0), m_f->m_variables, tmp);
 
    v_OutputFromPts(vm);
}

References Nektar::MemoryManager< DataType >::AllocateSharedPtr(), Nektar::FieldUtils::Module::m_f, and v_OutputFromPts().

v_OutputFromPts()

void Nektar::FieldUtils::OutputPts::v_OutputFromPts ( po::variables_map &  vm )

overrideprotectedvirtual

Write from pts to output file.

Implements Nektar::FieldUtils::OutputFileBase.

Definition at line 66 of file OutputPts.cpp.

{
    // Extract the output filename and extension
    string filename = m_config["outfile"].as<string>();
 
    if (fs::path(filename).extension() == ".csv")
    {
        LibUtilities::CsvIO csvIO(m_f->m_comm);
        csvIO.Write(filename, m_f->m_fieldPts);
    }
    else
    {
        LibUtilities::PtsIO ptsIO(m_f->m_comm);
        ptsIO.Write(filename, m_f->m_fieldPts);
    }
}

References Nektar::FieldUtils::Module::m_config, Nektar::FieldUtils::Module::m_f, Nektar::LibUtilities::CsvIO::Write(), and Nektar::LibUtilities::PtsIO::Write().

Referenced by v_OutputFromExp().

Member Data Documentation

m_className

ModuleKey Nektar::FieldUtils::OutputPts::m_className

static

Initial value:

= {
    GetModuleFactory().RegisterCreatorFunction(ModuleKey(eOutputModule, "pts"),
                                               OutputPts::create,
                                               "Writes a pts file."),
    GetModuleFactory().RegisterCreatorFunction(ModuleKey(eOutputModule, "csv"),
                                               OutputPts::create,
                                               "Writes a csv file."),
}

Definition at line 53 of file OutputPts.h.