#include <NekNonlinSysIter.h>

Inheritance diagram for Nektar::LibUtilities::NekNonlinSysIter:

Public Member Functions
	NekNonlinSysIter (const LibUtilities::SessionReaderSharedPtr &pSession, const LibUtilities::CommSharedPtr &vRowComm, const int nDimen, const NekSysKey &pKey)

	~NekNonlinSysIter () override=default

const Array< OneD, const NekDouble > &	GetRefSolution () const

const Array< OneD, const NekDouble > &	GetRefResidual () const

const Array< OneD, const NekDouble > &	GetRefSourceVec () const

const NekLinSysIterSharedPtr &	GetLinSys () const

int	GetNtotLinSysIts () const

void	SetNekLinSysTolerance (const NekDouble in)

void	SetNekNonlinSysTolerance (const NekDouble in)

void	SetNonlinIterTolRelativeL2 (const NekDouble in)

void	SetNekNonlinSysMaxIterations (const int in)

Public Member Functions inherited from Nektar::LibUtilities::NekSys
	NekSys (const LibUtilities::SessionReaderSharedPtr &pSession, const LibUtilities::CommSharedPtr &vRowComm, const int nDimen, const NekSysKey &pKey)

virtual	~NekSys ()=default

void	InitObject ()

int	SolveSystem (const int nGlobal, const Array< OneD, const NekDouble > &pInput, Array< OneD, NekDouble > &pOutput, const int nDir=0)

const NekSysOperators &	GetSysOperators ()

void	SetSysOperators (const NekSysOperators &in)

void	SetFlagWarnings (bool in)

void	SetRhsMagnitude (const NekDouble mag)

Protected Member Functions
void	v_InitObject () override

void	v_SetSysOperators (const NekSysOperators &in) override

void	ConvergenceCheck (const int nIteration, const Array< OneD, const NekDouble > &Residual)

Protected Member Functions inherited from Nektar::LibUtilities::NekSys
virtual void	v_InitObject ()

virtual void	v_SetSysOperators (const NekSysOperators &in)

virtual int	v_SolveSystem (const int nGlobal, const Array< OneD, const NekDouble > &pInput, Array< OneD, NekDouble > &pOutput, const int nDir)

Protected Attributes
NekDouble	m_SysResNorm0

NekDouble	m_SysResNorm

NekLinSysIterSharedPtr	m_linsol

NekDouble	m_NekLinSysTolerance

NekDouble	m_NekNonLinSysTolerance

NekDouble	m_NonlinIterTolRelativeL2

int	m_NekNonlinSysMaxIterations

int	m_totalIterations = 0

int	m_NtotLinSysIts = 0

std::string	m_LinSysIterSolverType

Array< OneD, NekDouble >	m_Solution

Array< OneD, NekDouble >	m_Residual

Array< OneD, NekDouble >	m_DeltSltn

Array< OneD, NekDouble >	m_SourceVec

Protected Attributes inherited from Nektar::LibUtilities::NekSys
LibUtilities::CommSharedPtr	m_rowComm

bool	m_converged

bool	m_root

bool	m_verbose

bool	m_FlagWarnings

int	m_SysDimen

NekSysOperators	m_operator

NekDouble	m_rhs_magnitude = NekConstants::kNekUnsetDouble

Additional Inherited Members
Static Public Member Functions inherited from Nektar::LibUtilities::NekSys
static NekSysSharedPtr	CreateInstance (const LibUtilities::SessionReaderSharedPtr &pSession, const LibUtilities::CommSharedPtr &vRowComm, const int nDimen, const NekSysKey &pKey)

Detailed Description

Solves a nonlinear system using iterative methods.

Definition at line 54 of file NekNonlinSysIter.h.

Constructor & Destructor Documentation

◆ NekNonlinSysIter()

Nektar::LibUtilities::NekNonlinSysIter::NekNonlinSysIter	(	const LibUtilities::SessionReaderSharedPtr &	pSession,
		const LibUtilities::CommSharedPtr &	vRowComm,
		const int	nDimen,
		const NekSysKey &	pKey
	)

