Base class for the development of solvers. More...

#include <DriverArnoldi.h>

Inheritance diagram for Nektar::SolverUtils::DriverArnoldi:

Public Member Functions
Array< OneD, NekDouble >	GetRealEvl (void)

Array< OneD, NekDouble >	GetImagEvl (void)

Public Member Functions inherited from Nektar::SolverUtils::Driver
virtual	~Driver ()=default
	Destructor. More...

SOLVER_UTILS_EXPORT void	InitObject (std::ostream &out=std::cout)
	Initialise Object. More...

SOLVER_UTILS_EXPORT void	Execute (std::ostream &out=std::cout)
	Execute driver. More...

SOLVER_UTILS_EXPORT Array< OneD, EquationSystemSharedPtr >	GetEqu ()

Protected Member Functions
	DriverArnoldi (const LibUtilities::SessionReaderSharedPtr pSession, const SpatialDomains::MeshGraphSharedPtr pGraph)
	Constructor. More...

	~DriverArnoldi () override=default
	Destructor. More...

void	v_InitObject (std::ostream &out=std::cout) override
	Virtual function for initialisation implementation. More...

void	v_Execute (std::ostream &out=std::cout) override
	Virtual function for solve implementation. More...

void	CopyArnoldiArrayToField (Array< OneD, NekDouble > &array)
	Copy Arnoldi storage to fields. More...

void	CopyFieldToArnoldiArray (Array< OneD, NekDouble > &array)
	Copy fields to Arnoldi storage. More...

void	CopyFwdToAdj ()
	Copy the forward field to the adjoint system in transient growth calculations. More...

void	WriteFld (std::string file, std::vector< Array< OneD, NekDouble > > coeffs)
	Write coefficients to file. More...

void	WriteFld (std::string file, Array< OneD, NekDouble > coeffs)

void	WriteEvs (std::ostream &evlout, const int k, const NekDouble real, const NekDouble imag, NekDouble resid=NekConstants::kNekUnsetDouble, bool DumpInverse=true)

void	MaskInit ()
	Init mask. More...

void	GetMaskInfo (std::vector< std::vector< LibUtilities::EquationSharedPtr > > &selectedDomains, std::set< int > &unselectedVariables)

SOLVER_UTILS_EXPORT void	ArnoldiSummary (std::ostream &out)

Protected Member Functions inherited from Nektar::SolverUtils::Driver
	Driver (const LibUtilities::SessionReaderSharedPtr pSession, const SpatialDomains::MeshGraphSharedPtr pGraph)
	Initialises EquationSystem class members. More...

virtual SOLVER_UTILS_EXPORT void	v_InitObject (std::ostream &out=std::cout)
	Virtual function for initialisation implementation. More...

virtual SOLVER_UTILS_EXPORT void	v_Execute (std::ostream &out=std::cout)=0
	Virtual function for solve implementation. More...

Protected Attributes
int	m_kdim

int	m_nvec
	Dimension of Krylov subspace. More...

int	m_nits
	Number of vectors to test. More...

NekDouble	m_evtol
	Maxmum number of iterations. More...

NekDouble	m_period
	Tolerance of iterations. More...

bool	m_timeSteppingAlgorithm
	Period of time stepping algorithm. More...

int	m_infosteps
	underlying operator is time stepping More...

int	m_nfields
	interval to dump information if required. More...

NekDouble	m_realShift

NekDouble	m_imagShift

int	m_negatedOp

Array< OneD, NekDouble >	m_real_evl
	Operator in solve call is negated. More...

Array< OneD, NekDouble >	m_imag_evl

bool	m_useMask

Array< OneD, NekDouble >	m_maskCoeffs

Array< OneD, NekDouble >	m_maskPhys

Protected Attributes inherited from Nektar::SolverUtils::Driver
LibUtilities::CommSharedPtr	m_comm
	Communication object. More...

LibUtilities::SessionReaderSharedPtr	m_session
	Session reader object. More...

LibUtilities::SessionReaderSharedPtr	session_LinNS
	Coupling between SFD and arnoldi. More...

