Nektar::FieldUtils::ProcessDOF Class Reference

This processing module calculates the number of DOF. More...

#include <ProcessDOF.h>

Inheritance diagram for Nektar::FieldUtils::ProcessDOF:

Public Member Functions
	ProcessDOF (FieldSharedPtr f)
virtual	~ProcessDOF ()
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::ProcessModule
	ProcessModule ()
	ProcessModule (FieldSharedPtr p_f)
Public Member Functions inherited from Nektar::FieldUtils::Module
FIELD_UTILS_EXPORT	Module (FieldSharedPtr p_f)
virtual	~Module ()=default
const ConfigOption &	GetConfigOption (const std::string &key) const
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 Attributes
static ModuleKey	className

Additional Inherited Members
Public Attributes inherited from Nektar::FieldUtils::Module
FieldSharedPtr	m_f
	Field object. More...
Protected Member Functions inherited from Nektar::FieldUtils::Module
	Module ()
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 calculates the number of DOF.

Definition at line 47 of file ProcessDOF.h.

Constructor & Destructor Documentation

ProcessDOF()

Nektar::FieldUtils::ProcessDOF::ProcessDOF

(

FieldSharedPtr

f

)

Definition at line 54 of file ProcessDOF.cpp.

                                       : ProcessModule(f)
{
}

~ProcessDOF()

Nektar::FieldUtils::ProcessDOF::~ProcessDOF ( )

virtual

Definition at line 58 of file ProcessDOF.cpp.

{
}

Member Function Documentation

create()

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

inlinestatic

Creates an instance of this class.

Definition at line 51 of file ProcessDOF.h.

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

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

GetModuleDescription()

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

inlinevirtual

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 68 of file ProcessDOF.h.

    {
        return "Calculating number of DOF";
    }

GetModuleName()

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

inlinevirtual

Implements Nektar::FieldUtils::Module.

Definition at line 63 of file ProcessDOF.h.

    {
        return "ProcessDOF";
    }

GetModulePriority()

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

inlinevirtual

Implements Nektar::FieldUtils::Module.

Definition at line 73 of file ProcessDOF.h.

    {
        return eModifyExp;
    }

References Nektar::FieldUtils::eModifyExp.

Process()

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

virtual

Write mesh to output file.

Implements Nektar::FieldUtils::Module.

Definition at line 62 of file ProcessDOF.cpp.

{
    m_f->SetUpExp(vm);
 
    int nDOF = m_f->m_exp[0]->GetNcoeffs();
    m_f->m_comm->AllReduce(nDOF, LibUtilities::ReduceSum);
 
    if (m_f->m_comm->GetRank() == 0)
    {
        cout << "Total number of DOF: " << nDOF << endl;
    }
 
}

References Nektar::FieldUtils::Module::m_f, and Nektar::LibUtilities::ReduceSum.

Member Data Documentation

className

ModuleKey Nektar::FieldUtils::ProcessDOF::className

static

Initial value:

=
    GetModuleFactory().RegisterCreatorFunction(
        ModuleKey(eProcessModule, "dof"),
        ProcessDOF::create,
        "Computes number of DOF.")

Definition at line 55 of file ProcessDOF.h.