Nektar::FieldUtils::ProcessInnerProduct Class Reference

This processing module computes the inner product between two fields. More...

#include <ProcessInnerProduct.h>

Inheritance diagram for Nektar::FieldUtils::ProcessInnerProduct:

Public Member Functions
	ProcessInnerProduct (FieldSharedPtr f)
	~ProcessInnerProduct () 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 ()

Private Member Functions
NekDouble	IProduct (std::vector< unsigned int > &processFields, FieldSharedPtr &fromField, Array< OneD, const Array< OneD, NekDouble > > &SaveFld)

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 computes the inner product between two fields.

Definition at line 47 of file ProcessInnerProduct.h.

Constructor & Destructor Documentation

ProcessInnerProduct()

Nektar::FieldUtils::ProcessInnerProduct::ProcessInnerProduct

(

FieldSharedPtr

f

)

Definition at line 52 of file ProcessInnerProduct.cpp.

                                                         : ProcessModule(f)
{
    m_config["fromfld"] = ConfigOption(
        false, "NotSet", "Fld file form which to interpolate field");
    m_config["fields"] =
        ConfigOption(false, "All", "field id's to be used in inner product");
    m_config["multifldids"] =
        ConfigOption(false, "NotSet",
                     "Take inner product of multiple field fields with "
                     "ids given in string. i.e. file_0.chk file_1.chk ...");
    m_config["allfromflds"] =
        ConfigOption(true, "0",
                     "Take inner product between all fromflds, "
                     "requires multifldids to be set");
}

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

~ProcessInnerProduct()

Nektar::FieldUtils::ProcessInnerProduct::~ProcessInnerProduct ( )

override

Definition at line 68 of file ProcessInnerProduct.cpp.

{
}

Member Function Documentation

create()

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

inlinestatic

Creates an instance of this class.

Definition at line 51 of file ProcessInnerProduct.h.

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

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

IProduct()

NekDouble Nektar::FieldUtils::ProcessInnerProduct::IProduct ( std::vector< unsigned int > &  processFields, FieldSharedPtr &  fromField, Array< OneD, const Array< OneD, NekDouble > > &  SaveFld  )

private

Definition at line 215 of file ProcessInnerProduct.cpp.

{
    int nphys          = m_f->m_exp[0]->GetTotPoints();
    NekDouble totiprod = 0.0;
 
    for (int j = 0; j < processFields.size(); ++j)
    {
        int fid = processFields[j];
 
        Array<OneD, NekDouble> coeffs(m_f->m_exp[fid]->GetNcoeffs());
        Array<OneD, NekDouble> phys(m_f->m_exp[fid]->GetTotPoints());
 
        // load new field
        for (int i = 0; i < fromField->m_data.size(); ++i)
        {
            m_f->m_exp[fid]->ExtractDataToCoeffs(fromField->m_fielddef[i],
                                                 fromField->m_data[i],
                                                 m_f->m_variables[fid], coeffs);
        }
 
        m_f->m_exp[fid]->BwdTrans(coeffs, phys);
 
        Vmath::Vmul(nphys, SaveFld[j], 1, phys, 1, phys, 1);
 
        NekDouble iprod = m_f->m_exp[fid]->Integral(phys);
 
        totiprod += iprod;
    }
    return totiprod;
}

References Nektar::FieldUtils::Module::m_f, and Vmath::Vmul().

Referenced by v_Process().

v_GetModuleDescription()

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

inlineoverrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 69 of file ProcessInnerProduct.h.

    {
        return "Evaluating inner product";
    }

v_GetModuleName()

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

inlineoverrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 64 of file ProcessInnerProduct.h.

    {
        return "ProcessInnerProduct";
    }

v_GetModulePriority()

ModulePriority Nektar::FieldUtils::ProcessInnerProduct::v_GetModulePriority ( )

inlineoverrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 74 of file ProcessInnerProduct.h.

    {
        return eModifyExp;
    }

References Nektar::FieldUtils::eModifyExp.

v_Process()

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

overrideprotectedvirtual

Write mesh to output file.

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 72 of file ProcessInnerProduct.cpp.