SpatialDomains::MeshGraphSharedPtr	m_graph
	MeshGraph object. More...

Array< OneD, EquationSystemSharedPtr >	m_equ
	Equation system to solve. More...

int	m_nequ
	number of equations More...

enum EvolutionOperatorType	m_EvolutionOperator
	Evolution Operator. More...

Friends
class	MemoryManager< DriverArnoldi >

Additional Inherited Members
Static Protected Attributes inherited from Nektar::SolverUtils::Driver
static std::string	evolutionOperatorLookupIds []

static std::string	evolutionOperatorDef

static std::string	driverDefault

Detailed Description

Base class for the development of solvers.

Definition at line 44 of file DriverArnoldi.h.

Constructor & Destructor Documentation

◆ DriverArnoldi()

Nektar::SolverUtils::DriverArnoldi::DriverArnoldi	(	const LibUtilities::SessionReaderSharedPtr	pSession,
		const SpatialDomains::MeshGraphSharedPtr	pGraph
	)

protected

Constructor.

Constructor

Definition at line 46 of file DriverArnoldi.cpp.

    : Driver(pSession, pGraph)
{
    m_session->LoadParameter("IO_InfoSteps", m_infosteps, 1);
}

References m_infosteps, and Nektar::SolverUtils::Driver::m_session.

◆ ~DriverArnoldi()

Nektar::SolverUtils::DriverArnoldi::~DriverArnoldi ( )

overrideprotecteddefault

Destructor.

Member Function Documentation

◆ ArnoldiSummary()

void Nektar::SolverUtils::DriverArnoldi::ArnoldiSummary ( std::ostream & out )

protected

Definition at line 131 of file DriverArnoldi.cpp.

{
    if (m_comm->GetRank() == 0)
    {
        if (m_session->DefinesSolverInfo("ModeType") &&
            boost::iequals(m_session->GetSolverInfo("ModeType"), "SingleMode"))
        {
            out << "\tSingle Fourier mode    : true " << endl;
            ASSERTL0(m_session->DefinesSolverInfo("Homogeneous"),
                     "Expected a homogeneous expansion to be defined "
                     "with single mode");
        }
        else
        {
            out << "\tSingle Fourier mode    : false " << endl;
        }
        if (m_session->DefinesSolverInfo("BetaZero"))
        {
            out << "\tBeta set to Zero       : true (overrides LHom)" << endl;
        }
        else
        {
            out << "\tBeta set to Zero       : false " << endl;
        }
 
        if (m_timeSteppingAlgorithm)
        {
            out << "\tEvolution operator     : "
                << m_session->GetSolverInfo("EvolutionOperator") << endl;
        }
        else
        {
            out << "\tShift (Real,Imag)      : " << m_realShift << ","
                << m_imagShift << endl;
        }
        out << "\tKrylov-space dimension : " << m_kdim << endl;
        out << "\tNumber of vectors      : " << m_nvec << endl;
        out << "\tMax iterations         : " << m_nits << endl;
        out << "\tEigenvalue tolerance   : " << m_evtol << endl;
        out << "======================================================" << endl;
    }
}

References ASSERTL0, Nektar::SolverUtils::Driver::m_comm, m_evtol, m_imagShift, m_kdim, m_nits, m_nvec, m_realShift, Nektar::SolverUtils::Driver::m_session, and m_timeSteppingAlgorithm.

Referenced by Nektar::SolverUtils::DriverArpack::v_InitObject(), and Nektar::SolverUtils::DriverModifiedArnoldi::v_InitObject().

◆ CopyArnoldiArrayToField()

void Nektar::SolverUtils::DriverArnoldi::CopyArnoldiArrayToField ( Array< OneD, NekDouble > & array )

protected

Copy Arnoldi storage to fields.

Copy Arnoldi array to field variables which depend from either the m_fields or m_forces

Definition at line 178 of file DriverArnoldi.cpp.

