#include <ProcessLocalStabilityAnalysis.h>

Inheritance diagram for Nektar::FieldUtils::ProcessLocalStabilityAnalysis:

Public Member Functions
	ProcessLocalStabilityAnalysis (FieldSharedPtr f)

	~ProcessLocalStabilityAnalysis () override

void	v_Process (po::variables_map &vm) override
	Write mesh to output file. More...

std::string	v_GetModuleName () override

std::string	v_GetModuleDescription () override

void	call_hello ()

void	call_lst (const long int &option, const NekDouble finalValue1, const long int &numStep1, const NekDouble finalValue2, const long int &numStep2)

Public Member Functions inherited from Nektar::FieldUtils::ProcessBoundaryExtract
	ProcessBoundaryExtract (FieldSharedPtr f)

	~ProcessBoundaryExtract () 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 Member Functions inherited from Nektar::FieldUtils::ProcessBoundaryExtract
static std::shared_ptr< Module >	create (FieldSharedPtr f)
	Creates an instance of this class. More...

Static Public Attributes
static ModuleKey	className

Static Public Attributes inherited from Nektar::FieldUtils::ProcessBoundaryExtract
static ModuleKey	className

Private Member Functions
void	GenerateInputFiles ()

Private Attributes
int	m_NSTART = 1

int	m_ITSE = 0

int	m_INEUTRL = 0

NekDouble	m_BETALIN = 0

NekDouble	m_FREQLIN = 2000

int	m_NGLOBAL = 25

int	m_NLOCAL = 121

int	m_ITOLRAY = 5

std::string	m_LABEL = "\'localStabilityAnalysis\'"

int	m_ITSPRES = 0

int	m_IEIGL = 1

NekDouble	m_RGAS = 287.0

NekDouble	m_GAMMA = 1.4

NekDouble	m_PRANDTL = 0.72

Additional Inherited Members
Public Attributes inherited from Nektar::FieldUtils::Module
FieldSharedPtr	m_f
	Field object. More...

Protected Member Functions inherited from Nektar::FieldUtils::ProcessBoundaryExtract
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 ()

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

Definition at line 61 of file ProcessLocalStabilityAnalysis.h.

Constructor & Destructor Documentation

◆ ProcessLocalStabilityAnalysis()

Nektar::FieldUtils::ProcessLocalStabilityAnalysis::ProcessLocalStabilityAnalysis ( FieldSharedPtr f )

Definition at line 57 of file ProcessLocalStabilityAnalysis.cpp.

    : ProcessBoundaryExtract(f)
{
    f->m_writeBndFld = false; // turned on in upstream ProcessBoundaryExtract
 
    m_config["opt"] =
        ConfigOption(false, "6", "Option for quantity to compute.\n \
                              6 - scan frequency\n \
                              7 - scan spanwise wavenumber\n \
                              8 - scan both frequency and spanwise wavenumber");
    m_config["finVal1"] =
        ConfigOption(false, "0.1", "Final value for the 1st quantity.");
    m_config["numStep1"] =
        ConfigOption(false, "10", "Number of steps to scan the 1st range.");
    m_config["finVal2"] = ConfigOption(
        false, "0.1", "Final value for the 2nd quantity (optional).");
    m_config["numStep2"] = ConfigOption(
        false, "10", "Number of steps to scan the 2nd range (optional).");
}

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

◆ ~ProcessLocalStabilityAnalysis()

Nektar::FieldUtils::ProcessLocalStabilityAnalysis::~ProcessLocalStabilityAnalysis ( )

override

Definition at line 77 of file ProcessLocalStabilityAnalysis.cpp.

78{

79}

Member Function Documentation

◆ call_hello()

void Nektar::FieldUtils::ProcessLocalStabilityAnalysis::call_hello ( )

inline

Definition at line 89 of file ProcessLocalStabilityAnalysis.h.

    {
        F77NAME(helloworld)();
    }

References F77NAME, and Nektar::FieldUtils::helloworld().

◆ call_lst()

void Nektar::FieldUtils::ProcessLocalStabilityAnalysis::call_lst	(	const long int &	option,
		const NekDouble *	finalValue1,
		const long int &	numStep1,
		const NekDouble *	finalValue2,
		const long int &	numStep2
	)

inline

Definition at line 94 of file ProcessLocalStabilityAnalysis.h.

    {
        F77NAME(copse3d)(option, finalValue1, numStep1, finalValue2, numStep2);
    }

References Nektar::FieldUtils::copse3d(), and F77NAME.

Referenced by v_Process().

◆ create()

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

inlinestatic

Creates an instance of this class.

Definition at line 65 of file ProcessLocalStabilityAnalysis.h.

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

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

◆ GenerateInputFiles()

void Nektar::FieldUtils::ProcessLocalStabilityAnalysis::GenerateInputFiles ( )

private

Definition at line 81 of file ProcessLocalStabilityAnalysis.cpp.

