Nektar::FieldUtils::ProcessPrintFldNorms Class Reference

This processing module prints the L2 and LInf norms of the variables in the field. More...

#include <ProcessPrintFldNorms.h>

Inheritance diagram for Nektar::FieldUtils::ProcessPrintFldNorms:

Public Member Functions
	ProcessPrintFldNorms (FieldSharedPtr f)
	~ProcessPrintFldNorms () override
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
void	Process (po::variables_map &vm)
std::string	GetModuleName ()
std::string	GetModuleDescription ()
const ConfigOption &	GetConfigOption (const std::string &key) const
ModulePriority	GetModulePriority ()
std::vector< ModuleKey >	GetModulePrerequisites ()
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

Protected Member Functions
void	v_Process (po::variables_map &vm) override
std::string	v_GetModuleName () override
std::string	v_GetModuleDescription () override
ModulePriority	v_GetModulePriority () override
Protected Member Functions inherited from Nektar::FieldUtils::Module
	Module ()
virtual void	v_Process (po::variables_map &vm)
virtual std::string	v_GetModuleName ()
virtual std::string	v_GetModuleDescription ()
virtual ModulePriority	v_GetModulePriority ()
virtual std::vector< ModuleKey >	v_GetModulePrerequisites ()

Additional Inherited Members
Public Attributes inherited from Nektar::FieldUtils::Module
FieldSharedPtr	m_f
	Field object. More...
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 prints the L2 and LInf norms of the variables in the field.

Definition at line 47 of file ProcessPrintFldNorms.h.

Constructor & Destructor Documentation

ProcessPrintFldNorms()

Nektar::FieldUtils::ProcessPrintFldNorms::ProcessPrintFldNorms

(

FieldSharedPtr

f

)

Definition at line 51 of file ProcessPrintFldNorms.cpp.

                                                           : ProcessModule(f)
{
}

~ProcessPrintFldNorms()

Nektar::FieldUtils::ProcessPrintFldNorms::~ProcessPrintFldNorms ( )

override

Definition at line 55 of file ProcessPrintFldNorms.cpp.

{
}

Member Function Documentation

create()

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

inlinestatic

Creates an instance of this class.

Definition at line 51 of file ProcessPrintFldNorms.h.

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

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

v_GetModuleDescription()

std::string Nektar::FieldUtils::ProcessPrintFldNorms::v_GetModuleDescription ( )

inlineoverrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 68 of file ProcessPrintFldNorms.h.

    {
        return "Printing norms";
    }

v_GetModuleName()

std::string Nektar::FieldUtils::ProcessPrintFldNorms::v_GetModuleName ( )

inlineoverrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 63 of file ProcessPrintFldNorms.h.

    {
        return "ProcessPrintFldNorms";
    }

v_GetModulePriority()

ModulePriority Nektar::FieldUtils::ProcessPrintFldNorms::v_GetModulePriority ( )

inlineoverrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 73 of file ProcessPrintFldNorms.h.

    {
        return eModifyExp;
    }

References Nektar::FieldUtils::eModifyExp.

v_Process()

void Nektar::FieldUtils::ProcessPrintFldNorms::v_Process ( po::variables_map &  vm )

overrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 59 of file ProcessPrintFldNorms.cpp.

{
    m_f->SetUpExp(vm);
 
    // Skip in case of empty partition
    if (m_f->m_exp[0]->GetNumElmts() == 0)
    {
        return;
    }
 
    // Evaluate norms and print
    for (int j = 0; j < m_f->m_exp.size(); ++j)
    {
        NekDouble L2   = m_f->m_exp[j]->L2(m_f->m_exp[j]->GetPhys());
        NekDouble LInf = m_f->m_exp[j]->Linf(m_f->m_exp[j]->GetPhys());
 
        if (m_f->m_comm->GetSpaceComm()->TreatAsRankZero())
        {
            cout << "L 2 error (variable " << m_f->m_variables[j]
                 << ") : " << L2 << endl;
            cout << "L inf error (variable " << m_f->m_variables[j]
                 << ") : " << LInf << endl;
        }
    }
}

References Nektar::FieldUtils::Module::m_f.

Member Data Documentation

className

ModuleKey Nektar::FieldUtils::ProcessPrintFldNorms::className

static

Initial value:

=
    GetModuleFactory().RegisterCreatorFunction(
        ModuleKey(eProcessModule, "printfldnorms"),
        ProcessPrintFldNorms::create, "Print L2 and LInf norms to stdout.")

Definition at line 55 of file ProcessPrintFldNorms.h.