{
 
    Array<OneD, MultiRegions::ExpListSharedPtr> &fields =
        m_equ[0]->UpdateFields();
    int nq = fields[0]->GetNcoeffs();
 
    for (int k = 0; k < m_nfields; ++k)
    {
        Vmath::Vcopy(nq, &array[k * nq], 1, &fields[k]->UpdateCoeffs()[0], 1);
        fields[k]->SetPhysState(false);
    }
}

References Nektar::SolverUtils::Driver::m_equ, m_nfields, and Vmath::Vcopy().

Referenced by Nektar::SolverUtils::DriverModifiedArnoldi::EV_update(), and Nektar::SolverUtils::DriverArpack::v_Execute().

◆ CopyFieldToArnoldiArray()

void Nektar::SolverUtils::DriverArnoldi::CopyFieldToArnoldiArray ( Array< OneD, NekDouble > & array )

protected

Copy fields to Arnoldi storage.

Copy field variables which depend from either the m_fields or m_forces array the Arnoldi array

Definition at line 196 of file DriverArnoldi.cpp.

{
 
    Array<OneD, MultiRegions::ExpListSharedPtr> fields;
 
    if (m_EvolutionOperator == eAdaptiveSFD)
    {
        // This matters for the Adaptive SFD method because
        // m_equ[1] is the nonlinear problem with non
        // homogeneous BCs.
        fields = m_equ[0]->UpdateFields();
    }
    else
    {
        fields = m_equ[m_nequ - 1]->UpdateFields();
    }
 
    for (int k = 0; k < m_nfields; ++k)
    {
        int nq = fields[0]->GetNcoeffs();
        Vmath::Vcopy(nq, &fields[k]->GetCoeffs()[0], 1, &array[k * nq], 1);
        fields[k]->SetPhysState(false);
    }
}

References Nektar::SolverUtils::eAdaptiveSFD, Nektar::SolverUtils::Driver::m_equ, Nektar::SolverUtils::Driver::m_EvolutionOperator, Nektar::SolverUtils::Driver::m_nequ, m_nfields, and Vmath::Vcopy().

Referenced by Nektar::SolverUtils::DriverModifiedArnoldi::EV_update(), Nektar::SolverUtils::DriverArpack::v_Execute(), and Nektar::SolverUtils::DriverModifiedArnoldi::v_Execute().

◆ CopyFwdToAdj()

void Nektar::SolverUtils::DriverArnoldi::CopyFwdToAdj ( )

protected

Copy the forward field to the adjoint system in transient growth calculations.

Initialisation for the transient growth

Definition at line 224 of file DriverArnoldi.cpp.

{
    Array<OneD, MultiRegions::ExpListSharedPtr> fields;
 
    ASSERTL0(m_timeSteppingAlgorithm,
             "Transient Growth non available for Coupled Solver");
 
    fields = m_equ[0]->UpdateFields();
    int nq = fields[0]->GetNcoeffs();
 
    for (int k = 0; k < m_nfields; ++k)
    {
        Vmath::Vcopy(nq, &fields[k]->GetCoeffs()[0], 1,
                     &m_equ[1]->UpdateFields()[k]->UpdateCoeffs()[0], 1);
    }
}

References ASSERTL0, Nektar::SolverUtils::Driver::m_equ, m_nfields, m_timeSteppingAlgorithm, and Vmath::Vcopy().

Referenced by Nektar::SolverUtils::DriverModifiedArnoldi::EV_update(), and Nektar::SolverUtils::DriverArpack::v_Execute().

◆ GetImagEvl()

Array< OneD, NekDouble > Nektar::SolverUtils::DriverArnoldi::GetImagEvl ( void )

inline

Definition at line 54 of file DriverArnoldi.h.

    {
        return m_imag_evl;
    }

References m_imag_evl.

◆ GetMaskInfo()

void Nektar::SolverUtils::DriverArnoldi::GetMaskInfo	(	std::vector< std::vector< LibUtilities::EquationSharedPtr > > &	selectedDomains,
		std::set< int > &	unselectedVariables
	)

protected

Definition at line 337 of file DriverArnoldi.cpp.

