Nektar::LibUtilities::NekLinSysIterFixedpointJacobi Class Reference

#include <NekLinSysIterFixedpointJacobi.h>

Inheritance diagram for Nektar::LibUtilities::NekLinSysIterFixedpointJacobi:

Public Member Functions
	NekLinSysIterFixedpointJacobi (const LibUtilities::SessionReaderSharedPtr &pSession, const LibUtilities::CommSharedPtr &vRowComm, const int nDimen, const NekSysKey &pKey)
	~NekLinSysIterFixedpointJacobi () override=default
Public Member Functions inherited from Nektar::LibUtilities::NekLinSysIter
	NekLinSysIter (const LibUtilities::SessionReaderSharedPtr &pSession, const LibUtilities::CommSharedPtr &vRowComm, const int nDimen, const NekSysKey &pKey)
	~NekLinSysIter () override=default
void	SetUniversalUniqueMap (const Array< OneD, const int > &map)
void	setRhsMagnitude (const NekDouble mag)
void	SetNekLinSysMaxIterations (const unsigned int in)
void	SetLinSysMaxStorage (const unsigned int in)
bool	IsLocal ()
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)

Static Public Member Functions
static NekLinSysIterSharedPtr	create (const LibUtilities::SessionReaderSharedPtr &pSession, const LibUtilities::CommSharedPtr &vRowComm, const int nDimen, const NekSysKey &pKey)
Static Public Member Functions inherited from Nektar::LibUtilities::NekLinSysIter
static NekLinSysIterSharedPtr	CreateInstance (const LibUtilities::SessionReaderSharedPtr &pSession, const LibUtilities::CommSharedPtr &vRowComm, const int nDimen, const NekSysKey &pKey)
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)

Static Public Attributes
static std::string	className

Protected Member Functions
void	v_InitObject () override
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) override
Protected Member Functions inherited from Nektar::LibUtilities::NekLinSysIter
void	Set_Rhs_Magnitude (const NekVector< NekDouble > &pIn)
void	Set_Rhs_Magnitude (const Array< OneD, NekDouble > &pIn)
void	SetUniversalUniqueMap ()
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)

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

Additional Inherited Members
Protected Attributes inherited from Nektar::LibUtilities::NekLinSysIter
Array< OneD, int >	m_map
	Global to universal unique map. More...
NekDouble	m_rhs_magnitude = NekConstants::kNekUnsetDouble
	Dot product of rhs to normalise stopping criterion. More...
int	m_totalIterations = 0
NekDouble	m_prec_factor = 1.0
int	m_LinSysMaxStorage
bool	m_isLocal
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...

Detailed Description

Solves a linear system using iterative methods.

Definition at line 48 of file NekLinSysIterFixedpointJacobi.h.

Constructor & Destructor Documentation

NekLinSysIterFixedpointJacobi()

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

Definition at line 52 of file NekLinSysIterFixedpointJacobi.cpp.

    : NekLinSysIter(pSession, vRowComm, nDimen, pKey)
{
}

~NekLinSysIterFixedpointJacobi()

Nektar::LibUtilities::NekLinSysIterFixedpointJacobi::~NekLinSysIterFixedpointJacobi ( )

overridedefault

Member Function Documentation

create()

static NekLinSysIterSharedPtr Nektar::LibUtilities::NekLinSysIterFixedpointJacobi::create ( const LibUtilities::SessionReaderSharedPtr &  pSession, const LibUtilities::CommSharedPtr &  vRowComm, const int  nDimen, const NekSysKey &  pKey  )

inlinestatic

Definition at line 54 of file NekLinSysIterFixedpointJacobi.h.

    {
        NekLinSysIterFixedpointJacobiSharedPtr p =
            MemoryManager<NekLinSysIterFixedpointJacobi>::AllocateSharedPtr(
                pSession, vRowComm, nDimen, pKey);
        p->InitObject();
        return p;
    }

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

v_InitObject()

void Nektar::LibUtilities::NekLinSysIterFixedpointJacobi::v_InitObject ( )

overrideprotectedvirtual

Reimplemented from Nektar::LibUtilities::NekLinSysIter.

Definition at line 63 of file NekLinSysIterFixedpointJacobi.cpp.

{
    NekLinSysIter::v_InitObject();
}

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

v_SolveSystem()

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

overrideprotectedvirtual

Reimplemented from Nektar::LibUtilities::NekSys.

Definition at line 71 of file NekLinSysIterFixedpointJacobi.cpp.

{
 
    int niterations = 0;
    m_tolerance     = max(tol, 1.0E-16);
 
    Array<OneD, NekDouble> pSol0(nGlobal);
    Vmath::Vcopy(nGlobal, pSolution, 1, pSol0, 1);
    for (int i = 0; i < m_maxiter; ++i)
    {
        m_operator.DoNekSysFixPointIte(pRhs, pSol0, pSolution);
        Vmath::Vsub(nGlobal, pSolution, 1, pSol0, 1, pSol0, 1);
        m_converged = ConvergenceCheck(i, pSol0, m_tolerance);
        Vmath::Vcopy(nGlobal, pSolution, 1, pSol0, 1);
        niterations++;
        if (m_converged)
        {
            break;
        }
    }
 
    return niterations;
}

References Nektar::LibUtilities::NekSys::ConvergenceCheck(), Nektar::LibUtilities::NekSysOperators::DoNekSysFixPointIte(), Nektar::LibUtilities::NekSys::m_converged, Nektar::LibUtilities::NekSys::m_maxiter, Nektar::LibUtilities::NekSys::m_operator, Nektar::LibUtilities::NekSys::m_tolerance, Vmath::Vcopy(), and Vmath::Vsub().

Friends And Related Function Documentation

MemoryManager< NekLinSysIterFixedpointJacobi >

friend class MemoryManager< NekLinSysIterFixedpointJacobi >

friend

Support creation through MemoryManager.

Definition at line 46 of file NekLinSysIterFixedpointJacobi.h.

Member Data Documentation

className

string Nektar::LibUtilities::NekLinSysIterFixedpointJacobi::className

static

Initial value:

=
    LibUtilities::GetNekLinSysIterFactory().RegisterCreatorFunction(
        "FixedpointJacobi", NekLinSysIterFixedpointJacobi::create,
        "NekLinSysIterFixedpointJacobi solver.")

Definition at line 65 of file NekLinSysIterFixedpointJacobi.h.