Nektar::Utilities::ProcessInnerProduct Class Reference

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

#include <ProcessInnerProduct.h>

Inheritance diagram for Nektar::Utilities::ProcessInnerProduct:

Collaboration diagram for Nektar::Utilities::ProcessInnerProduct:

Public Member Functions
	ProcessInnerProduct (FieldSharedPtr f)
virtual	~ProcessInnerProduct ()
virtual void	Process (po::variables_map &vm)
	Write mesh to output file. More...
virtual std::string	GetModuleName ()
Public Member Functions inherited from Nektar::Utilities::ProcessModule
	ProcessModule ()
	ProcessModule (FieldSharedPtr p_f)
	ProcessModule (MeshSharedPtr p_m)
Public Member Functions inherited from Nektar::Utilities::Module
	Module (FieldSharedPtr p_f)
void	RegisterConfig (string key, string value)
	Register a configuration option with a module. More...
void	PrintConfig ()
	Print out all configuration options for a module. More...
void	SetDefaults ()
	Sets default configuration options for those which have not been set. More...
bool	GetRequireEquiSpaced (void)
void	SetRequireEquiSpaced (bool pVal)
void	EvaluateTriFieldAtEquiSpacedPts (LocalRegions::ExpansionSharedPtr &exp, const Array< OneD, const NekDouble > &infield, Array< OneD, NekDouble > &outfield)
	Module (MeshSharedPtr p_m)
virtual void	Process ()=0
void	RegisterConfig (std::string key, std::string value)
void	PrintConfig ()
void	SetDefaults ()
MeshSharedPtr	GetMesh ()
virtual void	ProcessVertices ()
	Extract element vertices. More...
virtual void	ProcessEdges (bool ReprocessEdges=true)
	Extract element edges. More...
virtual void	ProcessFaces (bool ReprocessFaces=true)
	Extract element faces. More...
virtual void	ProcessElements ()
	Generate element IDs. More...
virtual void	ProcessComposites ()
	Generate composites. More...
virtual void	ClearElementLinks ()

Static Public Member Functions
static boost::shared_ptr< Module >	create (FieldSharedPtr f)
	Creates an instance of this class. More...

Static Public Attributes
static ModuleKey	className

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

Additional Inherited Members
Protected Member Functions inherited from Nektar::Utilities::Module
	Module ()
void	ReorderPrisms (PerMap &perFaces)
	Reorder node IDs so that prisms and tetrahedra are aligned correctly. More...
void	PrismLines (int prism, PerMap &perFaces, std::set< int > &prismsDone, std::vector< ElementSharedPtr > &line)
Protected Attributes inherited from Nektar::Utilities::Module
FieldSharedPtr	m_f
	Field object. More...
map< string, ConfigOption >	m_config
	List of configuration values. More...
bool	m_requireEquiSpaced
MeshSharedPtr	m_mesh
	Mesh object. More...
std::map< std::string, ConfigOption >	m_config
	List of configuration values. More...

Detailed Description

This processing module computes the inner product between two fields.

Definition at line 50 of file ProcessInnerProduct.h.

Constructor & Destructor Documentation

Nektar::Utilities::ProcessInnerProduct::ProcessInnerProduct

(

FieldSharedPtr

f

)

Definition at line 56 of file ProcessInnerProduct.cpp.

References Nektar::Utilities::Module::m_config.

                                                         : 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,
                     "NotSet",
                     "Take inner product between all fromflds, "
                     "requires multifldids to be set");
}

Nektar::Utilities::ProcessInnerProduct::~ProcessInnerProduct ( )

virtual

Definition at line 74 of file ProcessInnerProduct.cpp.

{
}

Member Function Documentation

static boost::shared_ptr<Module> Nektar::Utilities::ProcessInnerProduct::create ( FieldSharedPtr  f )

inlinestatic

Creates an instance of this class.

Definition at line 54 of file ProcessInnerProduct.h.

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

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