Definition at line 51 of file NekNonlinSysIter.cpp.

    : NekSys(pSession, vRowComm, nDimen, pKey)
{
    m_NekLinSysTolerance        = pKey.m_NekLinSysTolerance;
    m_NekNonLinSysTolerance     = pKey.m_NekNonLinSysTolerance;
    m_NonlinIterTolRelativeL2   = pKey.m_NonlinIterTolRelativeL2;
    m_NekNonlinSysMaxIterations = pKey.m_NekNonlinSysMaxIterations;
    m_LinSysIterSolverType      = pKey.m_LinSysIterSolverTypeInNonlin;
 
    ASSERTL0(LibUtilities::GetNekLinSysIterFactory().ModuleExists(
                 m_LinSysIterSolverType),
             "NekLinSysIter '" + m_LinSysIterSolverType +
                 "' is not defined.\n");
 
    m_linsol = LibUtilities::GetNekLinSysIterFactory().CreateInstance(
        m_LinSysIterSolverType, pSession, m_rowComm, m_SysDimen, pKey);
    m_linsol->SetFlagWarnings(false);
}

References ASSERTL0, Nektar::LibUtilities::NekFactory< tKey, tBase, tParam >::CreateInstance(), Nektar::LibUtilities::GetNekLinSysIterFactory(), m_linsol, m_LinSysIterSolverType, Nektar::LibUtilities::NekSysKey::m_LinSysIterSolverTypeInNonlin, m_NekLinSysTolerance, Nektar::LibUtilities::NekSysKey::m_NekLinSysTolerance, m_NekNonlinSysMaxIterations, Nektar::LibUtilities::NekSysKey::m_NekNonlinSysMaxIterations, m_NekNonLinSysTolerance, Nektar::LibUtilities::NekSysKey::m_NekNonLinSysTolerance, m_NonlinIterTolRelativeL2, Nektar::LibUtilities::NekSysKey::m_NonlinIterTolRelativeL2, Nektar::LibUtilities::NekSys::m_rowComm, and Nektar::LibUtilities::NekSys::m_SysDimen.

◆ ~NekNonlinSysIter()

Nektar::LibUtilities::NekNonlinSysIter::~NekNonlinSysIter ( )

overridedefault

Member Function Documentation

◆ ConvergenceCheck()

void Nektar::LibUtilities::NekNonlinSysIter::ConvergenceCheck	(	const int	nIteration,
		const Array< OneD, const NekDouble > &	Residual
	)

protected

Definition at line 86 of file NekNonlinSysIter.cpp.

{
    m_SysResNorm = Vmath::Dot(Residual.size(), Residual, Residual);
    m_rowComm->AllReduce(m_SysResNorm, Nektar::LibUtilities::ReduceSum);
 
    if (nIteration == 0)
    {
        m_SysResNorm0 = m_SysResNorm;
    }
 
    NekDouble resratio = m_SysResNorm / m_SysResNorm0;
    NekDouble tol      = m_NekNonLinSysTolerance;
    NekDouble restol   = m_NonlinIterTolRelativeL2;
 
    if (m_rhs_magnitude == NekConstants::kNekUnsetDouble)
    {
        m_rhs_magnitude = 1.0;
    }
 
    m_converged = resratio < restol * restol ||
                  m_SysResNorm < tol * tol * m_rhs_magnitude;
}

References Vmath::Dot(), Nektar::NekConstants::kNekUnsetDouble, Nektar::LibUtilities::NekSys::m_converged, m_NekNonLinSysTolerance, m_NonlinIterTolRelativeL2, Nektar::LibUtilities::NekSys::m_rhs_magnitude, Nektar::LibUtilities::NekSys::m_rowComm, m_SysResNorm, m_SysResNorm0, and Nektar::LibUtilities::ReduceSum.

Referenced by Nektar::LibUtilities::NekNonlinSysIterNewton::v_SolveSystem().

◆ GetLinSys()

const NekLinSysIterSharedPtr & Nektar::LibUtilities::NekNonlinSysIter::GetLinSys ( ) const

inline

Definition at line 81 of file NekNonlinSysIter.h.

    {
        return m_linsol;
    }

References m_linsol.

◆ GetNtotLinSysIts()

int Nektar::LibUtilities::NekNonlinSysIter::GetNtotLinSysIts ( ) const

inline

Definition at line 86 of file NekNonlinSysIter.h.

    {
        return m_NtotLinSysIts;
    }

References m_NtotLinSysIts.

◆ GetRefResidual()

const Array< OneD, const NekDouble > & Nektar::LibUtilities::NekNonlinSysIter::GetRefResidual ( ) const

inline

Definition at line 69 of file NekNonlinSysIter.h.

    {
        return m_Residual;
    }

References m_Residual.

◆ GetRefSolution()

const Array< OneD, const NekDouble > & Nektar::LibUtilities::NekNonlinSysIter::GetRefSolution ( ) const

