Nektar::FieldUtils::ProcessJacobianEnergy Class Reference

This processing module scales the input fld file. More...

#include <ProcessJacobianEnergy.h>

Inheritance diagram for Nektar::FieldUtils::ProcessJacobianEnergy:

Public Member Functions
	ProcessJacobianEnergy (FieldSharedPtr f)
	~ProcessJacobianEnergy () 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
	Write mesh to output file. More...
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 scales the input fld file.

Definition at line 44 of file ProcessJacobianEnergy.h.

Constructor & Destructor Documentation

ProcessJacobianEnergy()

Nektar::FieldUtils::ProcessJacobianEnergy::ProcessJacobianEnergy

(

FieldSharedPtr

f

)

Definition at line 52 of file ProcessJacobianEnergy.cpp.

    : ProcessModule(f)
{
    m_config["topmodes"] =
        ConfigOption(false, "1", "how many top modes to keep ");
}

References Nektar::FieldUtils::Module::m_config.

~ProcessJacobianEnergy()

Nektar::FieldUtils::ProcessJacobianEnergy::~ProcessJacobianEnergy ( )

override

Definition at line 59 of file ProcessJacobianEnergy.cpp.

{
}

Member Function Documentation

create()

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

inlinestatic

Creates an instance of this class.

Definition at line 48 of file ProcessJacobianEnergy.h.

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

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

v_GetModuleDescription()

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

inlineoverrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 66 of file ProcessJacobianEnergy.h.

    {
        return "Processing Jacobian";
    }

v_GetModuleName()

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

inlineoverrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 61 of file ProcessJacobianEnergy.h.

    {
        return "ProcessJacobianEnergy";
    }

v_GetModulePriority()

ModulePriority Nektar::FieldUtils::ProcessJacobianEnergy::v_GetModulePriority ( )

inlineoverrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 71 of file ProcessJacobianEnergy.h.

    {
        return eModifyExp;
    }

References Nektar::FieldUtils::eModifyExp.

v_Process()

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

overrideprotectedvirtual

Write mesh to output file.

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 63 of file ProcessJacobianEnergy.cpp.

{
    m_f->SetUpExp(vm);
 
    int nfields = m_f->m_variables.size();
    m_f->m_variables.push_back("jacenergy");
    // Skip in case of empty partition
    if (m_f->m_exp[0]->GetNumElmts() == 0)
    {
        return;
    }
 
    int NumHomogeneousDir = m_f->m_numHomogeneousDir;
    MultiRegions::ExpListSharedPtr exp;
 
    if (nfields)
    {
        m_f->m_exp.resize(nfields + 1);
        exp                 = m_f->AppendExpList(NumHomogeneousDir);
        m_f->m_exp[nfields] = exp;
    }
    else
    {
        exp = m_f->m_exp[0];
    }
 
    Array<OneD, NekDouble> phys   = exp->UpdatePhys();
    Array<OneD, NekDouble> coeffs = exp->UpdateCoeffs();
    Array<OneD, NekDouble> tmp;
 
    for (int i = 0; i < exp->GetExpSize(); ++i)
    {
        // copy Jacobian into field
        StdRegions::StdExpansionSharedPtr Elmt = exp->GetExp(i);
 
        const StdRegions::StdExpansion *sep = &(*Elmt);
        const LocalRegions::Expansion *lep =
            dynamic_cast<const LocalRegions::Expansion *>(sep);
 
        int nquad       = Elmt->GetTotPoints();
        int coeffoffset = exp->GetCoeff_Offset(i);
        Array<OneD, const NekDouble> Jac =
            lep->GetMetricInfo()->GetJac(Elmt->GetPointsKeys());
        if (lep->GetMetricInfo()->GetGtype() == SpatialDomains::eRegular)
        {
            Vmath::Fill(nquad, Jac[0], phys, 1);
        }
        else
        {
            Vmath::Vcopy(nquad, Jac, 1, phys, 1);
        }
 
        if (lep->GetMetricInfo()->GetGtype() == SpatialDomains::eDeformed)
        {
            NekDouble jacmax = Vmath::Vmax(nquad, Jac, 1);
            NekDouble jacmin = Vmath::Vmin(nquad, Jac, 1);
 
            NekDouble jacmeasure = jacmax / jacmin - 1.0;
            Vmath::Fill(nquad, jacmeasure, phys, 1);
        }
        else
        {
            Vmath::Fill(nquad, 0.0, phys, 1);
        }
 
        Elmt->FwdTrans(phys, tmp = coeffs + coeffoffset);
    }
    exp->BwdTrans(coeffs, phys);
}

References Nektar::SpatialDomains::eDeformed, Nektar::SpatialDomains::eRegular, Vmath::Fill(), Nektar::LocalRegions::Expansion::GetMetricInfo(), Nektar::StdRegions::StdExpansion::GetTotPoints(), Nektar::FieldUtils::Module::m_f, Vmath::Vcopy(), Vmath::Vmax(), and Vmath::Vmin().

Member Data Documentation

className

ModuleKey Nektar::FieldUtils::ProcessJacobianEnergy::className

static

Initial value:

=
    GetModuleFactory().RegisterCreatorFunction(
        ModuleKey(eProcessModule, "jacobianenergy"),
        ProcessJacobianEnergy::create,
        "Show high frequency energy of Jacobian.")

Definition at line 52 of file ProcessJacobianEnergy.h.