{
    selectedDomains.clear();
    string domain("SelectEVCalcDomain0");
    string condition("C0");
    for (size_t i = 0; i < 10; ++i)
    {
        domain[domain.size() - 1] = '0' + i;
        if (!m_session->DefinesFunction(domain))
        {
            break;
        }
        for (size_t j = 0; j < 10; ++j)
        {
            condition[condition.size() - 1] = '0' + j;
            if (!m_session->DefinesFunction(domain, condition))
            {
                break;
            }
            if (j == 0)
            {
                selectedDomains.push_back(
                    std::vector<LibUtilities::EquationSharedPtr>());
            }
            selectedDomains[selectedDomains.size() - 1].push_back(
                m_session->GetFunction(domain, condition));
        }
    }
    unselectedVariables.clear();
    string funName("SelectEVCalcVariables");
    std::vector<std::string> variables = m_session->GetVariables();
    for (size_t v = 0; v < m_nfields; ++v)
    {
        if (!m_session->DefinesFunction(funName, variables[v]))
        {
            unselectedVariables.insert(v);
        }
    }
    if (unselectedVariables.size() == m_nfields)
    {
        unselectedVariables.clear();
    }
}

References m_nfields, and Nektar::SolverUtils::Driver::m_session.

Referenced by MaskInit().

◆ GetRealEvl()

Array< OneD, NekDouble > Nektar::SolverUtils::DriverArnoldi::GetRealEvl ( void )

inline

Definition at line 49 of file DriverArnoldi.h.

    {
        return m_real_evl;
    }

References m_real_evl.

◆ MaskInit()

void Nektar::SolverUtils::DriverArnoldi::MaskInit ( )

protected

Init mask.

Definition at line 386 of file DriverArnoldi.cpp.

{
    std::vector<std::vector<LibUtilities::EquationSharedPtr>> selectedDomains;
    std::set<int> unselectedVariables;
    GetMaskInfo(selectedDomains, unselectedVariables);
    if (selectedDomains.size() == 0 && unselectedVariables.size() == 0)
    {
        m_useMask = false;
        return;
    }
    m_useMask                            = true;
    MultiRegions::ExpListSharedPtr field = m_equ[0]->UpdateFields()[0];
    int ncoef                            = field->GetNcoeffs();
    int nphys                            = field->GetNpoints();
    m_maskCoeffs = Array<OneD, double>(ncoef * m_nfields, 1.);
    m_maskPhys   = Array<OneD, double>(nphys * m_nfields, 1.);
    for (size_t i = 0; i < field->GetExpSize(); ++i)
    {
        LocalRegions::ExpansionSharedPtr exp   = field->GetExp(i);
        SpatialDomains::GeometrySharedPtr geom = exp->GetGeom();
        int nv                                 = geom->GetNumVerts();
        NekDouble gc[3]                        = {0., 0., 0.};
        NekDouble gct[3]                       = {0., 0., 0.};
        for (size_t j = 0; j < nv; ++j)
        {
            SpatialDomains::PointGeomSharedPtr vertex = geom->GetVertex(j);
            vertex->GetCoords(gct[0], gct[1], gct[2]);
            gc[0] += gct[0] / NekDouble(nv);
            gc[1] += gct[1] / NekDouble(nv);
            gc[2] += gct[2] / NekDouble(nv);
        }
        int unmask = 1;
        for (size_t m = 0; m < selectedDomains.size(); ++m)
        {
            unmask = 0;
            for (size_t n = 0; n < selectedDomains[m].size(); ++n)
            {
                if (selectedDomains[m][n]->Evaluate(gc[0], gc[1], gc[2]) <= 0.)
                {
                    unmask = 0;
                    break;
                }
                else
                {
                    unmask = 1;
                }
            }
            if (unmask == 1)
            {
                break;
            }
        }
        for (int j = 0; j < m_nfields; ++j)
        {
            if (unmask == 0 || unselectedVariables.count(j))
            {
                Vmath::Fill(
                    exp->GetNcoeffs(), 0.,
                    &m_maskCoeffs[field->GetCoeff_Offset(i) + j * ncoef], 1);
                Vmath::Fill(exp->GetTotPoints(), 0.,
                            &m_maskPhys[field->GetPhys_Offset(i) + j * nphys],
                            1);
            }
        }
    }
}

