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:

Collaboration diagram for Nektar::FieldUtils::ProcessPrintFldNorms:

Public Member Functions
	ProcessPrintFldNorms (FieldSharedPtr f)
virtual	~ProcessPrintFldNorms ()
virtual void	Process (po::variables_map &vm)
virtual std::string	GetModuleName ()
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< Module >	create (FieldSharedPtr f)
	Creates an instance of this class. More...

Static Public Attributes
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, ConfigOption >	m_config
	List of configuration values. More...
bool	m_requireEquiSpaced

Detailed Description

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

Definition at line 50 of file ProcessPrintFldNorms.h.

Constructor & Destructor Documentation

Nektar::FieldUtils::ProcessPrintFldNorms::ProcessPrintFldNorms

(

FieldSharedPtr

f

)

Definition at line 56 of file ProcessPrintFldNorms.cpp.

                                                           : ProcessModule(f)
{
}

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

virtual

Definition at line 60 of file ProcessPrintFldNorms.cpp.

{
}

Member Function Documentation

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

inlinestatic

Creates an instance of this class.

Definition at line 54 of file ProcessPrintFldNorms.h.

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

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

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

inlinevirtual

Implements Nektar::FieldUtils::Module.

Definition at line 65 of file ProcessPrintFldNorms.h.

    {
        return "ProcessPrintFldNorms";
    }

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

virtual

Implements Nektar::FieldUtils::Module.

Definition at line 64 of file ProcessPrintFldNorms.cpp.

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

{
    if (m_f->m_verbose)
    {
        if (m_f->m_comm->TreatAsRankZero())
        {
            cout << "ProcessPrintFldNorms: Printing norms..." << endl;
        }
    }

    // Evaluate norms and print
    for (int j = 0; j < m_f->m_exp.size(); ++j)
    {
        m_f->m_exp[j]->BwdTrans(m_f->m_exp[j]->GetCoeffs(),
                                m_f->m_exp[j]->UpdatePhys());
        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());

        cout << "L 2 error (variable " << m_f->m_session->GetVariable(j)
             << ") : " << L2 << endl;
        cout << "L inf error (variable " << m_f->m_session->GetVariable(j)
             << ") : " << LInf << endl;
    }
}

Member Data Documentation

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 58 of file ProcessPrintFldNorms.h.