virtual std::string Nektar::Utilities::ProcessInnerProduct::GetModuleName ( )

inlinevirtual

Implements Nektar::Utilities::Module.

Definition at line 66 of file ProcessInnerProduct.h.

    {
        return "ProcessInnerProduct";
    }

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

private

Definition at line 228 of file ProcessInnerProduct.cpp.

References Nektar::Utilities::Module::m_f, Nektar::LibUtilities::ReduceSum, and Vmath::Vmul().

Referenced by Process().

{
    int nphys          = m_f->m_exp[0]->GetTotPoints();
    NekDouble totiprod = 0.0;

    for (int j = 0; j < processFields.size(); ++j)
    {
        int fid = processFields[j];

        // 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],
                fromField->m_fielddef[i]->m_fields[fid],
                m_f->m_exp[fid]->UpdateCoeffs());
        }

        m_f->m_exp[fid]->BwdTrans(m_f->m_exp[fid]->GetCoeffs(),
                                  m_f->m_exp[fid]->UpdatePhys());

        Vmath::Vmul(nphys,
                    SaveFld[j],
                    1,
                    m_f->m_exp[fid]->GetPhys(),
                    1,
                    m_f->m_exp[fid]->UpdatePhys(),
                    1);

        NekDouble iprod =
            m_f->m_exp[fid]->PhysIntegral(m_f->m_exp[fid]->UpdatePhys());

        // put in parallel summation
        m_f->m_comm->AllReduce(iprod, Nektar::LibUtilities::ReduceSum);

        totiprod += iprod;
    }
    return totiprod;
}

void Nektar::Utilities::ProcessInnerProduct::Process ( po::variables_map &  vm )

virtual

Write mesh to output file.

Implements Nektar::Utilities::Module.

Definition at line 78 of file ProcessInnerProduct.cpp.

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

{
    if (m_f->m_verbose)
    {
        if(m_f->m_comm->GetRank() == 0)
        {
            cout << "ProcessInnerProduct: Evaluating inner product..." << endl;
        }
    }

    ASSERTL0(m_f->m_exp.size() != 0, "input xml file needs to be specified");
    ASSERTL0(m_f->m_data.size() != 0, "No input data has been defined");

    string fromfld           = m_config["fromfld"].as<string>();
    FieldSharedPtr fromField = boost::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_fielddef[0]->m_fields.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"].m_beenSet;

    if (fields.compare("All") == 0)
    {
        for (int i = 0; i < nfields; ++i)
        {
            processFields.push_back(i);
        }
    }
    else
    {
        ASSERTL0(ParseUtils::GenerateSeqVector(fields.c_str(), processFields),
                 "Failed to interpret field string in module innerproduct");
    }

    if (multifldidsstr.compare("NotSet") == 0)
    {
        fromfiles.push_back(fromfld);
    }
    else
    {
        ASSERTL0(
            ParseUtils::GenerateSeqVector(multifldidsstr.c_str(), 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->m_fld->Import(fromfiles[f],
                               fromField->m_fielddef,
                               fromField->m_data,
                               LibUtilities::NullFieldMetaDataMap,
                               ElementGIDs);

            totiprod = IProduct(processFields, fromField, SaveFld);

            if (m_f->m_comm->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] = boost::shared_ptr<Field>(new Field());
            m_f->m_fld->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];

                // 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],
                        allFromField[g]->m_fielddef[i]->m_fields[fid],
                        m_f->m_exp[fid]->UpdateCoeffs());
                }

                m_f->m_exp[fid]->BwdTrans(m_f->m_exp[fid]->GetCoeffs(),
                                          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->GetRank() == 0)
                {
                    cout << "Inner Product of " << fromfiles[g] << " WRT "
                         << fromfiles[f] << " : " << totiprod << endl;
                }
            }
        }
    }
}

Member Data Documentation

ModuleKey Nektar::Utilities::ProcessInnerProduct::className

static

Initial value:

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

Definition at line 58 of file ProcessInnerProduct.h.