#include <NekNonlinSys.h>

Inheritance diagram for Nektar::LibUtilities::NekNonlinSys:

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

	~NekNonlinSys () 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 ()

int	GetNtotLinSysIts ()

void	SetNekNonlinSysTolerance (const NekDouble in)

void	SetNekNonlinSysMaxIterations (const unsigned int in)

void	SetNonlinIterTolRelativeL2 (const NekDouble in)

void	SetLinSysRelativeTolInNonlin (const NekDouble 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 ()

void	SetSysOperators (const NekSysOperators &in)

const NekSysOperators &	GetSysOperators ()

int	SolveSystem (const int nGlobal, const Array< OneD, const NekDouble > &pInput, Array< OneD, NekDouble > &pOutput, const int nDir, const NekDouble tol=1.0E-7, const NekDouble factor=1.0)

bool	ConvergenceCheck (const int nIteration, const Array< OneD, const NekDouble > &Residual, const NekDouble tol=1.0E-7)

void	SetFlagWarnings (bool in)

Protected Member Functions
void	v_InitObject () override

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, const NekDouble tol, const NekDouble factor)

virtual bool	v_ConvergenceCheck (const int nIteration, const Array< OneD, const NekDouble > &Residual, const NekDouble tol)

virtual void	v_NekSysInitialGuess (const Array< OneD, const NekDouble > &pInput, Array< OneD, NekDouble > &pguess)

Protected Attributes
NekLinSysIterSharedPtr	m_linsol

NekDouble	m_NonlinIterTolRelativeL2

NekDouble	m_LinSysRelativeTolInNonlin

std::string	m_LinSysIterSolverType

int	m_totalIterations = 0

int	m_NtotLinSysIts = 0

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
int	m_maxiter
	Maximum iterations. More...

NekDouble	m_tolerance
	Tolerance of iterative solver. More...

LibUtilities::CommSharedPtr	m_rowComm
	Communicate. More...

bool	m_converged
	Whether the iteration has been converged. More...

bool	m_root
	Root if parallel. More...

bool	m_verbose
	Verbose. More...

bool	m_FlagWarnings

NekSysOperators	m_operator
	Operators. More...

int	m_SysDimen
	The dimension of the system. More...

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 NekNonlinSys.h.

Constructor & Destructor Documentation

◆ NekNonlinSys()

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

Definition at line 53 of file NekNonlinSys.cpp.

    : NekSys(pSession, vRowComm, nDimen, pKey)
{
    m_maxiter                   = pKey.m_NekNonlinSysMaxIterations;
    m_NonlinIterTolRelativeL2   = pKey.m_NonlinIterTolRelativeL2;
    m_LinSysRelativeTolInNonlin = pKey.m_LinSysRelativeTolInNonlin;
    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);
}

◆ ~NekNonlinSys()

Nektar::LibUtilities::NekNonlinSys::~NekNonlinSys ( )

overridedefault

Member Function Documentation

◆ GetLinSys()

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

inline

Definition at line 81 of file NekNonlinSys.h.

    {
        return m_linsol;
    }

References m_linsol.

◆ GetNtotLinSysIts()

int Nektar::LibUtilities::NekNonlinSys::GetNtotLinSysIts ( )

inline

Definition at line 86 of file NekNonlinSys.h.

    {
        return m_NtotLinSysIts;
    }

References m_NtotLinSysIts.

◆ GetRefResidual()

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

inline

Definition at line 69 of file NekNonlinSys.h.

    {
        return m_Residual;
    }

References m_Residual.

◆ GetRefSolution()

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

inline

Definition at line 63 of file NekNonlinSys.h.

    {
        return m_Solution;
    }

References m_Solution.

◆ GetRefSourceVec()

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

inline

Definition at line 75 of file NekNonlinSys.h.

    {
        return m_SourceVec;
    }

References m_SourceVec.

◆ SetLinSysRelativeTolInNonlin()

void Nektar::LibUtilities::NekNonlinSys::SetLinSysRelativeTolInNonlin ( const NekDouble in )

inline

Definition at line 107 of file NekNonlinSys.h.

    {
        m_LinSysRelativeTolInNonlin = in;
    }

References m_LinSysRelativeTolInNonlin.

◆ SetNekNonlinSysMaxIterations()

