#include <NekSys.h>

Inheritance diagram for Nektar::LibUtilities::NekSys:

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

void	InitObject ()

virtual	~NekSys ()

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)

Static Public Member Functions
static NekSysSharedPtr	CreateInstance (const LibUtilities::SessionReaderSharedPtr &pSession, const LibUtilities::CommSharedPtr &vRowComm, const int nDimen, const NekSysKey &pKey)

Protected Member Functions
virtual void	v_InitObject ()

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

Friends
class	MemoryManager< NekSys >
	Support creation through MemoryManager. More...

Detailed Description

Solves a nonlinear or linear system.

Definition at line 241 of file NekSys.h.

Constructor & Destructor Documentation

◆ NekSys()

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

Definition at line 50 of file NekSys.cpp.

{
    m_tolerance = pKey.m_Tolerance;
    m_verbose   = false;
    m_root      = false;
    m_rowComm   = vRowComm;
 
    m_FlagWarnings = true;
 
    if (0 == m_rowComm->GetRank())
    {
        m_root = true;
    }
    m_verbose = pSession->DefinesCmdLineArgument("verbose");
 
    m_converged = false;
 
    m_SysDimen = nDimen;
}

References m_converged, m_FlagWarnings, m_root, m_rowComm, m_SysDimen, Nektar::LibUtilities::NekSysKey::m_Tolerance, m_tolerance, and m_verbose.

◆ ~NekSys()

Nektar::LibUtilities::NekSys::~NekSys ( )

virtual

Definition at line 72 of file NekSys.cpp.

73{

74}

Member Function Documentation

◆ ConvergenceCheck()

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

inline

Definition at line 284 of file NekSys.h.

    {
        return v_ConvergenceCheck(nIteration, Residual, tol);
    }

References v_ConvergenceCheck().

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

◆ CreateInstance()

static NekSysSharedPtr Nektar::LibUtilities::NekSys::CreateInstance	(	const LibUtilities::SessionReaderSharedPtr &	pSession,
		const LibUtilities::CommSharedPtr &	vRowComm,
		const int	nDimen,
		const NekSysKey &	pKey
	)

inlinestatic

Definition at line 247 of file NekSys.h.

    {
        NekSysSharedPtr p = MemoryManager<NekSys>::AllocateSharedPtr(
            pSession, vRowComm, nDimen, pKey);
        return p;
    }

References Nektar::MemoryManager< DataType >::AllocateSharedPtr(), and CellMLToNektar.cellml_metadata::p.

◆ GetSysOperators()

const NekSysOperators & Nektar::LibUtilities::NekSys::GetSysOperators ( )

inline

Definition at line 271 of file NekSys.h.

    {
        return m_operator;
    }

References m_operator.

◆ InitObject()

void Nektar::LibUtilities::NekSys::InitObject ( )

inline

Definition at line 260 of file NekSys.h.

    {
        v_InitObject();
    }

References v_InitObject().

◆ SetFlagWarnings()

void Nektar::LibUtilities::NekSys::SetFlagWarnings ( bool in )

inline

Definition at line 291 of file NekSys.h.

    {
        m_FlagWarnings = in;
    }

References m_FlagWarnings.

◆ SetSysOperators()

void Nektar::LibUtilities::NekSys::SetSysOperators ( const NekSysOperators & in )

inline

Definition at line 266 of file NekSys.h.

    {
        m_operator = in;
    }

References m_operator.

◆ SolveSystem()