{
    // Update settins from the session file
    if (m_f->m_session->DefinesParameter("Pr"))
    {
        m_PRANDTL = m_f->m_session->GetParameter("Pr");
    }
 
    if (m_f->m_session->DefinesParameter("Gamma"))
    {
        m_GAMMA = m_f->m_session->GetParameter("Gamma");
    }
 
    if (m_f->m_session->DefinesParameter("RGAS"))
    {
        m_RGAS = m_f->m_session->GetParameter("RGAS");
    }
 
    if (m_f->m_session->DefinesParameter("ITOLRAY"))
    {
        m_ITOLRAY = m_f->m_session->GetParameter("ITOLRAY");
    }
 
    if (m_f->m_session->DefinesParameter("NGLOBAL"))
    {
        m_NGLOBAL = m_f->m_session->GetParameter("NGLOBAL");
    }
 
    if (m_f->m_session->DefinesParameter("NLOCAL"))
    {
        m_NLOCAL = m_f->m_session->GetParameter("NLOCAL");
    }
 
    if (m_f->m_session->DefinesParameter("BETALIN"))
    {
        m_BETALIN = m_f->m_session->GetParameter("BETALIN");
    }
 
    ASSERTL0(m_f->m_session->DefinesParameter("FREQLIN"),
             "The disturbance frequency for local linear stability analysis "
             "must be defined.");
    m_FREQLIN = m_f->m_session->GetParameter("FREQLIN");
 
    if (m_f->m_session->DefinesParameter("ITSE"))
    {
        m_ITSE = m_f->m_session->GetParameter("ITSE");
    }
 
    if (m_f->m_session->DefinesParameter("INEUTRL"))
    {
        m_INEUTRL = m_f->m_session->GetParameter("INEUTRL");
    }
 
    ofstream ofs;
    ofs.open("PSEREAD.NAM", ios::out);
 
    // Write $PSEUSER tag
    ofs << "$PSEUSER\n"
        << "NSTART=" << m_NSTART << "\n"
        << "ITSE=" << m_ITSE << "\n"
        << "INEUTRL=" << m_INEUTRL << "\n"
        << "BETALIN=" << m_BETALIN << "\n"
        << "FREQLIN=" << m_FREQLIN << "\n"
        << "$END\n"
        << endl;
    // Write $PSEUSER tag
    ofs << "$PSENONL\n$END\n" << endl;
 
    // Weite $PSECNTL tag
    ofs << "$PSECNTL\n"
        << "NGLOBAL=" << m_NGLOBAL << "\n"
        << "NLOCAL=" << m_NLOCAL << "\n"
        << "ITOLRAY=" << m_ITOLRAY << "\n"
        << "$END\n"
        << endl;
 
    // Write $PSEOUT tag
    ofs << "$PSEOUT\n"
        << "LABEL=" << m_LABEL << "\n"
        << "ITSPRES=" << m_ITSPRES << "\n"
        << "IEIGL=" << m_IEIGL << "\n"
        << "$END\n"
        << endl;
 
    // Write $PSEGAS tag
    ofs << "$PSEGAS\n"
        << "RGAS=" << m_RGAS << "\n"
        << "GAMMA=" << m_GAMMA << "\n"
        << "PRANDTL=" << m_PRANDTL << "\n"
        << "$END\n"
        << endl;
 
    ofs.close();
}

References ASSERTL0, m_BETALIN, Nektar::FieldUtils::Module::m_f, m_FREQLIN, m_GAMMA, m_IEIGL, m_INEUTRL, m_ITOLRAY, m_ITSE, m_ITSPRES, m_LABEL, m_NGLOBAL, m_NLOCAL, m_NSTART, m_PRANDTL, and m_RGAS.

Referenced by v_Process().

◆ v_GetModuleDescription()

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

inlineoverridevirtual

Reimplemented from Nektar::FieldUtils::ProcessBoundaryExtract.

Definition at line 83 of file ProcessLocalStabilityAnalysis.h.

    {
        return "Performing local (linear) stability analysis (LST)";
    }

◆ v_GetModuleName()

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

inlineoverridevirtual

Reimplemented from Nektar::FieldUtils::ProcessBoundaryExtract.

Definition at line 78 of file ProcessLocalStabilityAnalysis.h.

    {
        return "ProcessLocalStabilityAnalysis";
    }

◆ v_Process()

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

overridevirtual

Write mesh to output file.

Reimplemented from Nektar::FieldUtils::ProcessBoundaryExtract.

Definition at line 176 of file ProcessLocalStabilityAnalysis.cpp.

{
    ProcessBoundaryExtract::v_Process(vm);
 
    // Initialize sampling parameters
    const long int option       = m_config["opt"].as<long int>(); // 6,7,8
    const NekDouble finalValue1 = m_config["finVal1"].as<NekDouble>();
    const long int numStep1     = m_config["numStep1"].as<long int>();
    const NekDouble finalValue2 = m_config["finVal2"].as<NekDouble>();
    const long int numStep2     = m_config["numStep2"].as<long int>();
 
    // Create PSEREAD.NAMgit d
    GenerateInputFiles();
 
    // call_hello(); // test calling
    call_lst(option, &finalValue1, numStep1, &finalValue2, numStep2);
}

References call_lst(), GenerateInputFiles(), Nektar::FieldUtils::Module::m_config, and Nektar::FieldUtils::ProcessBoundaryExtract::v_Process().

Member Data Documentation

◆ className

ModuleKey Nektar::FieldUtils::ProcessLocalStabilityAnalysis::className

static

Initial value:

=
    GetModuleFactory().RegisterCreatorFunction(
        ModuleKey(eProcessModule, "localStabilityAnalysis"),
        ProcessLocalStabilityAnalysis::create,
        "Perform local (linear) stability analysis (LST).")