#include <Module.h>

Inheritance diagram for Nektar::FieldUtils::Module:

Public Member Functions
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)

Public Attributes
FieldSharedPtr	m_f
	Field object. More...

Protected Member Functions
	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
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 mesh converter modules. Each subclass implements the Process() function, which in some way alters the mesh #m.

Definition at line 187 of file Module.h.

Constructor & Destructor Documentation

◆ Module() [1/2]

FIELD_UTILS_EXPORT Nektar::FieldUtils::Module::Module ( FieldSharedPtr p_f )

inline

Definition at line 190 of file Module.h.

                                                  : m_f(p_f)
    {
    }

◆ ~Module()

virtual Nektar::FieldUtils::Module::~Module ( )

virtualdefault

◆ Module() [2/2]

Nektar::FieldUtils::Module::Module ( )

inlineprotected

Definition at line 242 of file Module.h.

242{};

Member Function Documentation

◆ AddFile()

void Nektar::FieldUtils::Module::AddFile	(	std::string	fileType,
		std::string	fileName
	)

Definition at line 71 of file Module.cpp.

{
    // Check to see if this file type is allowed
    if (m_allowedFiles.count(fileType) == 0)
    {
        cerr << "File type " << fileType << " not supported for this "
             << "module." << endl;
    }
 
    m_f->m_inputfiles[fileType].push_back(fileName);
}

References m_allowedFiles, and m_f.

◆ EvaluateTriFieldAtEquiSpacedPts()

FIELD_UTILS_EXPORT void Nektar::FieldUtils::Module::EvaluateTriFieldAtEquiSpacedPts	(	LocalRegions::ExpansionSharedPtr &	exp,
		const Array< OneD, const NekDouble > &	infield,
		Array< OneD, NekDouble > &	outfield
	)

◆ GetConfigOption()

const ConfigOption & Nektar::FieldUtils::Module::GetConfigOption ( const std::string & key ) const

inline

Definition at line 210 of file Module.h.

    {
        auto it = m_config.find(key);
        ASSERTL0(it != m_config.end(), "Configuration key not found!");
        return it->second;
    }

References ASSERTL0, and m_config.

◆ GetModuleDescription()

std::string Nektar::FieldUtils::Module::GetModuleDescription ( )

inline

Definition at line 205 of file Module.h.

    {
        return v_GetModuleDescription();
    }

References v_GetModuleDescription().

◆ GetModuleName()

std::string Nektar::FieldUtils::Module::GetModuleName ( )

inline

Definition at line 200 of file Module.h.

    {
        return v_GetModuleName();
    }

References v_GetModuleName().

Referenced by Nektar::FieldUtils::OutputFileBase::v_Process().

◆ GetModulePrerequisites()

std::vector< ModuleKey > Nektar::FieldUtils::Module::GetModulePrerequisites ( )

inline

Definition at line 222 of file Module.h.

    {
        return v_GetModulePrerequisites();
    }

References v_GetModulePrerequisites().

◆ GetModulePriority()

ModulePriority Nektar::FieldUtils::Module::GetModulePriority ( )

inline

Definition at line 217 of file Module.h.

    {
        return v_GetModulePriority();
    }

References v_GetModulePriority().

◆ PrintConfig()

void Nektar::FieldUtils::Module::PrintConfig ( )

Print out all configuration options for a module.

Definition at line 130 of file Module.cpp.

{
    if (m_config.size() == 0)
    {
        cerr << "No configuration options for this module." << endl;
        return;
    }
 
    for (auto &it : m_config)
    {
        cerr << setw(10) << it.first << ": " << it.second.m_desc << endl;
    }
}

References m_config.

◆ Process()

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

inline

Definition at line 195 of file Module.h.

    {
        v_Process(vm);
    }

References v_Process().

◆ RegisterConfig()

void Nektar::FieldUtils::Module::RegisterConfig	(	std::string	key,
		std::string	value = `""`
	)

Register a configuration option with a module.

Definition at line 100 of file Module.cpp.