References FilterPython_Function::field, Vmath::Fill(), GetMaskInfo(), Nektar::SolverUtils::Driver::m_equ, m_maskCoeffs, m_maskPhys, m_nfields, and m_useMask.

Referenced by v_InitObject().

◆ v_Execute()

void Nektar::SolverUtils::DriverArnoldi::v_Execute ( std::ostream & out = std::cout )

overrideprotectedvirtual

Virtual function for solve implementation.

Implements Nektar::SolverUtils::Driver.

Reimplemented in Nektar::SolverUtils::DriverArpack, Nektar::SolverUtils::DriverModifiedArnoldi, and Nektar::SolverUtils::DriverSteadyState.

Definition at line 123 of file DriverArnoldi.cpp.

{
    ASSERTL0(false, "Specific version of Arnoldi driver not implemented");
}

References ASSERTL0.

◆ v_InitObject()

void Nektar::SolverUtils::DriverArnoldi::v_InitObject ( std::ostream & out = std::cout )

overrideprotectedvirtual

Virtual function for initialisation implementation.

Arnoldi driver initialisation

Reimplemented from Nektar::SolverUtils::Driver.

Reimplemented in Nektar::SolverUtils::DriverArpack, Nektar::SolverUtils::DriverModifiedArnoldi, and Nektar::SolverUtils::DriverSteadyState.

Definition at line 57 of file DriverArnoldi.cpp.

{
    Driver::v_InitObject(out);
    m_session->MatchSolverInfo("SolverType", "VelocityCorrectionScheme",
                               m_timeSteppingAlgorithm, false);
 
    if (m_timeSteppingAlgorithm)
    {
        m_period = m_session->GetParameter("TimeStep") *
                   m_session->GetParameter("NumSteps");
        m_nfields = m_equ[0]->UpdateFields().size() - 1;
    }
    else
    {
        m_period  = 1.0;
        m_nfields = m_equ[0]->UpdateFields().size();
    }
 
    if (m_session->DefinesSolverInfo("ModeType") &&
        (boost::iequals(m_session->GetSolverInfo("ModeType"), "SingleMode") ||
         boost::iequals(m_session->GetSolverInfo("ModeType"), "HalfMode")))
    {
        for (int i = 0; i < m_nfields; ++i)
        {
            m_equ[0]->UpdateFields()[i]->SetWaveSpace(true);
        }
    }
    m_negatedOp = m_equ[0]->NegatedOp();
 
    m_session->LoadParameter("kdim", m_kdim, 16);
    m_session->LoadParameter("nvec", m_nvec, 2);
    m_session->LoadParameter("nits", m_nits, 500);
    m_session->LoadParameter("evtol", m_evtol, 1e-06);
 
    ASSERTL0(m_kdim >= m_nvec, "nvec cannot be larger than kdim.");
 
    m_session->LoadParameter("realShift", m_realShift, 0.0);
    m_equ[0]->SetLambda(m_realShift);
 
    m_session->LoadParameter("imagShift", m_imagShift, 0.0);
 
    // The imaginary shift is applied at system assembly
    // Only if using HOMOGENEOUS expansion and ModeType set to SingleMode
    if (m_imagShift != 0.0)
    {
        if (!m_session->DefinesSolverInfo("HOMOGENEOUS") &&
            !m_session->DefinesSolverInfo("ModeType"))
        {
            NEKERROR(ErrorUtil::efatal,
                     "Imaginary shift only supported with HOMOGENEOUS "
                     "expansion and ModeType set to SingleMode");
        }
        else if (!boost::iequals(m_session->GetSolverInfo("ModeType"),
                                 "SingleMode"))
        {
            NEKERROR(ErrorUtil::efatal,
                     "Imaginary shift only supported with HOMOGENEOUS "
                     "expansion and ModeType set to SingleMode");
        }
    }
    MaskInit();
}

