#include <NekLinSysIter.h>

Inheritance diagram for Nektar::LibUtilities::NekLinSysIter:

Public Member Functions
	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, const int nDir=0)

void	SetNekLinSysTolerance (const NekDouble in)

void	SetNekLinSysMaxIterations (const unsigned int in)

void	SetErrorCheckInterval (const unsigned int in)

int	GetNekLinSysTolerance ()

bool	IsLocal ()

void	DoIterate (const int nGlobal, const Array< OneD, NekDouble > &rhs, Array< OneD, NekDouble > &x, const int nDir, NekDouble &err, int &iter)

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)

Static Public Member Functions
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)

Protected Member Functions
void	v_InitObject () override

void	SetUniversalUniqueMap ()

void	Set_Rhs_Magnitude (const Array< OneD, NekDouble > &pIn)

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

virtual void	v_DoIterate (const int nGlobal, const Array< OneD, NekDouble > &rhs, Array< OneD, NekDouble > &x, const int nDir, NekDouble &err, int &iter)

Protected Member Functions inherited from Nektar::LibUtilities::NekSys
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
Array< OneD, int >	m_map
	Global to universal unique map.

NekDouble	m_NekLinSysTolerance

int	m_NekLinSysMaxIterations

int	m_totalIterations = 0

NekDouble	m_finalError = 999.9

int	m_errorCheckInterval = 1

bool	m_mapIsOnes = false

bool	m_isLocal

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

Friends
class	MemoryManager< NekLinSysIter >
	Support creation through MemoryManager.

Detailed Description

Solves a linear system using iterative methods.

Definition at line 55 of file NekLinSysIter.h.

Constructor & Destructor Documentation

◆ NekLinSysIter()

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

Definition at line 51 of file NekLinSysIter.cpp.

    : NekSys(pSession, vRowComm, nDimen, pKey)
{
    m_NekLinSysTolerance     = fmax(pKey.m_NekLinSysTolerance, 1.0E-16);
    m_NekLinSysMaxIterations = pKey.m_NekLinSysMaxIterations;
    m_isLocal                = false;
}

References m_isLocal, m_NekLinSysMaxIterations, Nektar::LibUtilities::NekSysKey::m_NekLinSysMaxIterations, m_NekLinSysTolerance, and Nektar::LibUtilities::NekSysKey::m_NekLinSysTolerance.

◆ ~NekLinSysIter()

Nektar::LibUtilities::NekLinSysIter::~NekLinSysIter ( )

overridedefault

Member Function Documentation

◆ ConvergenceCheck()

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

protected

Definition at line 114 of file NekLinSysIter.cpp.

{
    m_finalError = Vmath::Dot(Residual.size(), Residual, Residual);
    m_rowComm->AllReduce(m_finalError, Nektar::LibUtilities::ReduceSum);
 
    m_converged = m_finalError <
                  m_NekLinSysTolerance * m_NekLinSysTolerance * m_rhs_magnitude;
}

References Vmath::Dot(), Nektar::LibUtilities::NekSys::m_converged, m_finalError, m_NekLinSysTolerance, Nektar::LibUtilities::NekSys::m_rhs_magnitude, Nektar::LibUtilities::NekSys::m_rowComm, and Nektar::LibUtilities::ReduceSum.

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

◆ CreateInstance()

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

inlinestatic

Definition at line 61 of file NekLinSysIter.h.

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

References Nektar::MemoryManager< DataType >::AllocateSharedPtr().

◆ DoIterate()

void Nektar::LibUtilities::NekLinSysIter::DoIterate	(	const int	nGlobal,
		const Array< OneD, NekDouble > &	rhs,
		Array< OneD, NekDouble > &	x,
		const int	nDir,
		NekDouble &	err,
		int &	iter
	)

inline

Definition at line 109 of file NekLinSysIter.h.

    {
        v_DoIterate(nGlobal, rhs, x, nDir, err, iter);
    }

References v_DoIterate().

◆ GetNekLinSysTolerance()

int Nektar::LibUtilities::NekLinSysIter::GetNekLinSysTolerance ( )

inline

Definition at line 96 of file NekLinSysIter.h.

    {
        return m_NekLinSysTolerance;
    }

References m_NekLinSysTolerance.

◆ IsLocal()

bool Nektar::LibUtilities::NekLinSysIter::IsLocal ( )

inline

Definition at line 101 of file NekLinSysIter.h.

    {
        return m_isLocal;
    }

References m_isLocal.

◆ Set_Rhs_Magnitude()

void Nektar::LibUtilities::NekLinSysIter::Set_Rhs_Magnitude ( const Array< OneD, NekDouble > & pIn )

protected

