Nektar::Utilities::ProcessMeanMode Class Reference

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

#include <ProcessMeanMode.h>

Inheritance diagram for Nektar::Utilities::ProcessMeanMode:

Collaboration diagram for Nektar::Utilities::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 ()
Public Member Functions inherited from Nektar::Utilities::ProcessHomogeneousPlane
	ProcessHomogeneousPlane (FieldSharedPtr f)
virtual	~ProcessHomogeneousPlane ()
Public Member Functions inherited from Nektar::Utilities::ProcessModule
	ProcessModule ()
	ProcessModule (FieldSharedPtr p_f)
	ProcessModule (MeshSharedPtr p_m)
Public Member Functions inherited from Nektar::Utilities::Module
	Module (FieldSharedPtr p_f)
void	RegisterConfig (string key, string value)
	Register a configuration option with a module. More...
void	PrintConfig ()
	Print out all configuration options for a module. More...
void	SetDefaults ()
	Sets default configuration options for those which have not been set. More...
bool	GetRequireEquiSpaced (void)
void	SetRequireEquiSpaced (bool pVal)
void	EvaluateTriFieldAtEquiSpacedPts (LocalRegions::ExpansionSharedPtr &exp, const Array< OneD, const NekDouble > &infield, Array< OneD, NekDouble > &outfield)
	Module (MeshSharedPtr p_m)
virtual void	Process ()=0
void	RegisterConfig (std::string key, std::string value)
void	PrintConfig ()
void	SetDefaults ()
MeshSharedPtr	GetMesh ()
virtual void	ProcessVertices ()
	Extract element vertices. More...
virtual void	ProcessEdges (bool ReprocessEdges=true)
	Extract element edges. More...
virtual void	ProcessFaces (bool ReprocessFaces=true)
	Extract element faces. More...
virtual void	ProcessElements ()
	Generate element IDs. More...
virtual void	ProcessComposites ()
	Generate composites. More...
virtual void	ClearElementLinks ()

Static Public Member Functions
static boost::shared_ptr< Module >	create (FieldSharedPtr f)
	Creates an instance of this class. More...
Static Public Member Functions inherited from Nektar::Utilities::ProcessHomogeneousPlane
static boost::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::Utilities::ProcessHomogeneousPlane
static ModuleKey	className

Additional Inherited Members
Protected Member Functions inherited from Nektar::Utilities::Module
	Module ()
void	ReorderPrisms (PerMap &perFaces)
	Reorder node IDs so that prisms and tetrahedra are aligned correctly. More...
void	PrismLines (int prism, PerMap &perFaces, std::set< int > &prismsDone, std::vector< ElementSharedPtr > &line)
Protected Attributes inherited from Nektar::Utilities::Module
FieldSharedPtr	m_f
	Field object. More...
map< string, ConfigOption >	m_config
	List of configuration values. More...
bool	m_requireEquiSpaced
MeshSharedPtr	m_mesh
	Mesh 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 50 of file ProcessMeanMode.h.

Constructor & Destructor Documentation

Nektar::Utilities::ProcessMeanMode::ProcessMeanMode

(

FieldSharedPtr

f

)

Definition at line 56 of file ProcessMeanMode.cpp.

                                                 : ProcessHomogeneousPlane(f)
{
}

Nektar::Utilities::ProcessMeanMode::~ProcessMeanMode ( )

virtual

Definition at line 60 of file ProcessMeanMode.cpp.

{
}

Member Function Documentation

static boost::shared_ptr<Module> Nektar::Utilities::ProcessMeanMode::create ( FieldSharedPtr  f )

inlinestatic

Creates an instance of this class.

Definition at line 54 of file ProcessMeanMode.h.

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

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

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

inlinevirtual

Reimplemented from Nektar::Utilities::ProcessHomogeneousPlane.

Definition at line 66 of file ProcessMeanMode.h.

        {
            return "ProcessMeanMode";
        }

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

virtual

Write mesh to output file.

Reimplemented from Nektar::Utilities::ProcessHomogeneousPlane.

Definition at line 64 of file ProcessMeanMode.cpp.

References ASSERTL0, Nektar::Utilities::Module::m_f, Nektar::Utilities::Module::Process(), and Nektar::Utilities::Module::RegisterConfig().

{
    if (m_f->m_verbose)
    {
        if(m_f->m_comm->GetRank() == 0)
        {
            cout << "ProcessMeanMode: Extracting mean mode..." << endl;
        }
    }

    if (m_f->m_fielddef[0]->m_homogeneousZIDs[0] != 0)
    {
        ASSERTL0(false, "ProcessMeanMode: mean mode not found.");
    }

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

    ProcessHomogeneousPlane::Process(vm);
}

Member Data Documentation

ModuleKey Nektar::Utilities::ProcessMeanMode::className

static

Initial value:

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

Definition at line 58 of file ProcessMeanMode.h.