Nektar::FieldUtils::ProcessAddFld Class Reference

This processing module scales the input fld file. More...

#include <ProcessAddFld.h>

Inheritance diagram for Nektar::FieldUtils::ProcessAddFld:

Public Member Functions
	ProcessAddFld (FieldSharedPtr f)
	~ProcessAddFld () 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
std::vector< ModuleKey >	v_GetModulePrerequisites () 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 ()

Private Attributes
ModulePriority	m_priority

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 scales the input fld file.

Definition at line 47 of file ProcessAddFld.h.

Constructor & Destructor Documentation

ProcessAddFld()

Nektar::FieldUtils::ProcessAddFld::ProcessAddFld

(

FieldSharedPtr

f

)

Definition at line 51 of file ProcessAddFld.cpp.

                                             : ProcessModule(f)
{
    m_config["scale"] = ConfigOption(false, "1.0", "scale factor");
 
    m_config["fromfld"] =
        ConfigOption(false, "NotSet", "Fld file form which to add field");
 
    if (f->m_inputfiles.count("xml"))
    {
        m_priority = eModifyExp;
    }
    else
    {
        m_priority = eModifyFieldData;
    }
}

References Nektar::FieldUtils::eModifyExp, Nektar::FieldUtils::eModifyFieldData, Nektar::FieldUtils::Module::m_config, and m_priority.

~ProcessAddFld()

Nektar::FieldUtils::ProcessAddFld::~ProcessAddFld ( )

override

Definition at line 68 of file ProcessAddFld.cpp.

{
}

Member Function Documentation

create()

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

inlinestatic

Creates an instance of this class.

Definition at line 51 of file ProcessAddFld.h.

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

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

v_GetModuleDescription()

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

inlineoverrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 69 of file ProcessAddFld.h.

    {
        return "Adding new fld to input fld";
    }

v_GetModuleName()

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

inlineoverrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 64 of file ProcessAddFld.h.

    {
        return "ProcessAddFld";
    }

v_GetModulePrerequisites()

std::vector< ModuleKey > Nektar::FieldUtils::ProcessAddFld::v_GetModulePrerequisites ( )

inlineoverrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 79 of file ProcessAddFld.h.

    {
        return {{eProcessModule, "createExp"}};
    }

References Nektar::FieldUtils::eProcessModule.

v_GetModulePriority()

ModulePriority Nektar::FieldUtils::ProcessAddFld::v_GetModulePriority ( )

inlineoverrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 74 of file ProcessAddFld.h.

    {
        return m_priority;
    }

References m_priority.

v_Process()

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

overrideprotectedvirtual

Write mesh to output file.

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 72 of file ProcessAddFld.cpp.

