Nektar::FieldUtils::ProcessAverageFld Class Reference

This processing module averages the input fld files. More...

#include <ProcessAverageFld.h>

Inheritance diagram for Nektar::FieldUtils::ProcessAverageFld:

Public Member Functions
	ProcessAverageFld (FieldSharedPtr f)
	~ProcessAverageFld () 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 averages the input fld files.

Definition at line 47 of file ProcessAverageFld.h.

Constructor & Destructor Documentation

ProcessAverageFld()

Nektar::FieldUtils::ProcessAverageFld::ProcessAverageFld

(

FieldSharedPtr

f

)

Definition at line 53 of file ProcessAverageFld.cpp.

                                                     : ProcessModule(f)
{
    m_config["inputfld"] =
        ConfigOption(false, "NotSet", "Fld file form which to average");
    m_config["range"] = ConfigOption(false, "NotSet", "range of file numbers");
}

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

~ProcessAverageFld()

Nektar::FieldUtils::ProcessAverageFld::~ProcessAverageFld ( )

override

Definition at line 60 of file ProcessAverageFld.cpp.

{
}

Member Function Documentation

create()

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

inlinestatic

Creates an instance of this class.

Definition at line 51 of file ProcessAverageFld.h.

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

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

v_GetModuleDescription()

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

inlineoverrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 69 of file ProcessAverageFld.h.

    {
        return "Averaging input flds";
    }

v_GetModuleName()

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

inlineoverrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 64 of file ProcessAverageFld.h.

    {
        return "ProcessAverageFld";
    }

v_GetModulePriority()

ModulePriority Nektar::FieldUtils::ProcessAverageFld::v_GetModulePriority ( )

inlineoverrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 74 of file ProcessAverageFld.h.

    {
        return eFillExp;
    }

References Nektar::FieldUtils::eFillExp.

v_Process()

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

overrideprotectedvirtual

Write mesh to output file.

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 64 of file ProcessAverageFld.cpp.

{
    m_f->SetUpExp(vm);
    ASSERTL0(m_config["inputfld"].as<string>().compare("NotSet") != 0,
             "Need to specify inputfld=file_%.fld ");
    ASSERTL0(m_config["range"].as<string>().compare("NotSet") != 0,
             "Need to specify range=ns,dn,ne[include]");
 
    std::string infilename = m_config["inputfld"].as<string>();
    std::vector<int> range;
    ASSERTL0(ParseUtils::GenerateVector(m_config["range"].as<string>(), range),
             "Failed to interpret range string");
    ASSERTL0(
        range.size() == 3,
        "range string should contain 3 values nstart, deltan, nend[include].");
 
    vector<LibUtilities::FieldDefinitionsSharedPtr> FieldDef;
    vector<vector<double>> FieldData;
    NekDouble scale = 0.;
    for (int i = range[0]; i <= range[2]; i += range[1])
    {
        boost::format filenameformat(infilename);
        filenameformat % i;
        string inputfldname = filenameformat.str();
        vector<LibUtilities::FieldDefinitionsSharedPtr> tempFieldDef;
        vector<vector<double>> tempFieldData;
 
        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(inputfldname)
                ->Import(inputfldname, tempFieldDef, tempFieldData,
                         LibUtilities::NullFieldMetaDataMap, ElementGIDs);
        }
        else
        {
            m_f->FieldIOForFile(inputfldname)
                ->Import(inputfldname, tempFieldDef, tempFieldData,
                         LibUtilities::NullFieldMetaDataMap);
        }
 
        if (FieldDef.size() == 0)
        {
            FieldDef = tempFieldDef;
        }
 
        if (FieldData.size() < tempFieldData.size())
        {
            FieldData.resize(tempFieldData.size());
        }
 
        for (size_t i = 0; i < tempFieldData.size(); ++i)
        {
            if (FieldData[i].size() < tempFieldData[i].size())
            {
                FieldData[i].resize(tempFieldData[i].size(), 0.);
            }
            Vmath::Vadd(FieldData[i].size(), tempFieldData[i].data(), 1,
                        FieldData[i].data(), 1, FieldData[i].data(), 1);
        }
        if (m_f->m_comm->GetSpaceComm()->GetRank() == 0 && vm.count("verbose"))
        {
            std::cout << "File " << inputfldname << " processed." << std::endl;
        }
        scale += 1.;
    }
    if (scale < 0.5)
    {
        return; // no input file
    }
    scale = 1. / scale;
 
    // Filling expansion
    int numHomoDir = m_f->m_numHomogeneousDir;
    int nfields    = FieldDef[0]->m_fields.size();
    m_f->m_exp.resize(nfields);
    for (int i = 1; i < nfields; ++i)
    {
        m_f->m_exp[i] = m_f->AppendExpList(numHomoDir);
    }
    m_f->m_variables = FieldDef[0]->m_fields;
 
    for (int j = 0; j < nfields; ++j)
    {
        // load new field
        for (int i = 0; i < FieldDef.size(); ++i)
        {
            m_f->m_exp[j]->ExtractDataToCoeffs(FieldDef[i], FieldData[i],
                                               m_f->m_variables[j],
                                               m_f->m_exp[j]->UpdateCoeffs());
        }
        Vmath::Smul(m_f->m_exp[j]->GetNcoeffs(), scale,
                    m_f->m_exp[j]->UpdateCoeffs(), 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, CellMLToNektar.pycml::format, Nektar::ParseUtils::GenerateVector(), Nektar::FieldUtils::Module::m_config, Nektar::FieldUtils::Module::m_f, Nektar::LibUtilities::NullFieldMetaDataMap, Vmath::Smul(), and Vmath::Vadd().

Member Data Documentation

className

ModuleKey Nektar::FieldUtils::ProcessAverageFld::className

static

Initial value:

=
    GetModuleFactory().RegisterCreatorFunction(
        ModuleKey(eProcessModule, "averagefld"), ProcessAverageFld::create,
        "averaging of several field files. Must specify inputfld and range of "
        "file numbers.")

Definition at line 55 of file ProcessAverageFld.h.