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)
virtual	~ProcessMeanMode ()
virtual void	Process (po::variables_map &vm)
	Write mesh to output file. More...
virtual std::string	GetModuleName ()
virtual std::string	GetModuleDescription ()
virtual ModulePriority	GetModulePriority ()
Public Member Functions inherited from Nektar::FieldUtils::ProcessHomogeneousPlane
	ProcessHomogeneousPlane (FieldSharedPtr f)
virtual	~ProcessHomogeneousPlane ()
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)
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	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

Additional Inherited Members
Protected Member Functions inherited from Nektar::FieldUtils::Module
	Module ()
Protected Attributes inherited from Nektar::FieldUtils::Module
FieldSharedPtr	m_f
	Field object. More...
std::map< std::string, ConfigOption >	m_config
	List of configuration values. More...

Detailed Description

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

Definition at line 49 of file ProcessMeanMode.h.

Constructor & Destructor Documentation

ProcessMeanMode()

Nektar::FieldUtils::ProcessMeanMode::ProcessMeanMode

(

FieldSharedPtr

f

)

Definition at line 54 of file ProcessMeanMode.cpp.

                                                 : ProcessHomogeneousPlane(f)
{
}

~ProcessMeanMode()

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

virtual

Definition at line 58 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 53 of file ProcessMeanMode.h.

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

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

GetModuleDescription()

virtual std::string Nektar::FieldUtils::ProcessMeanMode::GetModuleDescription ( )

inlinevirtual

Reimplemented from Nektar::FieldUtils::ProcessHomogeneousPlane.

Definition at line 70 of file ProcessMeanMode.h.

    {
        return "Extracting mean mode";
    }

GetModuleName()

virtual std::string Nektar::FieldUtils::ProcessMeanMode::GetModuleName ( )

inlinevirtual

Reimplemented from Nektar::FieldUtils::ProcessHomogeneousPlane.

Definition at line 65 of file ProcessMeanMode.h.

    {
        return "ProcessMeanMode";
    }

GetModulePriority()

virtual ModulePriority Nektar::FieldUtils::ProcessMeanMode::GetModulePriority ( )

inlinevirtual

Reimplemented from Nektar::FieldUtils::ProcessHomogeneousPlane.

Definition at line 75 of file ProcessMeanMode.h.

References Nektar::FieldUtils::eModifyExp.

    {
        return eModifyExp;
    }

Process()

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

virtual

Write mesh to output file.

Reimplemented from Nektar::FieldUtils::ProcessHomogeneousPlane.

Definition at line 62 of file ProcessMeanMode.cpp.

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

{
    // Set parameters for mean mode
    RegisterConfig("planeid", "0");
    RegisterConfig("wavespace", "1");

    ProcessHomogeneousPlane::Process(vm);
}

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 57 of file ProcessMeanMode.h.