Nektar::FieldUtils::ProcessPowerSpectrum Class Reference

This processing module outputs power spectrum at given regions for a 3DH1D fields. More...

#include <ProcessPowerSpectrum.h>

Inheritance diagram for Nektar::FieldUtils::ProcessPowerSpectrum:

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

Additional Inherited Members
Public Attributes inherited from Nektar::FieldUtils::Module
FieldSharedPtr	m_f
	Field object. More...
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 ()
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 outputs power spectrum at given regions for a 3DH1D fields.

Definition at line 47 of file ProcessPowerSpectrum.h.

Constructor & Destructor Documentation

ProcessPowerSpectrum()

Nektar::FieldUtils::ProcessPowerSpectrum::ProcessPowerSpectrum

(

FieldSharedPtr

f

)

Definition at line 52 of file ProcessPowerSpectrum.cpp.

                                                           : ProcessModule(f)
{
    m_config["box"] =
        ConfigOption(false, "NotSet",
                     "Specify a rectangular box by box=xmin,xmax,ymin,ymax");
    m_config["vars"] = ConfigOption(false, "NotSet", "signal variable");
}

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

~ProcessPowerSpectrum()

Nektar::FieldUtils::ProcessPowerSpectrum::~ProcessPowerSpectrum ( )

override

Definition at line 60 of file ProcessPowerSpectrum.cpp.

{
}

Member Function Documentation

create()

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

inlinestatic

Creates an instance of this class.

Definition at line 51 of file ProcessPowerSpectrum.h.

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

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

v_GetModuleDescription()

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

inlineoverridevirtual

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 68 of file ProcessPowerSpectrum.h.

    {
        return "Output power spectrum at given regions";
    }

v_GetModuleName()

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

inlineoverridevirtual

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 63 of file ProcessPowerSpectrum.h.

    {
        return "ProcessPowerSpectrum";
    }

v_GetModulePriority()

ModulePriority Nektar::FieldUtils::ProcessPowerSpectrum::v_GetModulePriority ( )

inlineoverridevirtual

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 73 of file ProcessPowerSpectrum.h.

    {
        return eModifyExp;
    }

References Nektar::FieldUtils::eModifyExp.

v_Process()

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

overridevirtual

Write mesh to output file.

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 64 of file ProcessPowerSpectrum.cpp.