References ASSERTL0, Nektar::ErrorUtil::efatal, Nektar::SolverUtils::Driver::m_equ, m_evtol, m_imagShift, m_kdim, m_negatedOp, m_nfields, m_nits, m_nvec, m_period, m_realShift, Nektar::SolverUtils::Driver::m_session, m_timeSteppingAlgorithm, MaskInit(), NEKERROR, and Nektar::SolverUtils::Driver::v_InitObject().

Referenced by Nektar::SolverUtils::DriverArpack::v_InitObject(), and Nektar::SolverUtils::DriverModifiedArnoldi::v_InitObject().

◆ WriteEvs()

void Nektar::SolverUtils::DriverArnoldi::WriteEvs	(	std::ostream &	evlout,
		const int	k,
		const NekDouble	real,
		const NekDouble	imag,
		NekDouble	resid = `NekConstants::kNekUnsetDouble`,
		bool	DumpInverse = `true`
	)

protected

Definition at line 285 of file DriverArnoldi.cpp.

{
    if (m_timeSteppingAlgorithm)
    {
        NekDouble abs_ev = hypot(re_ev, im_ev);
        NekDouble ang_ev = atan2(im_ev, re_ev);
 
        evlout << "EV: " << setw(2) << i << setw(12) << abs_ev << setw(12)
               << ang_ev << setw(12) << log(abs_ev) / m_period << setw(12)
               << ang_ev / m_period;
 
        if (resid != NekConstants::kNekUnsetDouble)
        {
            evlout << setw(12) << resid;
        }
        evlout << endl;
    }
    else
    {
        NekDouble invmag = 1.0 / (re_ev * re_ev + im_ev * im_ev);
        NekDouble sign;
        if (m_negatedOp)
        {
            sign = -1.0;
        }
        else
        {
            sign = 1.0;
        }
 
        evlout << "EV: " << setw(2) << i << setw(14) << sign * re_ev << setw(14)
               << sign * im_ev;
 
        if (DumpInverse)
        {
            evlout << setw(14) << sign * re_ev * invmag + m_realShift
                   << setw(14) << sign * im_ev * invmag + m_imagShift;
        }
 
        if (resid != NekConstants::kNekUnsetDouble)
        {
            evlout << setw(12) << resid;
        }
        evlout << endl;
    }
}

References Nektar::NekConstants::kNekUnsetDouble, tinysimd::log(), m_imagShift, m_negatedOp, m_period, m_realShift, m_timeSteppingAlgorithm, and sign.

Referenced by Nektar::SolverUtils::DriverModifiedArnoldi::EV_post(), Nektar::SolverUtils::DriverModifiedArnoldi::EV_test(), and Nektar::SolverUtils::DriverArpack::v_Execute().

◆ WriteFld() [1/2]

void Nektar::SolverUtils::DriverArnoldi::WriteFld	(	std::string	file,
		Array< OneD, NekDouble >	coeffs
	)

protected

Definition at line 262 of file DriverArnoldi.cpp.

{
 
    std::vector<std::string> variables(m_nfields);
    std::vector<Array<OneD, NekDouble>> fieldcoeffs(m_nfields);
 
    int ncoeffs = m_equ[0]->UpdateFields()[0]->GetNcoeffs();
    ASSERTL1(coeffs.size() >= ncoeffs * m_nfields,
             "coeffs is not of sufficient size");
 
    for (int i = 0; i < m_nfields; ++i)
    {
        variables[i]   = m_equ[0]->GetVariable(i);
        fieldcoeffs[i] = coeffs + i * ncoeffs;
    }
 
    m_equ[0]->WriteFld(file, m_equ[0]->UpdateFields()[0], fieldcoeffs,
                       variables);
}

References ASSERTL1, Nektar::SolverUtils::Driver::m_equ, and m_nfields.

◆ WriteFld() [2/2]

void Nektar::SolverUtils::DriverArnoldi::WriteFld	(	std::string	file,
		std::vector< Array< OneD, NekDouble > >	coeffs
	)

protected

Write coefficients to file.

Definition at line 244 of file DriverArnoldi.cpp.