Definition at line 95 of file NekLinSysIter.cpp.

{
    NekDouble vExchange(0.0);
 
    if (m_isLocal)
    {
        Array<OneD, NekDouble> wk(pIn.size());
        m_operator.DoAssembleLoc(pIn, wk);
        vExchange = Vmath::Dot(pIn.size(), wk, pIn);
    }
    else
    {
        vExchange = Vmath::Dot2(pIn.size(), pIn, pIn, m_map);
    }
 
    m_rowComm->AllReduce(vExchange, LibUtilities::ReduceSum);
    m_rhs_magnitude = (vExchange > 1.0e-6) ? vExchange : 1.0;
}

References Nektar::LibUtilities::NekSysOperators::DoAssembleLoc(), Vmath::Dot(), Vmath::Dot2(), m_isLocal, m_map, Nektar::LibUtilities::NekSys::m_operator, Nektar::LibUtilities::NekSys::m_rhs_magnitude, Nektar::LibUtilities::NekSys::m_rowComm, and Nektar::LibUtilities::ReduceSum.

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

◆ SetErrorCheckInterval()

void Nektar::LibUtilities::NekLinSysIter::SetErrorCheckInterval ( const unsigned int in )

inline

Definition at line 91 of file NekLinSysIter.h.

    {
        m_errorCheckInterval = in;
    }

References m_errorCheckInterval.

◆ SetNekLinSysMaxIterations()

void Nektar::LibUtilities::NekLinSysIter::SetNekLinSysMaxIterations ( const unsigned int in )

inline

Definition at line 86 of file NekLinSysIter.h.

    {
        m_NekLinSysMaxIterations = in;
    }

References m_NekLinSysMaxIterations.

◆ SetNekLinSysTolerance()

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

inline

Definition at line 81 of file NekLinSysIter.h.

    {
        m_NekLinSysTolerance = fmax(1.0E-16, in);
    }

References m_NekLinSysTolerance.

◆ SetUniversalUniqueMap() [1/2]

void Nektar::LibUtilities::NekLinSysIter::SetUniversalUniqueMap ( )

protected

Definition at line 89 of file NekLinSysIter.cpp.

{
    m_map       = Array<OneD, int>(m_SysDimen, 1);
    m_mapIsOnes = true;
}

References m_map, m_mapIsOnes, and Nektar::LibUtilities::NekSys::m_SysDimen.

Referenced by v_InitObject().

◆ SetUniversalUniqueMap() [2/2]

void Nektar::LibUtilities::NekLinSysIter::SetUniversalUniqueMap	(	const Array< OneD, const int > &	map,
		const int	nDir = `0`
	)

Definition at line 68 of file NekLinSysIter.cpp.

{
    int nmap = map.size();
    if (m_map.size() != nmap)
    {
        m_map = Array<OneD, int>(nmap, 0);
    }
    Vmath::Vcopy(nmap, map, 1, m_map, 1);
    // check if map is all ones, ignore Dirichlet BCs
    m_mapIsOnes = true;
    for (int i = nDir; i < nmap; ++i)
    {
        if (map[i] != 1)
        {
            m_mapIsOnes = false;
            break;
        }
    }
}

References m_map, m_mapIsOnes, and Vmath::Vcopy().

◆ v_DoIterate()

virtual void Nektar::LibUtilities::NekLinSysIter::v_DoIterate	(	const int	nGlobal,
		const Array< OneD, NekDouble > &	rhs,
		Array< OneD, NekDouble > &	x,
		const int	nDir,
		NekDouble &	err,
		int &	iter
	)

inlineprotectedvirtual

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

Definition at line 147 of file NekLinSysIter.h.

    {
        ASSERTL0(false, "v_DoIterate is NOT defined.");
    }

References ASSERTL0.

Referenced by DoIterate().

◆ v_InitObject()

void Nektar::LibUtilities::NekLinSysIter::v_InitObject ( )

overrideprotectedvirtual

Reimplemented from Nektar::LibUtilities::NekSys.

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

Definition at line 62 of file NekLinSysIter.cpp.

{
    NekSys::v_InitObject();
    SetUniversalUniqueMap();
}

References SetUniversalUniqueMap(), and Nektar::LibUtilities::NekSys::v_InitObject().

Referenced by Nektar::LibUtilities::NekLinSysIterCG::v_InitObject(), Nektar::LibUtilities::NekLinSysIterCGLoc::v_InitObject(), Nektar::LibUtilities::NekLinSysIterFixedpointJacobi::v_InitObject(), Nektar::LibUtilities::NekLinSysIterGMRES::v_InitObject(), and Nektar::LibUtilities::NekLinSysIterGMRESLoc::v_InitObject().

