ModuleWrap< MODTYPE > Struct Template Reference

Module wrapper to handle virtual function calls in Module and its subclasses as defined by the template parameter. More...

Inheritance diagram for ModuleWrap< MODTYPE >:

Public Member Functions
	ModuleWrap (FieldSharedPtr field)
	Constructor, which is identical to FieldUtils::Module. More...
void	v_Process (po::variables_map &vm) override
	Concrete implementation of the Module::Process function. More...
std::string	v_GetModuleName () override
ModulePriority	v_GetModulePriority () override
void	AddConfigOption (std::string key, std::string def, std::string desc, bool isBool)
	Defines a configuration option for this module. More...

Detailed Description

template<typename MODTYPE>
struct ModuleWrap< MODTYPE >

Module wrapper to handle virtual function calls in Module and its subclasses as defined by the template parameter.

Template Parameters

MODTYPE.

Definition at line 56 of file Python/Module.cpp.

Constructor & Destructor Documentation

ModuleWrap()

template<typename MODTYPE >

ModuleWrap< MODTYPE >::ModuleWrap ( FieldSharedPtr  field )

inline

Constructor, which is identical to FieldUtils::Module.

Parameters

field

Input field.

Definition at line 63 of file Python/Module.cpp.

                                     : MODTYPE(field)
    {
    }

Member Function Documentation

AddConfigOption()

template<typename MODTYPE >

void ModuleWrap< MODTYPE >::AddConfigOption ( std::string  key, std::string  def, std::string  desc, bool  isBool  )

inline

Defines a configuration option for this module.

Parameters

key	The name of the configuration option.
def	The option's default value.
desc	A text description of the option.
isBool	If true, this option is a boolean-type (true/false).

Definition at line 139 of file Python/Module.cpp.

    {
        ConfigOption conf(isBool, def, desc);
        this->m_config[key] = conf;
    }

v_GetModuleName()

template<typename MODTYPE >

std::string ModuleWrap< MODTYPE >::v_GetModuleName ( )

inlineoverride

Definition at line 104 of file Python/Module.cpp.

    {
        py::gil_scoped_acquire gil;
        py::function override = py::get_override(this, "GetModuleName");
 
        if (override)
        {
            return py::cast<std::string>(override());
        }
 
        throw ErrorUtil::NekError("GetModuleName() is a pure virtual function");
    }

v_GetModulePriority()

template<typename MODTYPE >

ModulePriority ModuleWrap< MODTYPE >::v_GetModulePriority ( )

inlineoverride

Definition at line 117 of file Python/Module.cpp.

    {
        py::gil_scoped_acquire gil;
        py::function override = py::get_override(this, "GetModulePriority");
 
        if (override)
        {
            return py::cast<ModulePriority>(override());
        }
 
        throw ErrorUtil::NekError(
            "GetModulePriority() is a pure virtual function");
    }

v_Process()

template<typename MODTYPE >

void ModuleWrap< MODTYPE >::v_Process ( po::variables_map &  vm )

inlineoverride

Concrete implementation of the Module::Process function.

Definition at line 70 of file Python/Module.cpp.

    {
        py::gil_scoped_acquire gil;
        py::function override = py::get_override(this, "Process");
 
        if (this->m_f->m_nParts > 1)
        {
            if (this->GetModulePriority() == eOutput)
            {
                this->m_f->m_comm = this->m_f->m_partComm;
                if (this->GetModuleName() != "OutputInfo")
                {
                    this->RegisterConfig("writemultiplefiles");
                }
            }
            else if (this->GetModulePriority() == eCreateGraph)
            {
                this->m_f->m_comm = this->m_f->m_partComm;
            }
            else
            {
                this->m_f->m_comm = this->m_f->m_defComm;
            }
        }
 
        if (override)
        {
            override();
            return;
        }
 
        throw ErrorUtil::NekError("Process() is a pure virtual function");
    }

References Nektar::FieldUtils::eCreateGraph, and Nektar::FieldUtils::eOutput.