inline

Definition at line 63 of file NekNonlinSysIter.h.

    {
        return m_Solution;
    }

References m_Solution.

◆ GetRefSourceVec()

const Array< OneD, const NekDouble > & Nektar::LibUtilities::NekNonlinSysIter::GetRefSourceVec ( ) const

inline

Definition at line 75 of file NekNonlinSysIter.h.

    {
        return m_SourceVec;
    }

References m_SourceVec.

◆ SetNekLinSysTolerance()

void Nektar::LibUtilities::NekNonlinSysIter::SetNekLinSysTolerance ( const NekDouble in )

inline

Definition at line 91 of file NekNonlinSysIter.h.

    {
        m_NekLinSysTolerance = in;
    }

References m_NekLinSysTolerance.

◆ SetNekNonlinSysMaxIterations()

void Nektar::LibUtilities::NekNonlinSysIter::SetNekNonlinSysMaxIterations ( const int in )

inline

Definition at line 106 of file NekNonlinSysIter.h.

    {
        m_NekNonlinSysMaxIterations = in;
    }

References m_NekNonlinSysMaxIterations.

◆ SetNekNonlinSysTolerance()

void Nektar::LibUtilities::NekNonlinSysIter::SetNekNonlinSysTolerance ( const NekDouble in )

inline

Definition at line 96 of file NekNonlinSysIter.h.

    {
        m_NekNonLinSysTolerance = in;
    }

References m_NekNonLinSysTolerance.

◆ SetNonlinIterTolRelativeL2()

void Nektar::LibUtilities::NekNonlinSysIter::SetNonlinIterTolRelativeL2 ( const NekDouble in )

inline

Definition at line 101 of file NekNonlinSysIter.h.

    {
        m_NonlinIterTolRelativeL2 = in;
    }

References m_NonlinIterTolRelativeL2.

◆ v_InitObject()

void Nektar::LibUtilities::NekNonlinSysIter::v_InitObject ( )

overrideprotectedvirtual

Reimplemented from Nektar::LibUtilities::NekSys.

Reimplemented in Nektar::LibUtilities::NekNonlinSysIterNewton.

Definition at line 73 of file NekNonlinSysIter.cpp.

{
    NekSys::v_InitObject();
    m_Residual = Array<OneD, NekDouble>(m_SysDimen, 0.0);
    m_DeltSltn = Array<OneD, NekDouble>(m_SysDimen, 0.0);
}

References m_DeltSltn, m_Residual, Nektar::LibUtilities::NekSys::m_SysDimen, and Nektar::LibUtilities::NekSys::v_InitObject().

Referenced by Nektar::LibUtilities::NekNonlinSysIterNewton::v_InitObject().

◆ v_SetSysOperators()

void Nektar::LibUtilities::NekNonlinSysIter::v_SetSysOperators ( const NekSysOperators & in )

overrideprotectedvirtual

Reimplemented from Nektar::LibUtilities::NekSys.

Definition at line 80 of file NekNonlinSysIter.cpp.

{
    NekSys::v_SetSysOperators(in);
    m_linsol->SetSysOperators(in);
}

References m_linsol, and Nektar::LibUtilities::NekSys::v_SetSysOperators().

Member Data Documentation

◆ m_DeltSltn

Array<OneD, NekDouble> Nektar::LibUtilities::NekNonlinSysIter::m_DeltSltn

protected

Definition at line 129 of file NekNonlinSysIter.h.

Referenced by v_InitObject(), and Nektar::LibUtilities::NekNonlinSysIterNewton::v_SolveSystem().

◆ m_linsol

NekLinSysIterSharedPtr Nektar::LibUtilities::NekNonlinSysIter::m_linsol

protected

Definition at line 115 of file NekNonlinSysIter.h.

Referenced by GetLinSys(), NekNonlinSysIter(), v_SetSysOperators(), and Nektar::LibUtilities::NekNonlinSysIterNewton::v_SolveSystem().

◆ m_LinSysIterSolverType

std::string Nektar::LibUtilities::NekNonlinSysIter::m_LinSysIterSolverType

protected

Definition at line 125 of file NekNonlinSysIter.h.

Referenced by NekNonlinSysIter().

◆ m_NekLinSysTolerance

NekDouble Nektar::LibUtilities::NekNonlinSysIter::m_NekLinSysTolerance

protected

Definition at line 117 of file NekNonlinSysIter.h.

