Nektar::FieldUtils::ProcessHalfModeToFourier Class Reference

This processing modifies Fourier Half Mode to a Fourier expansion. More...

#include <ProcessHalfModeToFourier.h>

Inheritance diagram for Nektar::FieldUtils::ProcessHalfModeToFourier:

Public Member Functions
	ProcessHalfModeToFourier (FieldSharedPtr f)
	~ProcessHalfModeToFourier () 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 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 modifies Fourier Half Mode to a Fourier expansion.

Definition at line 47 of file ProcessHalfModeToFourier.h.

Constructor & Destructor Documentation

ProcessHalfModeToFourier()

Nektar::FieldUtils::ProcessHalfModeToFourier::ProcessHalfModeToFourier

(

FieldSharedPtr

f

)

Definition at line 55 of file ProcessHalfModeToFourier.cpp.

    : ProcessModule(f)
{
    m_priority = eModifyFieldData;
    m_config["realmodetoimag"] =
        ConfigOption(false, "NotSet", "Take fields as sin mode");
}

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

~ProcessHalfModeToFourier()

Nektar::FieldUtils::ProcessHalfModeToFourier::~ProcessHalfModeToFourier ( )

override

Definition at line 63 of file ProcessHalfModeToFourier.cpp.

{
}

Member Function Documentation

create()

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

inlinestatic

Creates an instance of this class.

Definition at line 51 of file ProcessHalfModeToFourier.h.

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

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

v_GetModuleDescription()

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

inlineoverrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 69 of file ProcessHalfModeToFourier.h.

    {
        return "Modify Fourier Half Mode to Fourier Expansion";
    }

v_GetModuleName()

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

inlineoverrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 64 of file ProcessHalfModeToFourier.h.

    {
        return "ProcessHalfModeToFourier";
    }

v_GetModulePriority()

ModulePriority Nektar::FieldUtils::ProcessHalfModeToFourier::v_GetModulePriority ( )

inlineoverrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 74 of file ProcessHalfModeToFourier.h.

    {
        return m_priority;
    }

References m_priority.

v_Process()

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

overrideprotectedvirtual

Write mesh to output file.

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 67 of file ProcessHalfModeToFourier.cpp.

{
    set<int> sinmode;
    if (m_config["realmodetoimag"].as<string>().compare("NotSet"))
    {
        ParseUtils::GenerateVariableSet(m_config["realmodetoimag"].as<string>(),
                                        m_f->m_variables, sinmode);
    }
    // modify field definition
    for (int i = 0; i < m_f->m_data.size(); ++i)
    {
        ASSERTL0((m_f->m_fielddef[i]->m_basis[2] ==
                      LibUtilities::eFourierHalfModeRe ||
                  m_f->m_fielddef[i]->m_basis[2] ==
                      LibUtilities::eFourierHalfModeIm),
                 "This module is only for fourier Half modes");
 
        // change HomogeneousID
        m_f->m_fielddef[i]->m_homogeneousZIDs.resize(2);
        m_f->m_fielddef[i]->m_homogeneousZIDs[0] = 2;
        m_f->m_fielddef[i]->m_homogeneousZIDs[1] = 3;
        // change expansion
        int nelemts = m_f->m_fielddef[i]->m_elementIDs.size();
        if (m_f->m_fielddef[i]->m_uniOrder)
        {
            m_f->m_fielddef[i]->m_numModes[2] = 4;
        }
        else
        {
            for (int e = 0; e < nelemts; ++e)
            {
                m_f->m_fielddef[i]->m_numModes[3 * e + 2] = 4;
            }
        }
 
        // Set third expansion to Fourier
        m_f->m_fielddef[i]->m_basis[2] = LibUtilities::eFourier;
 
        // copy data
        int ndata              = m_f->m_data[i].size();
        vector<NekDouble> data = m_f->m_data[i];
        m_f->m_data[i].resize(2 * ndata);
        int offset = 0, count = 0;
        for (size_t n = 0; n < m_f->m_fielddef[i]->m_fields.size(); ++n)
        {
            int datalen = LibUtilities::GetNumberOfCoefficients(
                m_f->m_fielddef[i]->m_shapeType,
                m_f->m_fielddef[i]->m_numModes[0],
                m_f->m_fielddef[i]->m_numModes[1]);
            for (int e = 0; e < nelemts; ++e)
            {
                if (!m_f->m_fielddef[i]->m_uniOrder)
                {
 
                    datalen = LibUtilities::GetNumberOfCoefficients(
                        m_f->m_fielddef[i]->m_shapeType,
                        m_f->m_fielddef[i]->m_numModes[3 * e],
                        m_f->m_fielddef[i]->m_numModes[3 * e + 1]);
                }
                if (sinmode.count(n))
                {
                    for (int l = 0; l < datalen; ++l)
                    {
                        m_f->m_data[i][count++] = 0.;
                    }
                    for (int l = 0; l < datalen; ++l)
                    {
                        m_f->m_data[i][count++] = -data[offset + l];
                    }
                }
                else
                {
                    for (int l = 0; l < datalen; ++l)
                    {
                        m_f->m_data[i][count++] = data[offset + l];
                    }
                    for (int l = 0; l < datalen; ++l)
                    {
                        m_f->m_data[i][count++] = 0.;
                    }
                }
                offset += datalen;
            }
        }
    }
}

References ASSERTL0, Nektar::LibUtilities::eFourier, Nektar::LibUtilities::eFourierHalfModeIm, Nektar::LibUtilities::eFourierHalfModeRe, Nektar::ParseUtils::GenerateVariableSet(), Nektar::LibUtilities::GetNumberOfCoefficients(), Nektar::FieldUtils::Module::m_config, and Nektar::FieldUtils::Module::m_f.

Member Data Documentation

className

ModuleKey Nektar::FieldUtils::ProcessHalfModeToFourier::className

static

Initial value:

=
    GetModuleFactory().RegisterCreatorFunction(
        ModuleKey(eProcessModule, "halfmodetofourier"),
        ProcessHalfModeToFourier::create,
        "modify a FourierHalfMode into a Fourier expansion so it can be "
        "processed as a 3D field.")

Definition at line 55 of file ProcessHalfModeToFourier.h.

m_priority

ModulePriority Nektar::FieldUtils::ProcessHalfModeToFourier::m_priority

private

Definition at line 80 of file ProcessHalfModeToFourier.h.

Referenced by ProcessHalfModeToFourier(), and v_GetModulePriority().