Abstract base class for input modules. More...

#include <Module.h>

Inheritance diagram for Nektar::FieldUtils::InputModule:

Public Member Functions
	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 FIELD_UTILS_EXPORT std::string	GuessFormat (std::string fileName)
	Tries to guess the format of the input file. More...

Additional Inherited Members
Public Attributes inherited from Nektar::FieldUtils::Module
FieldSharedPtr	m_f
	Field object. More...

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 ()

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

Abstract base class for input modules.

Input modules should read the contents of #fldFile in the Process() function and populate the members of #m. Typically any given module should populate Mesh::expDim, Mesh::spaceDim, Mesh::node and Mesh::element, then call the protected ProcessX functions to generate edges, faces, etc.

Definition at line 286 of file Module.h.

Constructor & Destructor Documentation

◆ InputModule()

Nektar::FieldUtils::InputModule::InputModule ( FieldSharedPtr p_m )

Definition at line 61 of file Module.cpp.

                                         : Module(m)
{
    m_config["infile"] = ConfigOption(false, "", "Input filename.");
}

References Nektar::FieldUtils::Module::m_config.

Member Function Documentation

◆ GuessFormat()

string Nektar::FieldUtils::InputModule::GuessFormat ( std::string fileName )

static

Tries to guess the format of the input file.

Definition at line 162 of file Module.cpp.

{
    // Read first 64 bytes of data, assuming input is this long.
    ifstream inFile(filename.c_str(), ios::binary);
    vector<char> data(64, 0);
    inFile.read(&data[0], 64);
 
    string check(&data[0], 64);
 
    // Nek5000 format: first four characters are: #std
    if (check.compare(0, 4, "#std") == 0)
    {
        inFile.close();
        return "fld5000";
    }
 
    // Semtex format: first line should contain the string "Session" at
    // character 27.
    if (check.compare(26, 7, "Session") == 0)
    {
        inFile.close();
        return "fldsem";
    }
 
    // Otherwise don't really know -- try to guess from file extension.
    inFile.close();
    return "";
}

◆ PrintSummary()

void Nektar::FieldUtils::InputModule::PrintSummary ( )

Print a brief summary of information.

Definition at line 194 of file Module.cpp.

{
    cout << "Field size = " << m_f->m_data[0].size() * sizeof(NekDouble)
         << endl;
}

References Nektar::FieldUtils::Module::m_f.

Public Member Functions