Nektar::LibUtilities::NekSys Class Reference

#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)
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)

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

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

Detailed Description

Solves a nonlinear or linear system.

Definition at line 236 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 46 of file NekSys.cpp.

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

References m_converged, m_FlagWarnings, m_root, m_rowComm, m_SysDimen, and m_verbose.

~NekSys()

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

virtualdefault

Member Function Documentation

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 242 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 270 of file NekSys.h.

    {
        return m_operator;
    }

References m_operator.

InitObject()

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

inline

Definition at line 258 of file NekSys.h.

    {
        v_InitObject();
    }

References v_InitObject().

SetFlagWarnings()

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

inline

Definition at line 280 of file NekSys.h.

    {
        m_FlagWarnings = in;
    }

References m_FlagWarnings.

SetRhsMagnitude()

void Nektar::LibUtilities::NekSys::SetRhsMagnitude ( const NekDouble  mag )

inline

Definition at line 285 of file NekSys.h.

    {
        m_rhs_magnitude = mag;
    }

References m_rhs_magnitude.

SetSysOperators()

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

inline

Definition at line 275 of file NekSys.h.

    {
        v_SetSysOperators(in);
    }

References v_SetSysOperators().

SolveSystem()

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

inline

Definition at line 263 of file NekSys.h.

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

References v_SolveSystem().

v_InitObject()

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

inlineprotectedvirtual

Reimplemented in Nektar::LibUtilities::NekLinSysIter, Nektar::LibUtilities::NekLinSysIterCG, Nektar::LibUtilities::NekLinSysIterCGLoc, Nektar::LibUtilities::NekLinSysIterFixedpointJacobi, Nektar::LibUtilities::NekLinSysIterGMRES, Nektar::LibUtilities::NekLinSysIterGMRESLoc, Nektar::LibUtilities::NekNonlinSysIter, and Nektar::LibUtilities::NekNonlinSysIterNewton.

Definition at line 302 of file NekSys.h.

    {
    }

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

v_SetSysOperators()

virtual void Nektar::LibUtilities::NekSys::v_SetSysOperators ( const NekSysOperators &  in )

inlineprotectedvirtual

Reimplemented in Nektar::LibUtilities::NekNonlinSysIter.

Definition at line 306 of file NekSys.h.

    {
        m_operator = in;
    }

References m_operator.

Referenced by SetSysOperators(), and Nektar::LibUtilities::NekNonlinSysIter::v_SetSysOperators().

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  )

inlineprotectedvirtual

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

Definition at line 311 of file NekSys.h.

    {
        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 229 of file NekSys.h.

Member Data Documentation

m_converged

bool Nektar::LibUtilities::NekSys::m_converged

protected

Definition at line 292 of file NekSys.h.

Referenced by Nektar::LibUtilities::NekLinSysIter::ConvergenceCheck(), Nektar::LibUtilities::NekNonlinSysIter::ConvergenceCheck(), 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::NekNonlinSysIterNewton::v_SolveSystem().

m_FlagWarnings

bool Nektar::LibUtilities::NekSys::m_FlagWarnings

protected

Definition at line 295 of file NekSys.h.

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

m_operator

NekSysOperators Nektar::LibUtilities::NekSys::m_operator

protected

Definition at line 298 of file NekSys.h.

Referenced by Nektar::LibUtilities::NekLinSysIterGMRES::DoArnoldi(), Nektar::LibUtilities::NekLinSysIterGMRESLoc::DoArnoldi(), Nektar::LibUtilities::NekLinSysIterCGLoc::DoConjugateGradient(), Nektar::LibUtilities::NekLinSysIterCG::DoConjugateGradient(), Nektar::LibUtilities::NekLinSysIterGMRESLoc::DoGMRES(), Nektar::LibUtilities::NekLinSysIterGMRES::DoGMRES(), Nektar::LibUtilities::NekLinSysIterGMRES::DoGmresRestart(), Nektar::LibUtilities::NekLinSysIterGMRESLoc::DoGmresRestart(), GetSysOperators(), Nektar::LibUtilities::NekLinSysIter::Set_Rhs_Magnitude(), v_SetSysOperators(), Nektar::LibUtilities::NekLinSysIterFixedpointJacobi::v_SolveSystem(), and Nektar::LibUtilities::NekNonlinSysIterNewton::v_SolveSystem().

m_rhs_magnitude

NekDouble Nektar::LibUtilities::NekSys::m_rhs_magnitude = NekConstants::kNekUnsetDouble

protected

Definition at line 300 of file NekSys.h.

Referenced by Nektar::LibUtilities::NekLinSysIter::ConvergenceCheck(), Nektar::LibUtilities::NekNonlinSysIter::ConvergenceCheck(), Nektar::LibUtilities::NekLinSysIterCGLoc::DoConjugateGradient(), Nektar::LibUtilities::NekLinSysIterCG::DoConjugateGradient(), Nektar::LibUtilities::NekLinSysIterGMRESLoc::DoGMRES(), Nektar::LibUtilities::NekLinSysIterGMRES::DoGMRES(), Nektar::LibUtilities::NekLinSysIterGMRES::DoGmresRestart(), Nektar::LibUtilities::NekLinSysIterGMRESLoc::DoGmresRestart(), Nektar::LibUtilities::NekLinSysIter::Set_Rhs_Magnitude(), SetRhsMagnitude(), and Nektar::LibUtilities::NekNonlinSysIterNewton::v_SolveSystem().

m_root

bool Nektar::LibUtilities::NekSys::m_root

protected

Definition at line 293 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::NekNonlinSysIterNewton::v_SolveSystem().

m_rowComm

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

protected

Definition at line 291 of file NekSys.h.

Referenced by Nektar::LibUtilities::NekLinSysIter::ConvergenceCheck(), Nektar::LibUtilities::NekNonlinSysIter::ConvergenceCheck(), Nektar::LibUtilities::NekLinSysIterGMRES::DoArnoldi(), Nektar::LibUtilities::NekLinSysIterGMRESLoc::DoArnoldi(), Nektar::LibUtilities::NekLinSysIterCGLoc::DoConjugateGradient(), Nektar::LibUtilities::NekLinSysIterCG::DoConjugateGradient(), Nektar::LibUtilities::NekLinSysIterGMRESLoc::DoGMRES(), Nektar::LibUtilities::NekLinSysIterGMRES::DoGMRES(), Nektar::LibUtilities::NekLinSysIterGMRES::DoGmresRestart(), Nektar::LibUtilities::NekLinSysIterGMRESLoc::DoGmresRestart(), Nektar::LibUtilities::NekNonlinSysIter::NekNonlinSysIter(), NekSys(), and Nektar::LibUtilities::NekLinSysIter::Set_Rhs_Magnitude().

m_SysDimen

int Nektar::LibUtilities::NekSys::m_SysDimen

protected

Definition at line 296 of file NekSys.h.

Referenced by Nektar::LibUtilities::NekNonlinSysIter::NekNonlinSysIter(), NekSys(), Nektar::LibUtilities::NekLinSysIter::SetUniversalUniqueMap(), Nektar::LibUtilities::NekNonlinSysIter::v_InitObject(), and Nektar::LibUtilities::NekNonlinSysIterNewton::v_SolveSystem().

m_verbose

bool Nektar::LibUtilities::NekSys::m_verbose

protected

Definition at line 294 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::NekNonlinSysIterNewton::v_SolveSystem().