Nektar::FieldUtils::ProcessAddCompositeID Class Reference

This processing module adds a fld with the composite ID. More...

#include <ProcessAddCompositeID.h>

Inheritance diagram for Nektar::FieldUtils::ProcessAddCompositeID:

Public Member Functions
	ProcessAddCompositeID (FieldSharedPtr f)
	~ProcessAddCompositeID () 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
	Write mesh to output file. More...
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 fld with the composite ID.

Definition at line 47 of file ProcessAddCompositeID.h.

Constructor & Destructor Documentation

ProcessAddCompositeID()

Nektar::FieldUtils::ProcessAddCompositeID::ProcessAddCompositeID

(

FieldSharedPtr

f

)

Definition at line 53 of file ProcessAddCompositeID.cpp.

    : ProcessModule(f)
{
}

~ProcessAddCompositeID()

Nektar::FieldUtils::ProcessAddCompositeID::~ProcessAddCompositeID ( )

override

Definition at line 58 of file ProcessAddCompositeID.cpp.

{
}

Member Function Documentation

create()

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

inlinestatic

Creates an instance of this class.

Definition at line 51 of file ProcessAddCompositeID.h.

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

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

v_GetModuleDescription()

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

inlineoverrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 69 of file ProcessAddCompositeID.h.

    {
        return "Adding composite ID as a new field";
    }

v_GetModuleName()

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

inlineoverrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 64 of file ProcessAddCompositeID.h.

    {
        return "ProcessAddCompositeID";
    }

v_GetModulePriority()

ModulePriority Nektar::FieldUtils::ProcessAddCompositeID::v_GetModulePriority ( )

inlineoverrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 74 of file ProcessAddCompositeID.h.

    {
        return eModifyExp;
    }

References Nektar::FieldUtils::eModifyExp.

v_Process()

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

overrideprotectedvirtual

Write mesh to output file.

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 62 of file ProcessAddCompositeID.cpp.

{
    m_f->SetUpExp(vm);
 
    int nfields = m_f->m_variables.size();
    m_f->m_variables.push_back("compositeID");
    // Skip in case of empty partition
    if (m_f->m_exp[0]->GetNumElmts() == 0)
    {
        return;
    }
 
    int NumHomogeneousDir = m_f->m_numHomogeneousDir;
    MultiRegions::ExpListSharedPtr exp;
 
    if (nfields)
    {
        m_f->m_exp.resize(nfields + 1);
        exp = m_f->AppendExpList(NumHomogeneousDir);
 
        m_f->m_exp[nfields] = exp;
    }
    else
    {
        exp = m_f->m_exp[0];
    }
 
    // Get Composites
    const SpatialDomains::CompositeMap CompositeMap =
        m_f->m_graph->GetComposites();
 
    int compid = -1;
 
    // loop over elements
    for (int n = 0; n < exp->GetNumElmts(); ++n)
    {
        LocalRegions::ExpansionSharedPtr elmt = exp->GetExp(n);
 
        // loop over composite list and search for geometry pointer in list
        for (auto &it : CompositeMap)
        {
            if (find(it.second->m_geomVec.begin(), it.second->m_geomVec.end(),
                     elmt->GetGeom()) != it.second->m_geomVec.end())
            {
                compid = it.first;
                break;
            }
        }
 
        WARNINGL0(compid != -1, "Failed to find composite ID for element: " +
                                    boost::lexical_cast<string>(n));
 
        // Fill element with the value of the index
        int npts = elmt->GetTotPoints();
        Array<OneD, NekDouble> tmp;
        Vmath::Fill(npts, (NekDouble)compid,
                    tmp = exp->UpdatePhys() + exp->GetPhys_Offset(n), 1);
    }
 
    // forward transform
    exp->FwdTransLocalElmt(exp->GetPhys(), exp->UpdateCoeffs());
}

References Vmath::Fill(), Nektar::StdRegions::find(), Nektar::FieldUtils::Module::m_f, and WARNINGL0.

Member Data Documentation

className

ModuleKey Nektar::FieldUtils::ProcessAddCompositeID::className

static

Initial value:

=
    GetModuleFactory().RegisterCreatorFunction(
        ModuleKey(eProcessModule, "addcompositeid"),
        ProcessAddCompositeID::create,
        "Add a field which contains the composite ID of each element")

Definition at line 55 of file ProcessAddCompositeID.h.