int Nektar::LibUtilities::NekSys::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`
	)

inline

Definition at line 276 of file NekSys.h.

    {
        return v_SolveSystem(nGlobal, pInput, pOutput, nDir, tol, factor);
    }

References v_SolveSystem().

◆ v_ConvergenceCheck()

bool Nektar::LibUtilities::NekSys::v_ConvergenceCheck	(	const int	nIteration,
		const Array< OneD, const NekDouble > &	Residual,
		const NekDouble	tol
	)

protectedvirtual

Reimplemented in Nektar::LibUtilities::NekNonlinSysNewton.

Definition at line 76 of file NekSys.cpp.

{
    bool converged = false;
    int ntotal     = Residual.size();
    boost::ignore_unused(nIteration);
 
    NekDouble SysResNorm = Vmath::Dot(ntotal, Residual, Residual);
    m_rowComm->AllReduce(SysResNorm, Nektar::LibUtilities::ReduceSum);
 
    if (SysResNorm < tol * tol)
    {
        converged = true;
    }
    return converged;
}

References Vmath::Dot(), m_rowComm, and Nektar::LibUtilities::ReduceSum.

Referenced by ConvergenceCheck().

◆ v_InitObject()

virtual void Nektar::LibUtilities::NekSys::v_InitObject ( )

inlineprotectedvirtual

Reimplemented in Nektar::LibUtilities::NekNonlinSys, Nektar::LibUtilities::NekLinSysIter, Nektar::LibUtilities::NekLinSysIterCG, Nektar::LibUtilities::NekLinSysIterCGLoc, Nektar::LibUtilities::NekLinSysIterFixedpointJacobi, Nektar::LibUtilities::NekLinSysIterGMRES, Nektar::LibUtilities::NekLinSysIterGMRESLoc, and Nektar::LibUtilities::NekNonlinSysNewton.

Definition at line 315 of file NekSys.h.

316 {

317 }

Referenced by InitObject(), Nektar::LibUtilities::NekNonlinSys::v_InitObject(), Nektar::LibUtilities::NekLinSysIter::v_InitObject(), and Nektar::LibUtilities::NekNonlinSysNewton::v_InitObject().

◆ v_NekSysInitialGuess()

void Nektar::LibUtilities::NekSys::v_NekSysInitialGuess	(	const Array< OneD, const NekDouble > &	pInput,
		Array< OneD, NekDouble > &	pguess
	)

protectedvirtual

Natural guess

Definition at line 97 of file NekSys.cpp.

{
    size_t ndim = pInput.size();
    if (pguess.size() != ndim)
    {
        pguess = Array<OneD, NekDouble>{ndim};
    }
 
    Vmath::Vcopy(ndim, pInput, 1, pguess, 1);
}

References Vmath::Vcopy().

◆ v_SolveSystem()

virtual int Nektar::LibUtilities::NekSys::v_SolveSystem	(	const int	nGlobal,
		const Array< OneD, const NekDouble > &	pInput,
		Array< OneD, NekDouble > &	pOutput,
		const int	nDir,
		const NekDouble	tol,
		const NekDouble	factor
	)

inlineprotectedvirtual

Reimplemented in Nektar::LibUtilities::NekLinSysIterCG, Nektar::LibUtilities::NekLinSysIterCGLoc, Nektar::LibUtilities::NekLinSysIterFixedpointJacobi, Nektar::LibUtilities::NekLinSysIterGMRES, Nektar::LibUtilities::NekNonlinSysNewton, and Nektar::LibUtilities::NekLinSysIterGMRESLoc.

Definition at line 319 of file NekSys.h.

    {
        boost::ignore_unused(nGlobal, pInput, pOutput, nDir, tol, factor);
        ASSERTL0(false, "LinSysIterSolver NOT CORRECT.");
        return 0;
    }

References ASSERTL0.

Referenced by SolveSystem().

Friends And Related Function Documentation

◆ MemoryManager< NekSys >

friend class MemoryManager< NekSys >

friend

Support creation through MemoryManager.

Definition at line 234 of file NekSys.h.

Member Data Documentation

◆ m_converged

bool Nektar::LibUtilities::NekSys::m_converged

protected

Whether the iteration has been converged.

Definition at line 304 of file NekSys.h.

Referenced by Nektar::LibUtilities::NekLinSysIterGMRESLoc::DoGMRES(), Nektar::LibUtilities::NekLinSysIterGMRES::DoGMRES(), Nektar::LibUtilities::NekLinSysIterGMRES::DoGmresRestart(), Nektar::LibUtilities::NekLinSysIterGMRESLoc::DoGmresRestart(), NekSys(), Nektar::LibUtilities::NekLinSysIterFixedpointJacobi::v_SolveSystem(), and Nektar::LibUtilities::NekNonlinSysNewton::v_SolveSystem().

◆ m_FlagWarnings

bool Nektar::LibUtilities::NekSys::m_FlagWarnings

protected

Definition at line 309 of file NekSys.h.

Referenced by Nektar::LibUtilities::NekLinSysIterGMRESLoc::DoGMRES(), Nektar::LibUtilities::NekLinSysIterGMRES::DoGMRES(), NekSys(), SetFlagWarnings(), and Nektar::LibUtilities::NekNonlinSysNewton::v_SolveSystem().

◆ m_maxiter

int Nektar::LibUtilities::NekSys::m_maxiter

protected

Maximum iterations.

Definition at line 298 of file NekSys.h.

◆ m_operator

NekSysOperators Nektar::LibUtilities::NekSys::m_operator

protected

Operators.

Definition at line 311 of file NekSys.h.

◆ m_root

bool Nektar::LibUtilities::NekSys::m_root

protected

Root if parallel.

Definition at line 306 of file NekSys.h.

Referenced by Nektar::LibUtilities::NekLinSysIterCGLoc::DoConjugateGradient(), Nektar::LibUtilities::NekLinSysIterCG::DoConjugateGradient(), Nektar::LibUtilities::NekLinSysIterGMRESLoc::DoGMRES(), Nektar::LibUtilities::NekLinSysIterGMRES::DoGMRES(), NekSys(), and Nektar::LibUtilities::NekNonlinSysNewton::v_SolveSystem().

◆ m_rowComm

LibUtilities::CommSharedPtr Nektar::LibUtilities::NekSys::m_rowComm

protected

Communicate.

Definition at line 302 of file NekSys.h.

◆ m_SysDimen

int Nektar::LibUtilities::NekSys::m_SysDimen

protected

The dimension of the system.

Definition at line 313 of file NekSys.h.

Referenced by Nektar::LibUtilities::NekNonlinSys::NekNonlinSys(), NekSys(), Nektar::LibUtilities::NekLinSysIter::setUniversalUniqueMap(), Nektar::LibUtilities::NekNonlinSysNewton::v_InitObject(), and Nektar::LibUtilities::NekNonlinSysNewton::v_SetupNekNonlinSystem().

◆ m_tolerance

NekDouble Nektar::LibUtilities::NekSys::m_tolerance

protected

Tolerance of iterative solver.

Definition at line 300 of file NekSys.h.

◆ m_verbose

bool Nektar::LibUtilities::NekSys::m_verbose

protected

Verbose.

Definition at line 308 of file NekSys.h.

Referenced by Nektar::LibUtilities::NekLinSysIterCGLoc::DoConjugateGradient(), Nektar::LibUtilities::NekLinSysIterCG::DoConjugateGradient(), Nektar::LibUtilities::NekLinSysIterGMRESLoc::DoGMRES(), Nektar::LibUtilities::NekLinSysIterGMRES::DoGMRES(), NekSys(), and Nektar::LibUtilities::NekNonlinSysNewton::v_SolveSystem().

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ NekSys()

◆ ~NekSys()

Member Function Documentation

◆ ConvergenceCheck()

◆ CreateInstance()

◆ GetSysOperators()

◆ InitObject()

◆ SetFlagWarnings()

◆ SetSysOperators()

◆ SolveSystem()

◆ v_ConvergenceCheck()

◆ v_InitObject()

◆ v_NekSysInitialGuess()

◆ v_SolveSystem()

Friends And Related Function Documentation

◆ MemoryManager< NekSys >

Member Data Documentation

◆ m_converged

◆ m_FlagWarnings

◆ m_maxiter

◆ m_operator

◆ m_root

◆ m_rowComm

◆ m_SysDimen

◆ m_tolerance

◆ m_verbose