{
    m_f->SetUpExp(vm);
 
    // Skip in case of empty partition
    if (m_f->m_exp[0]->GetNumElmts() == 0)
    {
        return;
    }
 
    string fromfld           = m_config["fromfld"].as<string>();
    FieldSharedPtr fromField = std::shared_ptr<Field>(new Field());
 
    ASSERTL0(m_config["fromfld"].as<string>() != "NotSet",
             "The config parameter "
             "fromfld needs to be defined");
 
    // Set up ElementGIDs in case of parallel processing
    Array<OneD, int> ElementGIDs(m_f->m_exp[0]->GetExpSize());
    for (int i = 0; i < m_f->m_exp[0]->GetExpSize(); ++i)
    {
        ElementGIDs[i] = m_f->m_exp[0]->GetExp(i)->GetGeom()->GetGlobalID();
    }
 
    int nfields = m_f->m_variables.size();
    int nphys   = m_f->m_exp[0]->GetTotPoints();
    NekDouble totiprod;
    string fields = m_config["fields"].as<string>();
    vector<unsigned int> processFields;
    string multifldidsstr = m_config["multifldids"].as<string>();
    vector<unsigned int> multiFldIds;
    vector<string> fromfiles;
    bool allfromflds = m_config["allfromflds"].as<bool>();
 
    if (fields.compare("All") == 0)
    {
        for (int i = 0; i < nfields; ++i)
        {
            processFields.push_back(i);
        }
    }
    else
    {
        ASSERTL0(ParseUtils::GenerateVector(fields, processFields),
                 "Failed to interpret field string in module innerproduct");
    }
 
    if (multifldidsstr.compare("NotSet") == 0)
    {
        fromfiles.push_back(fromfld);
    }
    else
    {
        ASSERTL0(
            ParseUtils::GenerateSeqVector(multifldidsstr, multiFldIds),
            "Failed to interpret multifldids string in module innerproduct");
        int end        = fromfld.find_first_of('.', 0);
        string endstr  = fromfld.substr(end, fromfld.size());
        string bodystr = fromfld.substr(0, end);
        for (int i = 0; i < multiFldIds.size(); ++i)
        {
            string infile = bodystr + "_" +
                            boost::lexical_cast<string>(multiFldIds[i]) +
                            endstr;
            fromfiles.push_back(infile);
        }
    }
 
    Array<OneD, Array<OneD, NekDouble>> SaveFld(processFields.size());
    for (int j = 0; j < processFields.size(); ++j)
    {
        int fid    = processFields[j];
        SaveFld[j] = Array<OneD, NekDouble>(nphys);
        m_f->m_exp[fid]->BwdTrans(m_f->m_exp[fid]->GetCoeffs(), SaveFld[j]);
    }
 
    if (allfromflds == false)
    {
 
        for (int f = 0; f < fromfiles.size(); ++f)
        {
            m_f->FieldIOForFile(fromfiles[f])
                ->Import(fromfiles[f], fromField->m_fielddef, fromField->m_data,
                         LibUtilities::NullFieldMetaDataMap, ElementGIDs);
 
            totiprod = IProduct(processFields, fromField, SaveFld);
 
            if (m_f->m_comm->GetSpaceComm()->GetRank() == 0)
            {
                cout << "Inner Product WRT " << fromfiles[f] << " : "
                     << totiprod << endl;
            }
        }
    }
    else // evaluate all from fields, first by loading them all up and then
         // calling IProduct
    {
 
        // Load all from fields.
        Array<OneD, FieldSharedPtr> allFromField(fromfiles.size());
        for (int i = 0; i < fromfiles.size(); ++i)
        {
            allFromField[i] = std::shared_ptr<Field>(new Field());
 
            m_f->FieldIOForFile(fromfiles[i])
                ->Import(fromfiles[i], allFromField[i]->m_fielddef,
                         allFromField[i]->m_data,
                         LibUtilities::NullFieldMetaDataMap, ElementGIDs);
        }
 
        for (int g = 0; g < fromfiles.size(); ++g)
        {
            for (int j = 0; j < processFields.size(); ++j)
            {
                int fid = processFields[j];
                Array<OneD, NekDouble> coeffs(m_f->m_exp[fid]->GetNcoeffs());
                // load new field
                for (int i = 0; i < allFromField[g]->m_data.size(); ++i)
                {
                    m_f->m_exp[fid]->ExtractDataToCoeffs(
                        allFromField[g]->m_fielddef[i],
                        allFromField[g]->m_data[i], m_f->m_variables[fid],
                        coeffs);
                }
 
                m_f->m_exp[fid]->BwdTrans(coeffs, SaveFld[j]);
            }
 
            // take inner product from this g field with all other above
            for (int f = g; f < fromfiles.size(); ++f)
            {
                totiprod = IProduct(processFields, allFromField[f], SaveFld);
 
                if (m_f->m_comm->GetSpaceComm()->GetRank() == 0)
                {
                    cout << "Inner Product of " << fromfiles[g] << " WRT "
                         << fromfiles[f] << " : " << totiprod << endl;
                }
            }
        }
    }
}

References ASSERTL0, Nektar::ParseUtils::GenerateSeqVector(), Nektar::ParseUtils::GenerateVector(), IProduct(), Nektar::FieldUtils::Module::m_config, Nektar::FieldUtils::Module::m_f, and Nektar::LibUtilities::NullFieldMetaDataMap.

Member Data Documentation

className

ModuleKey Nektar::FieldUtils::ProcessInnerProduct::className

static

Initial value:

=
    GetModuleFactory().RegisterCreatorFunction(
        ModuleKey(eProcessModule, "innerproduct"), ProcessInnerProduct::create,
        "take inner product between two fields and return value.")

Definition at line 55 of file ProcessInnerProduct.h.