#include <Module.h>

Inheritance diagram for Nektar::FieldUtils::Module:

Public Member Functions
FIELD_UTILS_EXPORT	Module (FieldSharedPtr p_f)

virtual void	Process (po::variables_map &vm)=0

virtual	~Module ()=default

virtual std::string	GetModuleName ()=0

virtual std::string	GetModuleDescription ()

const ConfigOption &	GetConfigOption (const std::string &key) const

virtual ModulePriority	GetModulePriority ()=0

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

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 191 of file Module.h.

Constructor & Destructor Documentation

◆ Module() [1/2]

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

inline

Definition at line 194 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 233 of file Module.h.

233 {};

Member Function Documentation

◆ AddFile()

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

Definition at line 73 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 209 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()

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

inlinevirtual

Definition at line 204 of file Module.h.

     {
         return " ";
     }

◆ GetModuleName()

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

pure virtual

◆ GetModulePriority()

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

pure virtual

◆ PrintConfig()

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

Print out all configuration options for a module.

Definition at line 132 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.

Referenced by export_Module().

◆ Process()

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

pure virtual

◆ RegisterConfig()

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

Register a configuration option with a module.

Definition at line 102 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::Process(), and Nektar::FieldUtils::ProcessMeanMode::Process().

◆ SetDefaults()

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

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

Definition at line 150 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.

Referenced by export_Module().

Member Data Documentation

◆ m_allowedFiles

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

protected

List of allowed file formats.

Definition at line 238 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 236 of file Module.h.

◆ m_f

FieldSharedPtr Nektar::FieldUtils::Module::m_f

Field object.

Definition at line 230 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()

◆ GetModulePriority()

◆ PrintConfig()

◆ Process()

◆ RegisterConfig()

◆ SetDefaults()

Member Data Documentation

◆ m_allowedFiles

◆ m_config

◆ m_f