Nektar++
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
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:
Inheritance graph
[legend]
Collaboration diagram for Nektar::FieldUtils::ProcessMeanMode:
Collaboration graph
[legend]

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::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 (string key, 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 bool GetRequireEquiSpaced (void)
 
FIELD_UTILS_EXPORT void SetRequireEquiSpaced (bool pVal)
 
FIELD_UTILS_EXPORT void EvaluateTriFieldAtEquiSpacedPts (LocalRegions::ExpansionSharedPtr &exp, const Array< OneD, const NekDouble > &infield, Array< OneD, NekDouble > &outfield)
 

Static Public Member Functions

static boost::shared_ptr< Modulecreate (FieldSharedPtr f)
 Creates an instance of this class. More...
 
- Static Public Member Functions inherited from Nektar::FieldUtils::ProcessHomogeneousPlane
static boost::shared_ptr< Modulecreate (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...
 
map< string, ConfigOptionm_config
 List of configuration values. More...
 
bool m_requireEquiSpaced
 

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::FieldUtils::ProcessMeanMode::ProcessMeanMode ( FieldSharedPtr  f)

Definition at line 56 of file ProcessMeanMode.cpp.

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

Definition at line 60 of file ProcessMeanMode.cpp.

61 {
62 }

Member Function Documentation

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

Creates an instance of this class.

Definition at line 54 of file ProcessMeanMode.h.

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

55  {
57  }
static boost::shared_ptr< DataType > AllocateSharedPtr()
Allocate a shared pointer from the memory pool.
virtual std::string Nektar::FieldUtils::ProcessMeanMode::GetModuleName ( )
inlinevirtual

Reimplemented from Nektar::FieldUtils::ProcessHomogeneousPlane.

Definition at line 66 of file ProcessMeanMode.h.

67  {
68  return "ProcessMeanMode";
69  }
void Nektar::FieldUtils::ProcessMeanMode::Process ( po::variables_map &  vm)
virtual

Write mesh to output file.

Reimplemented from Nektar::FieldUtils::ProcessHomogeneousPlane.

Definition at line 64 of file ProcessMeanMode.cpp.

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

65 {
66  if (m_f->m_verbose)
67  {
68  if (m_f->m_comm->TreatAsRankZero())
69  {
70  cout << "ProcessMeanMode: Extracting mean mode..." << endl;
71  }
72  }
73 
74  // Set parameters for mean mode
75  RegisterConfig("planeid", "0");
76  RegisterConfig("wavespace", "1");
77 
79 }
virtual void Process(po::variables_map &vm)
Write mesh to output file.
FIELD_UTILS_EXPORT void RegisterConfig(string key, string value)
Register a configuration option with a module.
FieldSharedPtr m_f
Field object.

Member Data Documentation

ModuleKey Nektar::FieldUtils::ProcessMeanMode::className
static
Initial value:
=
ModuleKey(eProcessModule, "meanmode"),
"Extract mean mode from 3DH1D.")

Definition at line 58 of file ProcessMeanMode.h.