{
    string scalestr = m_config["scale"].as<string>();
    NekDouble scale = std::stod(scalestr);
 
    ASSERTL0(m_config["fromfld"].as<string>().compare("NotSet") != 0,
             "Need to specify fromfld=file.fld ");
    string fromfld = m_config["fromfld"].as<string>();
 
    vector<LibUtilities::FieldDefinitionsSharedPtr> fromFieldDef;
    vector<vector<double>> fromFieldData;
 
    if (m_f->m_graph)
    {
        const SpatialDomains::ExpansionInfoMap &expansions =
            m_f->m_graph->GetExpansionInfo();
 
        // if Range has been speficied it is possible to have a
        // partition which is empty so check this and return if
        // no elements present.
 
        if (!expansions.size())
        {
            return;
        }
 
        Array<OneD, int> ElementGIDs(expansions.size());
 
        int i = 0;
        for (auto &expIt : expansions)
        {
            ElementGIDs[i++] = expIt.second->m_geomShPtr->GetGlobalID();
        }
        m_f->FieldIOForFile(fromfld)->Import(
            fromfld, fromFieldDef, fromFieldData,
            LibUtilities::NullFieldMetaDataMap, ElementGIDs);
    }
    else
    {
        m_f->FieldIOForFile(fromfld)->Import(
            fromfld, fromFieldDef, fromFieldData,
            LibUtilities::NullFieldMetaDataMap);
    }
 
    bool samelength = true;
    if (fromFieldData.size() != m_f->m_data.size())
    {
        samelength = false;
    }
 
    // scale input field
    for (int i = 0; i < fromFieldData.size(); ++i)
    {
        int datalen = fromFieldData[i].size();
 
        Vmath::Smul(datalen, scale, &(fromFieldData[i][0]), 1,
                    &(fromFieldData[i][0]), 1);
 
        if (samelength)
        {
            if (datalen != m_f->m_data[i].size())
            {
                samelength = false;
            }
        }
    }
 
    if (m_priority == eModifyFieldData)
    {
        ASSERTL0(samelength == true,
                 "Input fields have partitions of different length and so xml "
                 "file needs to be specified");
        for (int i = 0; i < m_f->m_data.size(); ++i)
        {
            int datalen = m_f->m_data[i].size();
 
            Vmath::Vadd(datalen, &(m_f->m_data[i][0]), 1,
                        &(fromFieldData[i][0]), 1, &(m_f->m_data[i][0]), 1);
        }
    }
    else
    {
        // Skip in case of empty partition
        if (m_f->m_exp[0]->GetNumElmts() == 0)
        {
            return;
        }
 
        int nfields = m_f->m_variables.size();
        int ncoeffs = m_f->m_exp[0]->GetNcoeffs();
        Array<OneD, NekDouble> SaveFld(ncoeffs);
 
        for (int j = 0; j < nfields; ++j)
        {
            Vmath::Vcopy(ncoeffs, m_f->m_exp[j]->GetCoeffs(), 1, SaveFld, 1);
 
            // Check if new field has this variable
            auto it =
                find(fromFieldDef[0]->m_fields.begin(),
                     fromFieldDef[0]->m_fields.end(), m_f->m_variables[j]);
 
            ASSERTL0(it != fromFieldDef[0]->m_fields.end(),
                     "Could not find field " + m_f->m_variables[j] +
                         " in from field");
 
            // load new field
            for (int i = 0; i < fromFieldData.size(); ++i)
            {
                m_f->m_exp[j]->ExtractDataToCoeffs(
                    fromFieldDef[i], fromFieldData[i], m_f->m_variables[j],
                    m_f->m_exp[j]->UpdateCoeffs());
            }
 
            Vmath::Vadd(ncoeffs, m_f->m_exp[j]->GetCoeffs(), 1, SaveFld, 1,
                        m_f->m_exp[j]->UpdateCoeffs(), 1);
            m_f->m_exp[j]->BwdTrans(m_f->m_exp[j]->GetCoeffs(),
                                    m_f->m_exp[j]->UpdatePhys());
        }
    }
}

References ASSERTL0, Nektar::FieldUtils::eModifyFieldData, Nektar::StdRegions::find(), Nektar::FieldUtils::Module::m_config, Nektar::FieldUtils::Module::m_f, m_priority, Nektar::LibUtilities::NullFieldMetaDataMap, Vmath::Smul(), Vmath::Vadd(), and Vmath::Vcopy().

Member Data Documentation

className

ModuleKey Nektar::FieldUtils::ProcessAddFld::className

static

Initial value:

= GetModuleFactory().RegisterCreatorFunction(
    ModuleKey(eProcessModule, "addfld"), ProcessAddFld::create,
    "add two fields together with optional scaling. Must specify fromfld and "
    "scaling is optionally specified with input option scale.")

Definition at line 55 of file ProcessAddFld.h.

m_priority

ModulePriority Nektar::FieldUtils::ProcessAddFld::m_priority

private

Definition at line 85 of file ProcessAddFld.h.

Referenced by ProcessAddFld(), v_GetModulePriority(), and v_Process().