Nektar::FieldUtils::ProcessRemoveField Class Reference

This processing module adds a new field from a string definition. More...

#include <ProcessRemoveField.h>

Inheritance diagram for Nektar::FieldUtils::ProcessRemoveField:

Public Member Functions
	ProcessRemoveField (FieldSharedPtr f)
	~ProcessRemoveField () override
Public Member Functions inherited from Nektar::FieldUtils::ProcessModule
	ProcessModule ()
	ProcessModule (FieldSharedPtr p_f)
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 std::shared_ptr< Module >	create (FieldSharedPtr f)
	Creates an instance of this class. More...

Static Public Attributes
static ModuleKey	className

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

This processing module adds a new field from a string definition.

Definition at line 46 of file ProcessRemoveField.h.

Constructor & Destructor Documentation

ProcessRemoveField()

Nektar::FieldUtils::ProcessRemoveField::ProcessRemoveField

(

FieldSharedPtr

f

)

Definition at line 51 of file ProcessRemoveField.cpp.

                                                       : ProcessModule(f)
{
    m_config["fieldname"] =
        ConfigOption(false, "NotSet", "Name for field to be removed, required");
}

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

~ProcessRemoveField()

Nektar::FieldUtils::ProcessRemoveField::~ProcessRemoveField ( void  )

override

Definition at line 57 of file ProcessRemoveField.cpp.

{
}

Member Function Documentation

create()

static std::shared_ptr< Module > Nektar::FieldUtils::ProcessRemoveField::create ( FieldSharedPtr  f )

inlinestatic

Creates an instance of this class.

Definition at line 50 of file ProcessRemoveField.h.

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

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

v_GetModuleDescription()

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

inlineoverrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 67 of file ProcessRemoveField.h.

    {
        return "Removes specific fields from .fld";
    }

v_GetModuleName()

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

inlineoverrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 62 of file ProcessRemoveField.h.

    {
        return "ProcessRemoveField";
    }

v_GetModulePriority()

ModulePriority Nektar::FieldUtils::ProcessRemoveField::v_GetModulePriority ( )

inlineoverrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 72 of file ProcessRemoveField.h.

    {
        return eModifyExp;
    }

References Nektar::FieldUtils::eModifyExp.

v_Process()

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

overrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 61 of file ProcessRemoveField.cpp.

{
    // Obtain field names to be removed
    string fieldNames = m_config["fieldname"].as<string>();
    vector<string> fieldName;
    ASSERTL0(fieldNames != "NotSet", "A fieldname is required");
 
    ASSERTL0(ParseUtils::GenerateVector(fieldNames, fieldName),
             "Failed to interpret fields string");
    m_f->SetUpExp(vm);
 
    // Remove fields specified
    for (int i = 0; i < fieldName.size(); ++i)
    {
        // check if field exists
        auto it = std::find(m_f->m_variables.begin(), m_f->m_variables.end(),
                            fieldName[i]);
        ASSERTL0(it != m_f->m_variables.end(), "Field does not exist");
 
        int fieldID = std::distance(m_f->m_variables.begin(), it);
 
        m_f->m_variables.erase(it);
        m_f->m_exp.erase(m_f->m_exp.begin() + fieldID);
 
        if (m_f->m_comm->GetSpaceComm()->TreatAsRankZero())
        {
            cout << "Field " << fieldName[i] << " has been erased" << endl;
        }
    }
}

References ASSERTL0, Nektar::StdRegions::find(), Nektar::ParseUtils::GenerateVector(), Nektar::FieldUtils::Module::m_config, and Nektar::FieldUtils::Module::m_f.

Member Data Documentation

className

ModuleKey Nektar::FieldUtils::ProcessRemoveField::className

static

Initial value:

=
    GetModuleFactory().RegisterCreatorFunction(
        ModuleKey(eProcessModule, "removefield"), ProcessRemoveField::create,
        "Remove one of the existing fields")

Definition at line 54 of file ProcessRemoveField.h.