{
 
    std::vector<std::string> variables(m_nfields);
 
    ASSERTL1(coeffs.size() >= m_nfields, "coeffs is not of the correct length");
    for (int i = 0; i < m_nfields; ++i)
    {
        variables[i] = m_equ[0]->GetVariable(i);
    }
 
    m_equ[0]->WriteFld(file, m_equ[0]->UpdateFields()[0], coeffs, variables);
}

References ASSERTL1, Nektar::SolverUtils::Driver::m_equ, and m_nfields.

Referenced by Nektar::SolverUtils::DriverModifiedArnoldi::EV_post(), and Nektar::SolverUtils::DriverArpack::v_Execute().

Friends And Related Function Documentation

◆ MemoryManager< DriverArnoldi >

friend class MemoryManager< DriverArnoldi >

friend

Definition at line 1 of file DriverArnoldi.h.

Member Data Documentation

◆ m_evtol

NekDouble Nektar::SolverUtils::DriverArnoldi::m_evtol

protected

Maxmum number of iterations.

Definition at line 63 of file DriverArnoldi.h.

Referenced by ArnoldiSummary(), Nektar::SolverUtils::DriverModifiedArnoldi::EV_test(), Nektar::SolverUtils::DriverArpack::v_Execute(), and v_InitObject().

◆ m_imag_evl

Array<OneD, NekDouble> Nektar::SolverUtils::DriverArnoldi::m_imag_evl

protected

Definition at line 75 of file DriverArnoldi.h.

Referenced by GetImagEvl(), Nektar::SolverUtils::DriverArpack::v_Execute(), and Nektar::SolverUtils::DriverModifiedArnoldi::v_Execute().

◆ m_imagShift

NekDouble Nektar::SolverUtils::DriverArnoldi::m_imagShift

protected

Definition at line 71 of file DriverArnoldi.h.

Referenced by ArnoldiSummary(), Nektar::SolverUtils::DriverArpack::v_Execute(), Nektar::SolverUtils::DriverModifiedArnoldi::v_Execute(), v_InitObject(), and WriteEvs().

◆ m_infosteps

int Nektar::SolverUtils::DriverArnoldi::m_infosteps

protected

underlying operator is time stepping

Definition at line 67 of file DriverArnoldi.h.

Referenced by DriverArnoldi(), and Nektar::SolverUtils::DriverArpack::v_Execute().

◆ m_kdim

int Nektar::SolverUtils::DriverArnoldi::m_kdim

protected

Definition at line 60 of file DriverArnoldi.h.

Referenced by ArnoldiSummary(), Nektar::SolverUtils::DriverSteadyState::ComputeOptimization(), Nektar::SolverUtils::DriverArpack::v_Execute(), Nektar::SolverUtils::DriverModifiedArnoldi::v_Execute(), v_InitObject(), and Nektar::SolverUtils::DriverArpack::v_InitObject().

◆ m_maskCoeffs

Array<OneD, NekDouble> Nektar::SolverUtils::DriverArnoldi::m_maskCoeffs

protected

Definition at line 78 of file DriverArnoldi.h.

Referenced by MaskInit(), and Nektar::SolverUtils::DriverModifiedArnoldi::v_Execute().

◆ m_maskPhys

Array<OneD, NekDouble> Nektar::SolverUtils::DriverArnoldi::m_maskPhys

protected

Definition at line 79 of file DriverArnoldi.h.

Referenced by MaskInit().

◆ m_negatedOp

int Nektar::SolverUtils::DriverArnoldi::m_negatedOp

protected

Definition at line 72 of file DriverArnoldi.h.

Referenced by Nektar::SolverUtils::DriverArpack::v_Execute(), v_InitObject(), and WriteEvs().

◆ m_nfields

int Nektar::SolverUtils::DriverArnoldi::m_nfields

protected

interval to dump information if required.

Definition at line 69 of file DriverArnoldi.h.