{
    auto it = m_config.find(key);
    if (it == m_config.end())
    {
        cerr << "WARNING: Unrecognised config option " << key
             << ", proceeding anyway." << endl;
        ConfigOption conf(false, "", "");
        conf.m_beenSet = true;
        conf.m_value   = val;
        m_config[key]  = conf;
    }
    else
    {
        it->second.m_beenSet = true;
 
        if (it->second.m_isBool && val == "")
        {
            it->second.m_value = "1";
        }
        else
        {
            it->second.m_value = val;
        }
    }
}

References Nektar::FieldUtils::ConfigOption::m_beenSet, m_config, and Nektar::FieldUtils::ConfigOption::m_value.

Referenced by Nektar::FieldUtils::OutputFileBase::v_Process(), and Nektar::FieldUtils::ProcessMeanMode::v_Process().

◆ SetDefaults()

void Nektar::FieldUtils::Module::SetDefaults ( )

Sets default configuration options for those which have not been set.

Definition at line 148 of file Module.cpp.

{
    for (auto &it : m_config)
    {
        if (!it.second.m_beenSet)
        {
            it.second.m_value = it.second.m_defValue;
        }
    }
}

References m_config.

◆ v_GetModuleDescription()

virtual std::string Nektar::FieldUtils::Module::v_GetModuleDescription ( )

inlineprotectedvirtual

Definition at line 255 of file Module.h.

    {
        return " ";
    }

Referenced by GetModuleDescription().

◆ v_GetModuleName()

virtual std::string Nektar::FieldUtils::Module::v_GetModuleName ( )

inlineprotectedvirtual

Definition at line 249 of file Module.h.

    {
        NEKERROR(ErrorUtil::efatal, "v_GetModuleName not coded");
        return " ";
    }

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

Referenced by GetModuleName().

◆ v_GetModulePrerequisites()

virtual std::vector< ModuleKey > Nektar::FieldUtils::Module::v_GetModulePrerequisites ( )

inlineprotectedvirtual

Reimplemented in Nektar::FieldUtils::ProcessAddFld.

Definition at line 266 of file Module.h.

    {
        return std::vector<ModuleKey>();
    }

Referenced by GetModulePrerequisites().

◆ v_GetModulePriority()

virtual ModulePriority Nektar::FieldUtils::Module::v_GetModulePriority ( )

inlineprotectedvirtual

Definition at line 260 of file Module.h.

    {
        NEKERROR(ErrorUtil::efatal, "v_GetModulePriority not coded");
        return SIZE_ModulePriority;
    }

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

Referenced by GetModulePriority().

◆ v_Process()

virtual void Nektar::FieldUtils::Module::v_Process ( po::variables_map & vm )

inlineprotectedvirtual

Definition at line 244 of file Module.h.

    {
        NEKERROR(ErrorUtil::efatal, "v_Process not coded");
    }

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

Referenced by Process().

Member Data Documentation

◆ m_allowedFiles

std::set<std::string> Nektar::FieldUtils::Module::m_allowedFiles

protected

List of allowed file formats.

Definition at line 274 of file Module.h.

Referenced by AddFile(), Nektar::FieldUtils::InputDat::InputDat(), Nektar::FieldUtils::InputFld::InputFld(), Nektar::FieldUtils::InputNek5000::InputNek5000(), Nektar::FieldUtils::InputPts::InputPts(), Nektar::FieldUtils::InputSemtex::InputSemtex(), and Nektar::FieldUtils::InputXml::InputXml().

◆ m_config

std::map<std::string, ConfigOption> Nektar::FieldUtils::Module::m_config

protected

List of configuration values.

Definition at line 272 of file Module.h.

◆ m_f

FieldSharedPtr Nektar::FieldUtils::Module::m_f

Field object.

Definition at line 239 of file Module.h.

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Module() [1/2]

◆ ~Module()

◆ Module() [2/2]

Member Function Documentation

◆ AddFile()

◆ EvaluateTriFieldAtEquiSpacedPts()

◆ GetConfigOption()

◆ GetModuleDescription()

◆ GetModuleName()

◆ GetModulePrerequisites()

◆ GetModulePriority()

◆ PrintConfig()

◆ Process()

◆ RegisterConfig()

◆ SetDefaults()

◆ v_GetModuleDescription()

◆ v_GetModuleName()

◆ v_GetModulePrerequisites()

◆ v_GetModulePriority()

◆ v_Process()

Member Data Documentation

◆ m_allowedFiles

◆ m_config

◆ m_f