Nektar::FieldUtils::InputFld Class Reference

#include <InputFld.h>

Inheritance diagram for Nektar::FieldUtils::InputFld:

Public Member Functions
	InputFld (FieldSharedPtr f)
	Set up InputFld object. More...
	~InputFld () 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

Converter for Fld files.

Definition at line 46 of file InputFld.h.

Constructor & Destructor Documentation

InputFld()

Nektar::FieldUtils::InputFld::InputFld

(

FieldSharedPtr

f

)

Set up InputFld object.

Definition at line 62 of file InputFld.cpp.

                                   : InputModule(f)
{
    m_allowedFiles.insert("fld");
    m_allowedFiles.insert("chk");
    m_allowedFiles.insert("rst");
    m_allowedFiles.insert("bse");
}

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

~InputFld()

Nektar::FieldUtils::InputFld::~InputFld ( )

override

Definition at line 73 of file InputFld.cpp.

{
}

Member Function Documentation

create()

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

inlinestatic

Creates an instance of this class.

Definition at line 53 of file InputFld.h.

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

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

v_GetModuleDescription()

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

inlineoverrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 68 of file InputFld.h.

    {
        return "Processing input fld file";
    }

v_GetModuleName()

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

inlineoverrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 63 of file InputFld.h.

    {
        return "InputFld";
    }

v_GetModulePriority()

ModulePriority Nektar::FieldUtils::InputFld::v_GetModulePriority ( )

inlineoverrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 73 of file InputFld.h.

    {
        return eCreateFieldData;
    }

References Nektar::FieldUtils::eCreateFieldData.

v_Process()

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

overrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 80 of file InputFld.cpp.

{
    int i;
    string fileName = m_config["infile"].as<string>();
 
    LibUtilities::FieldIOSharedPtr fld = m_f->FieldIOForFile(fileName);
 
    int oldSize = m_f->m_fielddef.size();
    if (m_f->m_graph)
    {
        // Determine IDs of elements in the domain
        vector<int> IDs;
        auto domain = m_f->m_graph->GetDomain();
        for (int d = 0; d < domain.size(); ++d)
        {
            for (auto &compIter : domain[d])
            {
                for (auto &x : compIter.second->m_geomVec)
                {
                    IDs.push_back(x->GetGlobalID());
                }
            }
        }
 
        if (!IDs.size())
        {
            return;
        }
 
        // Move to an array to match FieldIO interface
        Array<OneD, int> ElementGIDs(IDs.size(), IDs.data());
 
        fld->Import(fileName, m_f->m_fielddef, m_f->m_data,
                    m_f->m_fieldMetaDataMap, ElementGIDs);
    }
    else // load all data.
    {
        fld->Import(fileName, m_f->m_fielddef, m_f->m_data,
                    m_f->m_fieldMetaDataMap);
    }
 
    // save field names
    for (i = 0; i < m_f->m_fielddef[oldSize]->m_fields.size(); ++i)
    {
        // check for multiple fld files
        auto it = find(m_f->m_variables.begin(), m_f->m_variables.end(),
                       m_f->m_fielddef[oldSize]->m_fields[i]);
 
        if (it == m_f->m_variables.end())
        {
            m_f->m_variables.push_back(m_f->m_fielddef[oldSize]->m_fields[i]);
        }
    }
}

References Nektar::UnitTests::d(), Nektar::StdRegions::find(), Nektar::FieldUtils::Module::m_config, and Nektar::FieldUtils::Module::m_f.

Member Data Documentation

m_className

ModuleKey Nektar::FieldUtils::InputFld::m_className

static

Initial value:

= {
    GetModuleFactory().RegisterCreatorFunction(
        ModuleKey(eInputModule, "fld"), InputFld::create, "Reads Fld file."),
    GetModuleFactory().RegisterCreatorFunction(ModuleKey(eInputModule, "chk"),
                                               InputFld::create,
                                               "Reads checkpoint file."),
    GetModuleFactory().RegisterCreatorFunction(ModuleKey(eInputModule, "rst"),
                                               InputFld::create,
                                               "Reads restart file."),
    GetModuleFactory().RegisterCreatorFunction(
        ModuleKey(eInputModule, "bse"), InputFld::create,
        "Reads stability base-flow file.")}

ModuleKey for class.

Definition at line 58 of file InputFld.h.