{
    m_f->SetUpExp(vm);
 
    ASSERTL0(m_f->m_numHomogeneousDir == 1,
             "ProcessPowerSpectrum only works for Homogeneous1D fields.");
    // Skip in case of empty partition
    if (m_f->m_exp[0]->GetNumElmts() == 0)
    {
        return;
    }
 
    std::set<int> variables;
    if (m_config["vars"].as<string>().compare("NotSet") != 0)
    {
        ParseUtils::GenerateVariableSet(m_config["vars"].as<string>(),
                                        m_f->m_variables, variables);
    }
    ASSERTL0(variables.size() >= 1,
             "At least one variable should be selected.");
    if (variables.empty())
    {
        return;
    }
    std::vector<NekDouble> box;
    if (m_config["box"].as<string>().compare("NotSet") != 0)
    {
        ASSERTL0(ParseUtils::GenerateVector(m_config["box"].as<string>(), box),
                 "Failed to interpret box string");
        ASSERTL0(
            box.size() >= 4,
            "box string should contain at least 4 values xmin,xmax,ymin,ymax");
    }
    box.resize(4, 0.);
    if (m_f->m_comm->GetSpaceComm()->GetRank() == 0)
    {
 
        cout << "Processing frequency spectra of variables (";
        for (auto nsignal : variables)
        {
            cout << m_f->m_variables[nsignal] << ", ";
        }
        cout << ") in box [" << box[0] << ", " << box[1] << "]X[" << box[2]
             << ", " << box[3] << "].\n";
    }
 
    for (auto nsignal : variables)
    {
        m_f->m_exp[nsignal]->SetWaveSpace(true);
        m_f->m_exp[nsignal]->BwdTrans(m_f->m_exp[nsignal]->GetCoeffs(),
                                      m_f->m_exp[nsignal]->UpdatePhys());
    }
 
    int nplanes                           = m_f->m_exp[0]->GetZIDs().size();
    NekDouble lz                          = m_f->m_exp[0]->GetHomoLen();
    MultiRegions::ExpListSharedPtr plane0 = m_f->m_exp[0]->GetPlane(0);
    int ntot                              = plane0->GetNpoints();
    Array<OneD, NekDouble> masks(ntot, 0.);
    for (size_t i = 0; i < plane0->GetExpSize(); ++i)
    {
        LocalRegions::ExpansionSharedPtr exp   = plane0->GetExp(i);
        SpatialDomains::GeometrySharedPtr geom = exp->GetGeom();
        int nv                                 = geom->GetNumVerts();
        NekDouble gc[3]                        = {0., 0., 0.};
        NekDouble gct[3]                       = {0., 0., 0.};
        for (size_t j = 0; j < nv; ++j)
        {
            SpatialDomains::PointGeomSharedPtr vertex = geom->GetVertex(j);
            vertex->GetCoords(gct[0], gct[1], gct[2]);
            gc[0] += gct[0] / NekDouble(nv);
            gc[1] += gct[1] / NekDouble(nv);
        }
        if (box[0] <= gc[0] && gc[0] <= box[1] && box[2] <= gc[1] &&
            gc[1] <= box[3])
        {
            Vmath::Fill(exp->GetTotPoints(), 1.,
                        &masks[plane0->GetPhys_Offset(i)], 1);
        }
    }
    NekDouble area = m_f->m_exp[0]->GetPlane(0)->Integral(masks);
    m_f->m_comm->GetSpaceComm()->AllReduce(area, LibUtilities::ReduceMax);
    if (area <= NekConstants::kNekZeroTol)
    {
        area = 1.;
    }
 
    Array<OneD, NekDouble> value(nplanes / 2, 0.);
    for (size_t m = 0; m < value.size(); ++m)
    {
        for (auto nsignal : variables)
        {
            Array<OneD, NekDouble> wavecoef(ntot, 0.);
            Vmath::Vvtvp(ntot, m_f->m_exp[nsignal]->GetPlane(2 * m)->GetPhys(),
                         1, m_f->m_exp[nsignal]->GetPlane(2 * m)->GetPhys(), 1,
                         wavecoef, 1, wavecoef, 1);
            Vmath::Vvtvp(ntot,
                         m_f->m_exp[nsignal]->GetPlane(2 * m + 1)->GetPhys(), 1,
                         m_f->m_exp[nsignal]->GetPlane(2 * m + 1)->GetPhys(), 1,
                         wavecoef, 1, wavecoef, 1);
            Vmath::Vmul(ntot, wavecoef, 1, masks, 1, wavecoef, 1);
            if (m > 0)
            {
                Vmath::Smul(ntot, 0.25, wavecoef, 1, wavecoef, 1);
            }
            value[m] += m_f->m_exp[0]->GetPlane(2 * m)->Integral(wavecoef);
        }
    }
    m_f->m_comm->GetSpaceComm()->AllReduce(value, LibUtilities::ReduceMax);
    if (m_f->m_comm->GetSpaceComm()->GetRank() == 0)
    {
        NekDouble energy = 0.;
        ofstream powersp("spectra.dat");
        powersp << "variables = lambda beta energy" << endl;
        for (size_t m = 1; m < value.size(); ++m)
        {
            powersp << (lz / m) << " " << (2. * M_PI * m / lz) << " "
                    << value[m] << endl;
            energy += value[m] * value[m];
        }
        powersp.close();
        if (vm.count("error"))
        {
            cout << "L 2 error (variable E) : " << energy << endl;
        }
    }
 
    int nfields = m_f->m_variables.size();
    m_f->m_exp.resize(nfields + 1);
    m_f->m_variables.push_back("regions");
    m_f->m_exp[nfields] = m_f->AppendExpList(m_f->m_numHomogeneousDir);
    for (size_t m = 0; m < nplanes; ++m)
    {
        Vmath::Vcopy(ntot, masks, 1,
                     m_f->m_exp[nfields]->GetPlane(m)->UpdatePhys(), 1);
    }
    m_f->m_exp[nfields]->FwdTrans(m_f->m_exp[nfields]->GetPhys(),
                                  m_f->m_exp[nfields]->UpdateCoeffs());
}

References ASSERTL0, Vmath::Fill(), Nektar::ParseUtils::GenerateVariableSet(), Nektar::ParseUtils::GenerateVector(), Nektar::NekConstants::kNekZeroTol, Nektar::FieldUtils::Module::m_config, Nektar::FieldUtils::Module::m_f, Nektar::LibUtilities::ReduceMax, Vmath::Smul(), Vmath::Vcopy(), Vmath::Vmul(), and Vmath::Vvtvp().

Member Data Documentation

className

ModuleKey Nektar::FieldUtils::ProcessPowerSpectrum::className

static

Initial value:

=
    GetModuleFactory().RegisterCreatorFunction(
        ModuleKey(eProcessModule, "powerspectrum"),
        ProcessPowerSpectrum::create,
        "Output power spectrum at given regions from a 3DH1D expansion.")

Definition at line 55 of file ProcessPowerSpectrum.h.