Nektar::FieldUtils::ProcessQCriterion Class Reference

This processing module calculates the Q Criterion and adds it as an extra-field to the output file. More...

#include <ProcessQCriterion.h>

Inheritance diagram for Nektar::FieldUtils::ProcessQCriterion:

Public Member Functions
	ProcessQCriterion (FieldSharedPtr f)
	~ProcessQCriterion () 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 calculates the Q Criterion and adds it as an extra-field to the output file.

Definition at line 47 of file ProcessQCriterion.h.

Constructor & Destructor Documentation

ProcessQCriterion()

Nektar::FieldUtils::ProcessQCriterion::ProcessQCriterion

(

FieldSharedPtr

f

)

Definition at line 51 of file ProcessQCriterion.cpp.

                                                     : ProcessModule(f)
{
}

~ProcessQCriterion()

Nektar::FieldUtils::ProcessQCriterion::~ProcessQCriterion ( )

override

Definition at line 55 of file ProcessQCriterion.cpp.

{
}

Member Function Documentation

create()

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

inlinestatic

Creates an instance of this class.

Definition at line 51 of file ProcessQCriterion.h.

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

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

v_GetModuleDescription()

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

inlineoverrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 69 of file ProcessQCriterion.h.

    {
        return "Calculating Q Criterion";
    }

v_GetModuleName()

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

inlineoverrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 64 of file ProcessQCriterion.h.

    {
        return "ProcessQCriterion";
    }

v_GetModulePriority()

ModulePriority Nektar::FieldUtils::ProcessQCriterion::v_GetModulePriority ( )

inlineoverrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 74 of file ProcessQCriterion.h.

    {
        return eModifyExp;
    }

References Nektar::FieldUtils::eModifyExp.

v_Process()

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

overrideprotectedvirtual

Write mesh to output file.

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 59 of file ProcessQCriterion.cpp.