Referenced by Nektar::LibUtilities::NekNonlinSysIterNewton::CalcInexactNewtonForcing(), NekNonlinSysIter(), and SetNekLinSysTolerance().

◆ m_NekNonlinSysMaxIterations

int Nektar::LibUtilities::NekNonlinSysIter::m_NekNonlinSysMaxIterations

protected

Definition at line 121 of file NekNonlinSysIter.h.

Referenced by NekNonlinSysIter(), SetNekNonlinSysMaxIterations(), and Nektar::LibUtilities::NekNonlinSysIterNewton::v_SolveSystem().

◆ m_NekNonLinSysTolerance

NekDouble Nektar::LibUtilities::NekNonlinSysIter::m_NekNonLinSysTolerance

protected

Definition at line 118 of file NekNonlinSysIter.h.

Referenced by ConvergenceCheck(), NekNonlinSysIter(), and SetNekNonlinSysTolerance().

◆ m_NonlinIterTolRelativeL2

NekDouble Nektar::LibUtilities::NekNonlinSysIter::m_NonlinIterTolRelativeL2

protected

Definition at line 119 of file NekNonlinSysIter.h.

Referenced by ConvergenceCheck(), NekNonlinSysIter(), and SetNonlinIterTolRelativeL2().

◆ m_NtotLinSysIts

int Nektar::LibUtilities::NekNonlinSysIter::m_NtotLinSysIts = 0

protected

Definition at line 123 of file NekNonlinSysIter.h.

Referenced by GetNtotLinSysIts(), and Nektar::LibUtilities::NekNonlinSysIterNewton::v_SolveSystem().

◆ m_Residual

Array<OneD, NekDouble> Nektar::LibUtilities::NekNonlinSysIter::m_Residual

protected

Definition at line 128 of file NekNonlinSysIter.h.

Referenced by GetRefResidual(), v_InitObject(), and Nektar::LibUtilities::NekNonlinSysIterNewton::v_SolveSystem().

◆ m_Solution

Array<OneD, NekDouble> Nektar::LibUtilities::NekNonlinSysIter::m_Solution

protected

Definition at line 127 of file NekNonlinSysIter.h.

Referenced by GetRefSolution(), and Nektar::LibUtilities::NekNonlinSysIterNewton::v_SolveSystem().

◆ m_SourceVec

Array<OneD, NekDouble> Nektar::LibUtilities::NekNonlinSysIter::m_SourceVec

protected

Definition at line 130 of file NekNonlinSysIter.h.

Referenced by GetRefSourceVec(), and Nektar::LibUtilities::NekNonlinSysIterNewton::v_SolveSystem().

◆ m_SysResNorm

NekDouble Nektar::LibUtilities::NekNonlinSysIter::m_SysResNorm

protected

Definition at line 113 of file NekNonlinSysIter.h.

Referenced by ConvergenceCheck(), and Nektar::LibUtilities::NekNonlinSysIterNewton::v_SolveSystem().

◆ m_SysResNorm0

NekDouble Nektar::LibUtilities::NekNonlinSysIter::m_SysResNorm0

protected

Definition at line 112 of file NekNonlinSysIter.h.

Referenced by ConvergenceCheck(), and Nektar::LibUtilities::NekNonlinSysIterNewton::v_SolveSystem().

◆ m_totalIterations

int Nektar::LibUtilities::NekNonlinSysIter::m_totalIterations = 0

protected

Definition at line 122 of file NekNonlinSysIter.h.

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ NekNonlinSysIter()

◆ ~NekNonlinSysIter()

Member Function Documentation

◆ ConvergenceCheck()

◆ GetLinSys()

◆ GetNtotLinSysIts()

◆ GetRefResidual()

◆ GetRefSolution()

◆ GetRefSourceVec()

◆ SetNekLinSysTolerance()

◆ SetNekNonlinSysMaxIterations()

◆ SetNekNonlinSysTolerance()

◆ SetNonlinIterTolRelativeL2()

◆ v_InitObject()

◆ v_SetSysOperators()

Member Data Documentation

◆ m_DeltSltn

◆ m_linsol

◆ m_LinSysIterSolverType

◆ m_NekLinSysTolerance

◆ m_NekNonlinSysMaxIterations

◆ m_NekNonLinSysTolerance

◆ m_NonlinIterTolRelativeL2

◆ m_NtotLinSysIts

◆ m_Residual

◆ m_Solution

◆ m_SourceVec

◆ m_SysResNorm

◆ m_SysResNorm0

◆ m_totalIterations