Nektar::FieldUtils::ProcessMeanMode Class Reference

This processing module replaces all expansions by the mean mode from 3DH1D fields. More...

#include <ProcessMeanMode.h>

Inheritance diagram for Nektar::FieldUtils::ProcessMeanMode:

Public Member Functions
	ProcessMeanMode (FieldSharedPtr f)
	~ProcessMeanMode () override
Public Member Functions inherited from Nektar::FieldUtils::ProcessHomogeneousPlane
	ProcessHomogeneousPlane (FieldSharedPtr f)
	~ProcessHomogeneousPlane () 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 Member Functions inherited from Nektar::FieldUtils::ProcessHomogeneousPlane
static std::shared_ptr< Module >	create (FieldSharedPtr f)
	Creates an instance of this class. More...

Static Public Attributes
static ModuleKey	className
Static Public Attributes inherited from Nektar::FieldUtils::ProcessHomogeneousPlane
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
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 the mean mode from 3DH1D fields.

Definition at line 47 of file ProcessMeanMode.h.

Constructor & Destructor Documentation

ProcessMeanMode()

Nektar::FieldUtils::ProcessMeanMode::ProcessMeanMode

(

FieldSharedPtr

f

)

Definition at line 51 of file ProcessMeanMode.cpp.

                                                 : ProcessHomogeneousPlane(f)
{
}

~ProcessMeanMode()

Nektar::FieldUtils::ProcessMeanMode::~ProcessMeanMode ( )

override

Definition at line 55 of file ProcessMeanMode.cpp.

{
}

Member Function Documentation

create()

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

inlinestatic

Creates an instance of this class.

Definition at line 51 of file ProcessMeanMode.h.

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

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

v_GetModuleDescription()

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

inlineoverrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::ProcessHomogeneousPlane.

Definition at line 69 of file ProcessMeanMode.h.

    {
        return "Extracting mean mode";
    }

v_GetModuleName()

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

inlineoverrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::ProcessHomogeneousPlane.

Definition at line 64 of file ProcessMeanMode.h.

    {
        return "ProcessMeanMode";
    }

v_GetModulePriority()

ModulePriority Nektar::FieldUtils::ProcessMeanMode::v_GetModulePriority ( )

inlineoverrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::ProcessHomogeneousPlane.

Definition at line 74 of file ProcessMeanMode.h.

    {
        return eModifyExp;
    }

References Nektar::FieldUtils::eModifyExp.

v_Process()

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

overrideprotectedvirtual

Write mesh to output file.

Reimplemented from Nektar::FieldUtils::ProcessHomogeneousPlane.

Definition at line 59 of file ProcessMeanMode.cpp.

{
    // Set parameters for mean mode
    RegisterConfig("planeid", "0");
    RegisterConfig("wavespace", "1");
 
    ProcessHomogeneousPlane::v_Process(vm);
}

References Nektar::FieldUtils::Module::RegisterConfig(), and Nektar::FieldUtils::ProcessHomogeneousPlane::v_Process().

Member Data Documentation

className

ModuleKey Nektar::FieldUtils::ProcessMeanMode::className

static

Initial value:

=
    GetModuleFactory().RegisterCreatorFunction(
        ModuleKey(eProcessModule, "meanmode"), ProcessMeanMode::create,
        "Extract mean mode from 3DH1D.")

Definition at line 55 of file ProcessMeanMode.h.