All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | List of all members
Nektar::Utilities::ProcessModule Class Reference

Abstract base class for processing modules. More...

#include <Module.h>

Inheritance diagram for Nektar::Utilities::ProcessModule:
Inheritance graph
Collaboration diagram for Nektar::Utilities::ProcessModule:
Collaboration graph

Public Member Functions

 ProcessModule (FieldSharedPtr p_f)
 ProcessModule (MeshSharedPtr p_m)
- Public Member Functions inherited from Nektar::Utilities::Module
 Module (FieldSharedPtr p_f)
virtual void Process (po::variables_map &vm)=0
void RegisterConfig (string key, string value)
 Register a configuration option with a module.
void PrintConfig ()
 Print out all configuration options for a module.
void SetDefaults ()
 Sets default configuration options for those which have not been set.
bool GetRequireEquiSpaced (void)
void SetRequireEquiSpaced (bool pVal)
 Module (MeshSharedPtr p_m)
virtual void Process ()=0
void RegisterConfig (string key, string value)
void PrintConfig ()
void SetDefaults ()
MeshSharedPtr GetMesh ()
virtual void ProcessVertices ()
 Extract element vertices.

Additional Inherited Members

- Protected Member Functions inherited from Nektar::Utilities::Module
virtual void ProcessEdges (bool ReprocessEdges=true)
 Extract element edges.
virtual void ProcessFaces (bool ReprocessFaces=true)
 Extract element faces.
virtual void ProcessElements ()
 Generate element IDs.
virtual void ProcessComposites ()
 Generate composites.
void ReorderPrisms (PerMap &perFaces)
 Reorder node IDs so that prisms and tetrahedra are aligned correctly.
void PrismLines (int prism, PerMap &perFaces, set< int > &prismsDone, vector< ElementSharedPtr > &line)
- Protected Attributes inherited from Nektar::Utilities::Module
FieldSharedPtr m_f
 Field object.
map< string, ConfigOptionm_config
 List of configuration values.
bool m_requireEquiSpaced
MeshSharedPtr m_mesh
 Mesh object.

Detailed Description

Abstract base class for processing modules.

Processing modules take a populated Mesh object and process it in some fashion; for example the ProcessJac module calculates the Jacobian of each element and prints warnings for non-positive elements.

Definition at line 190 of file PostProcessing/FieldConvert/Module.h.

Constructor & Destructor Documentation

Nektar::Utilities::ProcessModule::ProcessModule ( FieldSharedPtr  p_f)

Definition at line 193 of file PostProcessing/FieldConvert/Module.h.

: Module(p_f) {}
Nektar::Utilities::ProcessModule::ProcessModule ( MeshSharedPtr  p_m)

Definition at line 217 of file PreProcessing/MeshConvert/Module.h.

: Module(p_m) {}