Referenced by CopyArnoldiArrayToField(), CopyFieldToArnoldiArray(), CopyFwdToAdj(), GetMaskInfo(), MaskInit(), Nektar::SolverUtils::DriverArpack::v_Execute(), Nektar::SolverUtils::DriverModifiedArnoldi::v_Execute(), v_InitObject(), and WriteFld().

◆ m_nits

int Nektar::SolverUtils::DriverArnoldi::m_nits

protected

Number of vectors to test.

Definition at line 62 of file DriverArnoldi.h.

Referenced by ArnoldiSummary(), Nektar::SolverUtils::DriverArpack::v_Execute(), Nektar::SolverUtils::DriverModifiedArnoldi::v_Execute(), and v_InitObject().

◆ m_nvec

int Nektar::SolverUtils::DriverArnoldi::m_nvec

protected

Dimension of Krylov subspace.

Definition at line 61 of file DriverArnoldi.h.

Referenced by ArnoldiSummary(), Nektar::SolverUtils::DriverArpack::v_Execute(), Nektar::SolverUtils::DriverModifiedArnoldi::v_Execute(), v_InitObject(), and Nektar::SolverUtils::DriverArpack::v_InitObject().

◆ m_period

NekDouble Nektar::SolverUtils::DriverArnoldi::m_period

protected

Tolerance of iterations.

Definition at line 64 of file DriverArnoldi.h.

Referenced by v_InitObject(), and WriteEvs().

◆ m_real_evl

Array<OneD, NekDouble> Nektar::SolverUtils::DriverArnoldi::m_real_evl

protected

Operator in solve call is negated.

Definition at line 74 of file DriverArnoldi.h.

Referenced by GetRealEvl(), Nektar::SolverUtils::DriverArpack::v_Execute(), and Nektar::SolverUtils::DriverModifiedArnoldi::v_Execute().

◆ m_realShift

NekDouble Nektar::SolverUtils::DriverArnoldi::m_realShift

protected

Definition at line 70 of file DriverArnoldi.h.

Referenced by ArnoldiSummary(), Nektar::SolverUtils::DriverArpack::v_Execute(), v_InitObject(), and WriteEvs().

◆ m_timeSteppingAlgorithm

bool Nektar::SolverUtils::DriverArnoldi::m_timeSteppingAlgorithm

protected

Period of time stepping algorithm.

Definition at line 65 of file DriverArnoldi.h.

Referenced by ArnoldiSummary(), CopyFwdToAdj(), Nektar::SolverUtils::DriverModifiedArnoldi::EV_test(), Nektar::SolverUtils::DriverArpack::v_Execute(), v_InitObject(), and WriteEvs().

◆ m_useMask

bool Nektar::SolverUtils::DriverArnoldi::m_useMask

protected

Definition at line 77 of file DriverArnoldi.h.

Referenced by Nektar::SolverUtils::DriverModifiedArnoldi::EV_big(), Nektar::SolverUtils::DriverModifiedArnoldi::EV_post(), Nektar::SolverUtils::DriverModifiedArnoldi::EV_small(), MaskInit(), and Nektar::SolverUtils::DriverModifiedArnoldi::v_Execute().

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DriverArnoldi()

◆ ~DriverArnoldi()

Member Function Documentation

◆ ArnoldiSummary()

◆ CopyArnoldiArrayToField()

◆ CopyFieldToArnoldiArray()

◆ CopyFwdToAdj()

◆ GetImagEvl()

◆ GetMaskInfo()

◆ GetRealEvl()

◆ MaskInit()

◆ v_Execute()

◆ v_InitObject()

◆ WriteEvs()

◆ WriteFld() [1/2]

◆ WriteFld() [2/2]

Friends And Related Function Documentation

◆ MemoryManager< DriverArnoldi >

Member Data Documentation

◆ m_evtol

◆ m_imag_evl

◆ m_imagShift

◆ m_infosteps

◆ m_kdim

◆ m_maskCoeffs

◆ m_maskPhys

◆ m_negatedOp

◆ m_nfields

◆ m_nits

◆ m_nvec

◆ m_period

◆ m_real_evl

◆ m_realShift

◆ m_timeSteppingAlgorithm

◆ m_useMask