Nektar::FieldUtils::ProcessStreamFunction Class Reference

This processing module calculates the stream function of a 2D field and adds it as an extra-field to the output file. More...

#include <ProcessStreamFunction.h>

Inheritance diagram for Nektar::FieldUtils::ProcessStreamFunction:

Public Member Functions
	ProcessStreamFunction (FieldSharedPtr f)
	~ProcessStreamFunction () 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 stream function of a 2D field and adds it as an extra-field to the output file.

Definition at line 46 of file ProcessStreamFunction.h.

Constructor & Destructor Documentation

ProcessStreamFunction()

Nektar::FieldUtils::ProcessStreamFunction::ProcessStreamFunction

(

FieldSharedPtr

f

)

Definition at line 48 of file ProcessStreamFunction.cpp.

    : ProcessModule(f)
{
    m_f->m_declareExpansionAsContField = true;
}

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

~ProcessStreamFunction()

Nektar::FieldUtils::ProcessStreamFunction::~ProcessStreamFunction ( )

override

Definition at line 54 of file ProcessStreamFunction.cpp.

{
}

Member Function Documentation

create()

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

inlinestatic

Creates an instance of this class.

Definition at line 50 of file ProcessStreamFunction.h.

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

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

v_GetModuleDescription()

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

inlineoverrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 68 of file ProcessStreamFunction.h.

    {
        return "Calculating stream-function";
    }

v_GetModuleName()

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

inlineoverrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 63 of file ProcessStreamFunction.h.

    {
        return "ProcessStreamFunction";
    }

v_GetModulePriority()

ModulePriority Nektar::FieldUtils::ProcessStreamFunction::v_GetModulePriority ( )

inlineoverrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 73 of file ProcessStreamFunction.h.

    {
        return eModifyExp;
    }

References Nektar::FieldUtils::eModifyExp.

v_Process()

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

overrideprotectedvirtual

Write mesh to output file.

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 58 of file ProcessStreamFunction.cpp.

{
    m_f->SetUpExp(vm);
 
    int nfields = m_f->m_variables.size();
    // Append field name
    m_f->m_variables.push_back("StreamFunc");
 
    // Skip in case of empty partition
    if (m_f->m_exp[0]->GetNumElmts() == 0)
    {
        return;
    }
 
    // Check if dimension is correct
    int expdim   = m_f->m_graph->GetMeshDimension();
    int spacedim = expdim + m_f->m_numHomogeneousDir;
    ASSERTL0(spacedim == 2, "Stream function can only be obtained in 2D.");
 
    // Allocate arrays
    int npoints = m_f->m_exp[0]->GetNpoints();
    Array<OneD, NekDouble> vx(npoints);
    Array<OneD, NekDouble> uy(npoints);
    Array<OneD, NekDouble> vortNeg(npoints);
 
    // Resize expansion
    m_f->m_exp.resize(nfields + 1);
    m_f->m_exp[nfields] = m_f->AppendExpList(m_f->m_numHomogeneousDir);
 
    // Calculate vorticity: -W_z = Uy - Vx
    m_f->m_exp[0]->PhysDeriv(MultiRegions::DirCartesianMap[1],
                             m_f->m_exp[0]->GetPhys(), uy);
    m_f->m_exp[1]->PhysDeriv(MultiRegions::DirCartesianMap[0],
                             m_f->m_exp[1]->GetPhys(), vx);
 
    Vmath::Vsub(npoints, uy, 1, vx, 1, vortNeg, 1);
 
    // Calculate the Stream Function as the solution of the
    //   Poisson equation: \nabla^2 StreamFunction = -Vorticity
    //   Use same boundary conditions as v
    StdRegions::ConstFactorMap factor;
    factor[StdRegions::eFactorLambda] = 0.0;
 
    m_f->m_exp[1]->HelmSolve(vortNeg, m_f->m_exp[nfields]->UpdateCoeffs(),
                             factor);
    m_f->m_exp[1]->BwdTrans(m_f->m_exp[nfields]->GetCoeffs(),
                            m_f->m_exp[nfields]->UpdatePhys());
}

References ASSERTL0, Nektar::MultiRegions::DirCartesianMap, Nektar::StdRegions::eFactorLambda, Nektar::FieldUtils::Module::m_f, and Vmath::Vsub().

Member Data Documentation

className

ModuleKey Nektar::FieldUtils::ProcessStreamFunction::className

static

Initial value:

=
    GetModuleFactory().RegisterCreatorFunction(
        ModuleKey(eProcessModule, "streamfunction"),
        ProcessStreamFunction::create,
        "Computes stream-function for 2D field.")

Definition at line 54 of file ProcessStreamFunction.h.