Friends And Related Symbol Documentation

◆ MemoryManager< NekLinSysIter >

friend class MemoryManager< NekLinSysIter >

friend

Support creation through MemoryManager.

Definition at line 53 of file NekLinSysIter.h.

Member Data Documentation

◆ m_errorCheckInterval

int Nektar::LibUtilities::NekLinSysIter::m_errorCheckInterval = 1

protected

Definition at line 130 of file NekLinSysIter.h.

Referenced by Nektar::LibUtilities::NekLinSysIterCGLoc::DoConjugateGradient(), Nektar::LibUtilities::NekLinSysIterCG::DoConjugateGradient(), SetErrorCheckInterval(), and Nektar::LibUtilities::NekLinSysIterFixedpointJacobi::v_SolveSystem().

◆ m_finalError

NekDouble Nektar::LibUtilities::NekLinSysIter::m_finalError = 999.9

protected

Definition at line 125 of file NekLinSysIter.h.

◆ m_isLocal

bool Nektar::LibUtilities::NekLinSysIter::m_isLocal

protected

Definition at line 137 of file NekLinSysIter.h.

Referenced by IsLocal(), NekLinSysIter(), Nektar::LibUtilities::NekLinSysIterCGLoc::NekLinSysIterCGLoc(), Nektar::LibUtilities::NekLinSysIterGMRESLoc::NekLinSysIterGMRESLoc(), and Set_Rhs_Magnitude().

◆ m_map

Array<OneD, int> Nektar::LibUtilities::NekLinSysIter::m_map

protected

Global to universal unique map.

Definition at line 120 of file NekLinSysIter.h.

Referenced by Nektar::LibUtilities::NekLinSysIterGMRES::DoArnoldi(), Nektar::LibUtilities::NekLinSysIterCG::DoConjugateGradient(), Nektar::LibUtilities::NekLinSysIterGMRES::DoGMRES(), Nektar::LibUtilities::NekLinSysIterGMRES::DoGmresRestart(), Set_Rhs_Magnitude(), SetUniversalUniqueMap(), and SetUniversalUniqueMap().

◆ m_mapIsOnes

bool Nektar::LibUtilities::NekLinSysIter::m_mapIsOnes = false

protected

Definition at line 134 of file NekLinSysIter.h.

Referenced by Nektar::LibUtilities::NekLinSysIterCG::DoConjugateGradient(), SetUniversalUniqueMap(), and SetUniversalUniqueMap().

◆ m_NekLinSysMaxIterations

int Nektar::LibUtilities::NekLinSysIter::m_NekLinSysMaxIterations

protected

Definition at line 123 of file NekLinSysIter.h.

Referenced by Nektar::LibUtilities::NekLinSysIterCGLoc::DoConjugateGradient(), Nektar::LibUtilities::NekLinSysIterCG::DoConjugateGradient(), NekLinSysIter(), Nektar::LibUtilities::NekLinSysIterGMRES::NekLinSysIterGMRES(), Nektar::LibUtilities::NekLinSysIterGMRESLoc::NekLinSysIterGMRESLoc(), SetNekLinSysMaxIterations(), and Nektar::LibUtilities::NekLinSysIterFixedpointJacobi::v_SolveSystem().

◆ m_NekLinSysTolerance

NekDouble Nektar::LibUtilities::NekLinSysIter::m_NekLinSysTolerance

protected

Definition at line 122 of file NekLinSysIter.h.

Referenced by 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(), GetNekLinSysTolerance(), NekLinSysIter(), and SetNekLinSysTolerance().

◆ m_totalIterations

int Nektar::LibUtilities::NekLinSysIter::m_totalIterations = 0

protected

Definition at line 124 of file NekLinSysIter.h.

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ NekLinSysIter()

◆ ~NekLinSysIter()

Member Function Documentation

◆ ConvergenceCheck()

◆ CreateInstance()

◆ DoIterate()

◆ GetNekLinSysTolerance()

◆ IsLocal()

◆ Set_Rhs_Magnitude()

◆ SetErrorCheckInterval()

◆ SetNekLinSysMaxIterations()

◆ SetNekLinSysTolerance()

◆ SetUniversalUniqueMap() [1/2]

◆ SetUniversalUniqueMap() [2/2]

◆ v_DoIterate()

◆ v_InitObject()

Friends And Related Symbol Documentation

◆ MemoryManager< NekLinSysIter >

Member Data Documentation

◆ m_errorCheckInterval

◆ m_finalError

◆ m_isLocal

◆ m_map

◆ m_mapIsOnes

◆ m_NekLinSysMaxIterations

◆ m_NekLinSysTolerance

◆ m_totalIterations