void Nektar::LibUtilities::NekNonlinSys::SetNekNonlinSysMaxIterations ( const unsigned int in )

inline

Definition at line 96 of file NekNonlinSys.h.

    {
        m_maxiter = in;
    }

References Nektar::LibUtilities::NekSys::m_maxiter.

◆ SetNekNonlinSysTolerance()

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

inline

Definition at line 91 of file NekNonlinSys.h.

    {
        m_tolerance = in;
    }

References Nektar::LibUtilities::NekSys::m_tolerance.

◆ SetNonlinIterTolRelativeL2()

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

inline

Definition at line 102 of file NekNonlinSys.h.

    {
        m_NonlinIterTolRelativeL2 = in;
    }

References m_NonlinIterTolRelativeL2.

◆ v_InitObject()

void Nektar::LibUtilities::NekNonlinSys::v_InitObject ( )

overrideprotectedvirtual

Reimplemented from Nektar::LibUtilities::NekSys.

Reimplemented in Nektar::LibUtilities::NekNonlinSysNewton.

Definition at line 73 of file NekNonlinSys.cpp.

{
    NekSys::v_InitObject();
}

References Nektar::LibUtilities::NekSys::v_InitObject().

Member Data Documentation

◆ m_DeltSltn

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

protected

Definition at line 125 of file NekNonlinSys.h.

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

◆ m_linsol

NekLinSysIterSharedPtr Nektar::LibUtilities::NekNonlinSys::m_linsol

protected

Definition at line 113 of file NekNonlinSys.h.

Referenced by GetLinSys(), NekNonlinSys(), Nektar::LibUtilities::NekNonlinSysNewton::v_SetSysOperators(), and Nektar::LibUtilities::NekNonlinSysNewton::v_SolveSystem().

◆ m_LinSysIterSolverType

std::string Nektar::LibUtilities::NekNonlinSys::m_LinSysIterSolverType

protected

Definition at line 118 of file NekNonlinSys.h.

Referenced by NekNonlinSys().

◆ m_LinSysRelativeTolInNonlin

NekDouble Nektar::LibUtilities::NekNonlinSys::m_LinSysRelativeTolInNonlin

protected

Definition at line 116 of file NekNonlinSys.h.

Referenced by Nektar::LibUtilities::NekNonlinSysNewton::CalcInexactNewtonForcing(), NekNonlinSys(), and SetLinSysRelativeTolInNonlin().

◆ m_NonlinIterTolRelativeL2

NekDouble Nektar::LibUtilities::NekNonlinSys::m_NonlinIterTolRelativeL2

protected

Definition at line 115 of file NekNonlinSys.h.

Referenced by NekNonlinSys(), SetNonlinIterTolRelativeL2(), and Nektar::LibUtilities::NekNonlinSysNewton::v_ConvergenceCheck().

◆ m_NtotLinSysIts

int Nektar::LibUtilities::NekNonlinSys::m_NtotLinSysIts = 0

protected

Definition at line 121 of file NekNonlinSys.h.

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

◆ m_Residual

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

protected

Definition at line 124 of file NekNonlinSys.h.

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

◆ m_Solution

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

protected

Definition at line 123 of file NekNonlinSys.h.

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

◆ m_SourceVec

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

protected

Definition at line 126 of file NekNonlinSys.h.

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

◆ m_totalIterations

int Nektar::LibUtilities::NekNonlinSys::m_totalIterations = 0

protected

Definition at line 120 of file NekNonlinSys.h.

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ NekNonlinSys()

◆ ~NekNonlinSys()

Member Function Documentation

◆ GetLinSys()

◆ GetNtotLinSysIts()

◆ GetRefResidual()

◆ GetRefSolution()

◆ GetRefSourceVec()

◆ SetLinSysRelativeTolInNonlin()

◆ SetNekNonlinSysMaxIterations()

◆ SetNekNonlinSysTolerance()

◆ SetNonlinIterTolRelativeL2()

◆ v_InitObject()

Member Data Documentation

◆ m_DeltSltn

◆ m_linsol

◆ m_LinSysIterSolverType

◆ m_LinSysRelativeTolInNonlin

◆ m_NonlinIterTolRelativeL2

◆ m_NtotLinSysIts

◆ m_Residual

◆ m_Solution

◆ m_SourceVec

◆ m_totalIterations