Nektar::FieldUtils::ProcessZeroHomogeneousPlane Class Reference

This processing module replaces all expansions by a single plane from 3DH1D fields, defined by the parameter planeid. More...

#include <ProcessZeroHomogeneousPlane.h>

Inheritance diagram for Nektar::FieldUtils::ProcessZeroHomogeneousPlane:

Public Member Functions
	ProcessZeroHomogeneousPlane (FieldSharedPtr f)
	~ProcessZeroHomogeneousPlane () 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 replaces all expansions by a single plane from 3DH1D fields, defined by the parameter planeid.

Definition at line 48 of file ProcessZeroHomogeneousPlane.h.

Constructor & Destructor Documentation

ProcessZeroHomogeneousPlane()

Nektar::FieldUtils::ProcessZeroHomogeneousPlane::ProcessZeroHomogeneousPlane

(

FieldSharedPtr

f

)

Definition at line 54 of file ProcessZeroHomogeneousPlane.cpp.

    : ProcessModule(f)
{
    m_config["planeid"] = ConfigOption(
        false, "0",
        "plane id in wavespace to be set zero. Default planeid is zero");
}

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

~ProcessZeroHomogeneousPlane()

Nektar::FieldUtils::ProcessZeroHomogeneousPlane::~ProcessZeroHomogeneousPlane ( )

override

Definition at line 62 of file ProcessZeroHomogeneousPlane.cpp.

{
}

Member Function Documentation

create()

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

inlinestatic

Creates an instance of this class.

Definition at line 52 of file ProcessZeroHomogeneousPlane.h.

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

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

v_GetModuleDescription()

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

inlineoverrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 70 of file ProcessZeroHomogeneousPlane.h.

    {
        return "Zero the homogeneous plane to visualise the oscillations";
    }

v_GetModuleName()

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

inlineoverrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 65 of file ProcessZeroHomogeneousPlane.h.

    {
        return "ProcessZeroHomogeneousPlane";
    }

v_GetModulePriority()

ModulePriority Nektar::FieldUtils::ProcessZeroHomogeneousPlane::v_GetModulePriority ( )

inlineoverrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 75 of file ProcessZeroHomogeneousPlane.h.

    {
        return eModifyExp;
    }

References Nektar::FieldUtils::eModifyExp.

v_Process()

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

overrideprotectedvirtual

Write mesh to output file.

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 66 of file ProcessZeroHomogeneousPlane.cpp.

{
    m_f->SetUpExp(vm);
 
    if (m_f->m_numHomogeneousDir != 1)
    {
        NEKERROR(ErrorUtil::efatal,
                 "ProcessZeroHomogeneousPlane only works for Homogeneous1D.");
    }
 
    // Skip in case of empty partition
    if (m_f->m_exp[0]->GetNumElmts() == 0)
    {
        return;
    }
 
    int planeid = m_config["planeid"].as<int>();
    int nfields = m_f->m_variables.size();
 
    int nstrips;
    m_f->m_session->LoadParameter("Strip_Z", nstrips, 1);
 
    // Look for correct plane (because of parallel case)
    int plane = -1;
    for (int i = 0; i < m_f->m_exp[0]->GetZIDs().size(); ++i)
    {
        if (m_f->m_exp[0]->GetZIDs()[i] == planeid)
        {
            plane = i;
        }
    }
 
    if (plane != -1)
    {
        for (int s = 0; s < nstrips; ++s)
        {
            for (int i = 0; i < nfields; ++i)
            {
                int n = s * nfields + i;
 
                // Find the memory location, set zeros
                int Ncoeff = m_f->m_exp[n]->GetPlane(plane)->GetNcoeffs();
                Vmath::Zero(Ncoeff,
                            m_f->m_exp[n]->GetPlane(plane)->UpdateCoeffs(), 1);
 
                m_f->m_exp[n]->BwdTrans(m_f->m_exp[n]->GetCoeffs(),
                                        m_f->m_exp[n]->UpdatePhys());
            }
        }
    }
    else
    {
        NEKERROR(ErrorUtil::efatal, "Plane not found.");
    }
}

References Nektar::ErrorUtil::efatal, Nektar::FieldUtils::Module::m_config, Nektar::FieldUtils::Module::m_f, NEKERROR, and Vmath::Zero().

Member Data Documentation

className

ModuleKey Nektar::FieldUtils::ProcessZeroHomogeneousPlane::className

static

Initial value:

=
    GetModuleFactory().RegisterCreatorFunction(
        ModuleKey(eProcessModule, "zero-homo-plane"),
        ProcessZeroHomogeneousPlane::create,
        "Extracts a plane from a 3DH1D expansion, requires planeid to be "
        "defined.")

Definition at line 56 of file ProcessZeroHomogeneousPlane.h.