{
    m_f->SetUpExp(vm);
 
    int nfields = m_f->m_variables.size();
    m_f->m_variables.push_back("Q");
    // Skip in case of empty partition
    if (m_f->m_exp[0]->GetNumElmts() == 0)
    {
        return;
    }
 
    int i, s;
    int expdim   = m_f->m_graph->GetMeshDimension();
    int spacedim = expdim + (m_f->m_numHomogeneousDir);
 
    ASSERTL0(
        spacedim == 3 || spacedim == 2,
        "ProcessQCriterion must be computed for a 2D, quasi-3D, or 3D case.");
 
    int npoints = m_f->m_exp[0]->GetNpoints();
 
    Array<OneD, Array<OneD, NekDouble>> grad(spacedim * spacedim);
 
    Array<OneD, NekDouble> omega(npoints, 0.);
    Array<OneD, NekDouble> S(npoints, 0.);
 
    // Will store the Q-Criterion
    Array<OneD, NekDouble> outfield(npoints);
 
    int nstrips;
 
    m_f->m_session->LoadParameter("Strip_Z", nstrips, 1);
 
    for (i = 0; i < spacedim * spacedim; ++i)
    {
        grad[i] = Array<OneD, NekDouble>(npoints);
    }
 
    MultiRegions::ExpListSharedPtr Exp;
 
    for (s = 0; s < nstrips; ++s) // homogeneous strip varient
    {
        Exp     = m_f->AppendExpList(m_f->m_numHomogeneousDir);
        auto it = m_f->m_exp.begin() + s * (nfields + 1) + nfields;
        m_f->m_exp.insert(it, Exp);
    }
 
    NekDouble fac = 0.5;
    if (spacedim == 2)
    {
        for (s = 0; s < nstrips; ++s) // homogeneous strip varient
        {
            for (i = 0; i < spacedim; ++i)
            {
                m_f->m_exp[s * nfields + i]->PhysDeriv(
                    m_f->m_exp[s * nfields + i]->GetPhys(), grad[i * spacedim],
                    grad[i * spacedim + 1]);
            }
 
            // W_z = Vx - Uy
            Vmath::Vsub(npoints, grad[1 * spacedim + 0], 1,
                        grad[0 * spacedim + 1], 1, outfield, 1);
            // W_z^2
            Vmath::Vmul(npoints, outfield, 1, outfield, 1, omega, 1);
 
            // Ux^2
            Vmath::Vmul(npoints, grad[0 * spacedim + 0], 1,
                        grad[0 * spacedim + 0], 1, S, 1);
            // Vy^2
            Vmath::Vvtvp(npoints, grad[1 * spacedim + 1], 1,
                         grad[1 * spacedim + 1], 1, S, 1, S, 1);
 
            // Vx + Uy
            Vmath::Vadd(npoints, grad[1 * spacedim + 0], 1,
                        grad[0 * spacedim + 1], 1, outfield, 1);
            Vmath::Vmul(npoints, outfield, 1, outfield, 1, outfield, 1);
            Vmath::Svtvp(npoints, fac, outfield, 1, S, 1, S, 1);
 
            Vmath::Svtvm(npoints, fac, omega, 1, S, 1, outfield, 1);
            Vmath::Smul(npoints, fac, outfield, 1, outfield, 1);
 
            int fid = s * (nfields + 1) + nfields;
            Vmath::Vcopy(npoints, outfield, 1, m_f->m_exp[fid]->UpdatePhys(),
                         1);
            Exp->FwdTransLocalElmt(outfield, m_f->m_exp[fid]->UpdateCoeffs());
        }
    }
    else if (spacedim == 3)
    {
        Array<OneD, NekDouble> outfield1(npoints);
        Array<OneD, NekDouble> outfield2(npoints);
        Array<OneD, NekDouble> outfield3(npoints);
        for (s = 0; s < nstrips; ++s) // homogeneous strip varient
        {
            for (i = 0; i < spacedim; ++i)
            {
                m_f->m_exp[s * nfields + i]->PhysDeriv(
                    m_f->m_exp[s * nfields + i]->GetPhys(), grad[i * spacedim],
                    grad[i * spacedim + 1], grad[i * spacedim + 2]);
            }
 
            // W_x = Wy - Vz
            Vmath::Vsub(npoints, grad[2 * spacedim + 1], 1,
                        grad[1 * spacedim + 2], 1, outfield1, 1);
            // W_x^2
            Vmath::Vmul(npoints, outfield1, 1, outfield1, 1, outfield1, 1);
 
            // W_y = Uz - Wx
            Vmath::Vsub(npoints, grad[0 * spacedim + 2], 1,
                        grad[2 * spacedim + 0], 1, outfield2, 1);
            // W_y^2
            Vmath::Vmul(npoints, outfield2, 1, outfield2, 1, outfield2, 1);
 
            // W_z = Vx - Uy
            Vmath::Vsub(npoints, grad[1 * spacedim + 0], 1,
                        grad[0 * spacedim + 1], 1, outfield3, 1);
            // W_z^2
            Vmath::Vmul(npoints, outfield3, 1, outfield3, 1, outfield3, 1);
 
            // Omega = 0.5*(W_x^2 + W_y^2 + W_z^2)
            Vmath::Vadd(npoints, outfield1, 1, outfield2, 1, omega, 1);
            Vmath::Vadd(npoints, omega, 1, outfield3, 1, omega, 1);
            Vmath::Smul(npoints, fac, omega, 1, omega, 1);
 
            // Ux^2
            Vmath::Vmul(npoints, grad[0 * spacedim + 0], 1,
                        grad[0 * spacedim + 0], 1, outfield1, 1);
            // Vy^2
            Vmath::Vmul(npoints, grad[1 * spacedim + 1], 1,
                        grad[1 * spacedim + 1], 1, outfield2, 1);
            // Wz^2
            Vmath::Vmul(npoints, grad[2 * spacedim + 2], 1,
                        grad[2 * spacedim + 2], 1, outfield3, 1);
 
            //
            Vmath::Vadd(npoints, outfield1, 1, outfield2, 1, S, 1);
            Vmath::Vadd(npoints, S, 1, outfield3, 1, S, 1);
 
            // Wy + Vz
            Vmath::Vadd(npoints, grad[2 * spacedim + 1], 1,
                        grad[1 * spacedim + 2], 1, outfield1, 1);
            Vmath::Vmul(npoints, outfield1, 1, outfield1, 1, outfield1, 1);
 
            // Uz + Wx
            Vmath::Vadd(npoints, grad[0 * spacedim + 2], 1,
                        grad[2 * spacedim + 0], 1, outfield2, 1);
            Vmath::Vmul(npoints, outfield2, 1, outfield2, 1, outfield2, 1);
 
            // Vx + Uy
            Vmath::Vadd(npoints, grad[1 * spacedim + 0], 1,
                        grad[0 * spacedim + 1], 1, outfield3, 1);
            Vmath::Vmul(npoints, outfield3, 1, outfield3, 1, outfield3, 1);
 
            Vmath::Vadd(npoints, outfield1, 1, outfield2, 1, outfield2, 1);
            Vmath::Vadd(npoints, outfield2, 1, outfield3, 1, outfield3, 1);
 
            Vmath::Smul(npoints, fac, outfield3, 1, outfield3, 1);
 
            Vmath::Vadd(npoints, outfield3, 1, S, 1, S, 1);
            Vmath::Vsub(npoints, omega, 1, S, 1, outfield, 1);
 
            Vmath::Smul(npoints, fac, outfield, 1, outfield, 1);
 
            int fid = s * (nfields + 1) + nfields;
            Vmath::Vcopy(npoints, outfield, 1, m_f->m_exp[fid]->UpdatePhys(),
                         1);
            Exp->FwdTransLocalElmt(outfield, m_f->m_exp[fid]->UpdateCoeffs());
        }
    }
}

References ASSERTL0, Nektar::FieldUtils::Module::m_f, Vmath::Smul(), Vmath::Svtvm(), Vmath::Svtvp(), Vmath::Vadd(), Vmath::Vcopy(), Vmath::Vmul(), Vmath::Vsub(), and Vmath::Vvtvp().

Member Data Documentation

className

ModuleKey Nektar::FieldUtils::ProcessQCriterion::className

static

Initial value:

=
    GetModuleFactory().RegisterCreatorFunction(
        ModuleKey(eProcessModule, "QCriterion"), ProcessQCriterion::create,
        "Computes Q-Criterion.")

Definition at line 55 of file ProcessQCriterion.h.