Nektar::FieldUtils::InputPts Class Reference

#include <InputPts.h>

Inheritance diagram for Nektar::FieldUtils::InputPts:

Public Member Functions
	InputPts (FieldSharedPtr f)
	Set up InputPts object. More...
	~InputPts () override
Public Member Functions inherited from Nektar::FieldUtils::InputModule
	InputModule (FieldSharedPtr p_m)
void	PrintSummary ()
	Print a brief summary of information. 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 ModuleSharedPtr	create (FieldSharedPtr f)
	Creates an instance of this class. More...
Static Public Member Functions inherited from Nektar::FieldUtils::InputModule
static FIELD_UTILS_EXPORT std::string	GuessFormat (std::string fileName)
	Tries to guess the format of the input file. More...

Static Public Attributes
static ModuleKey	m_className []
	ModuleKey for class. More...

Protected Member Functions
void	v_Process (po::variables_map &vm) override
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::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

Input module for Xml files.

Definition at line 46 of file InputPts.h.

Constructor & Destructor Documentation

InputPts()

Nektar::FieldUtils::InputPts::InputPts

(

FieldSharedPtr

f

)

Set up InputPts object.

Definition at line 65 of file InputPts.cpp.

                                   : InputModule(f)
{
    m_allowedFiles.insert("pts");
    m_allowedFiles.insert("csv");
}

References Nektar::FieldUtils::Module::m_allowedFiles.

~InputPts()

Nektar::FieldUtils::InputPts::~InputPts ( )

override

Definition at line 74 of file InputPts.cpp.

{
}

Member Function Documentation

create()

static ModuleSharedPtr Nektar::FieldUtils::InputPts::create ( FieldSharedPtr  f )

inlinestatic

Creates an instance of this class.

Definition at line 53 of file InputPts.h.

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

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

v_GetModuleDescription()

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

inlineoverrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 68 of file InputPts.h.

    {
        return "Processing input pts file";
    }

v_GetModuleName()

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

inlineoverrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 63 of file InputPts.h.

    {
        return "InputPts";
    }

v_GetModulePriority()

ModulePriority Nektar::FieldUtils::InputPts::v_GetModulePriority ( )

inlineoverrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 73 of file InputPts.h.

    {
        return eCreatePts;
    }

References Nektar::FieldUtils::eCreatePts.

v_Process()

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

overrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 81 of file InputPts.cpp.

{
    string inFile = m_config["infile"].as<string>();
 
    // Determine appropriate field input
    if (m_f->m_inputfiles.count("csv") != 0)
    {
        LibUtilities::CsvIOSharedPtr csvIO =
            MemoryManager<LibUtilities::CsvIO>::AllocateSharedPtr(m_f->m_comm);
        csvIO->Import(inFile, m_f->m_fieldPts);
    }
    else if (m_f->m_inputfiles.count("pts") != 0)
    {
        LibUtilities::PtsIOSharedPtr ptsIO =
            MemoryManager<LibUtilities::PtsIO>::AllocateSharedPtr(m_f->m_comm);
        ptsIO->Import(inFile, m_f->m_fieldPts);
    }
    else
    {
        ASSERTL0(false, "unknown input file type");
    }
 
    // save field names
    for (int j = 0; j < m_f->m_fieldPts->GetNFields(); ++j)
    {
        m_f->m_variables.push_back(m_f->m_fieldPts->GetFieldName(j));
    }
}

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

Member Data Documentation

m_className

ModuleKey Nektar::FieldUtils::InputPts::m_className

static

Initial value:

= {
    GetModuleFactory().RegisterCreatorFunction(
        ModuleKey(eInputModule, "pts"), InputPts::create, "Reads Pts file."),
    GetModuleFactory().RegisterCreatorFunction(
        ModuleKey(eInputModule, "pts.gz"), InputPts::create, "Reads Pts file."),
    GetModuleFactory().RegisterCreatorFunction(
        ModuleKey(eInputModule, "csv"), InputPts::create, "Reads csv file."),
    GetModuleFactory().RegisterCreatorFunction(
        ModuleKey(eInputModule, "csv.gz"), InputPts::create, "Reads csv file."),
}

ModuleKey for class.

Definition at line 58 of file InputPts.h.