Nektar::MultiRegions::PreconditionerJacobi Class Reference

#include <PreconditionerDiagonal.h>

Inheritance diagram for Nektar::MultiRegions::PreconditionerJacobi:

Public Member Functions
	PreconditionerJacobi (const std::shared_ptr< GlobalLinSys > &plinsys, const AssemblyMapSharedPtr &pLocToGloMap)
	~PreconditionerJacobi () override
Public Member Functions inherited from Nektar::MultiRegions::PreconditionerDiagonal
	PreconditionerDiagonal (const std::shared_ptr< GlobalLinSys > &plinsys, const AssemblyMapSharedPtr &pLocToGloMap)
	~PreconditionerDiagonal () override
Public Member Functions inherited from Nektar::MultiRegions::Preconditioner
	Preconditioner (const std::shared_ptr< GlobalLinSys > &plinsys, const AssemblyMapSharedPtr &pLocToGloMap)
virtual	~Preconditioner ()
void	DoPreconditioner (const Array< OneD, NekDouble > &pInput, Array< OneD, NekDouble > &pOutput, const bool &IsLocal=false)
void	DoAssembleLoc (const Array< OneD, NekDouble > &pInput, Array< OneD, NekDouble > &pOutput, const bool &ZeroDir)
	Apply an assembly and scatter back to lcoal array. More...
void	DoPreconditionerWithNonVertOutput (const Array< OneD, NekDouble > &pInput, Array< OneD, NekDouble > &pOutput, const Array< OneD, NekDouble > &pNonVertOutput, Array< OneD, NekDouble > &pVertForce=NullNekDouble1DArray)
void	DoTransformBasisToLowEnergy (Array< OneD, NekDouble > &pInOut)
void	DoTransformCoeffsFromLowEnergy (Array< OneD, NekDouble > &pInOut)
void	DoTransformCoeffsToLowEnergy (const Array< OneD, NekDouble > &pInput, Array< OneD, NekDouble > &pOutput)
void	DoTransformBasisFromLowEnergy (const Array< OneD, NekDouble > &pInput, Array< OneD, NekDouble > &pOutput)
void	BuildPreconditioner ()
void	InitObject ()
Array< OneD, NekDouble >	AssembleStaticCondGlobalDiagonals ()
	Performs global assembly of diagonal entries to global Schur complement matrix. More...
const DNekScalBlkMatSharedPtr &	GetBlockTransformedSchurCompl () const
const DNekScalBlkMatSharedPtr &	GetBlockCMatrix () const
const DNekScalBlkMatSharedPtr &	GetBlockInvDMatrix () const
const DNekScalBlkMatSharedPtr &	GetBlockSchurCompl () const
const DNekScalBlkMatSharedPtr &	GetBlockTransformationMatrix () const
const DNekScalBlkMatSharedPtr &	GetBlockTransposedTransformationMatrix () const
DNekScalMatSharedPtr	TransformedSchurCompl (int offset, int bndoffset, const std::shared_ptr< DNekScalMat > &loc_mat)

Static Public Member Functions
static PreconditionerSharedPtr	create (const std::shared_ptr< GlobalLinSys > &plinsys, const std::shared_ptr< AssemblyMap > &pLocToGloMap)
	Creates an instance of this class. More...
Static Public Member Functions inherited from Nektar::MultiRegions::PreconditionerDiagonal
static PreconditionerSharedPtr	create (const std::shared_ptr< GlobalLinSys > &plinsys, const std::shared_ptr< AssemblyMap > &pLocToGloMap)
	Creates an instance of this class. More...

Static Public Attributes
static std::string	className
	Name of class. More...
Static Public Attributes inherited from Nektar::MultiRegions::PreconditionerDiagonal
static std::string	className
	Name of class. More...

Protected Member Functions
void	v_InitObject () override
void	v_BuildPreconditioner () override
void	v_DoPreconditioner (const Array< OneD, NekDouble > &pInput, Array< OneD, NekDouble > &pOutput, const bool &IsLocal=false) override
	Apply a preconditioner to the conjugate gradient method. More...
void	v_InitObject () override
void	v_DoPreconditioner (const Array< OneD, NekDouble > &pInput, Array< OneD, NekDouble > &pOutput, const bool &IsLocal=false) override
	Apply a preconditioner to the conjugate gradient method. More...
void	v_BuildPreconditioner () override
Protected Member Functions inherited from Nektar::MultiRegions::Preconditioner
virtual DNekScalMatSharedPtr	v_TransformedSchurCompl (int offset, int bndoffset, const std::shared_ptr< DNekScalMat > &loc_mat)
	Get block elemental transposed transformation matrix \(\mathbf{R}^{T}\). More...
virtual void	v_InitObject ()
virtual void	v_DoPreconditioner (const Array< OneD, NekDouble > &pInput, Array< OneD, NekDouble > &pOutput, const bool &isLocal=false)
	Apply a preconditioner to the conjugate gradient method. More...
virtual void	v_DoPreconditionerWithNonVertOutput (const Array< OneD, NekDouble > &pInput, Array< OneD, NekDouble > &pOutput, const Array< OneD, NekDouble > &pNonVertOutput, Array< OneD, NekDouble > &pVertForce)
	Apply a preconditioner to the conjugate gradient method with an output for non-vertex degrees of freedom. More...
virtual void	v_DoTransformBasisToLowEnergy (Array< OneD, NekDouble > &pInOut)
	Transform from original basis to low energy basis. More...
virtual void	v_DoTransformCoeffsFromLowEnergy (Array< OneD, NekDouble > &pInOut)
	Transform from low energy coeffs to orignal basis. More...
virtual void	v_DoTransformCoeffsToLowEnergy (const Array< OneD, NekDouble > &pInput, Array< OneD, NekDouble > &pOutput)
	Multiply by the block inverse transformation matrix. More...
virtual void	v_DoTransformBasisFromLowEnergy (const Array< OneD, NekDouble > &pInput, Array< OneD, NekDouble > &pOutput)
	Multiply by the block transposed inverse transformation matrix. More...
virtual void	v_BuildPreconditioner ()

Private Attributes
int	m_niter

Static Private Attributes
static std::string	lookupIds []
static std::string	def

Additional Inherited Members
Protected Attributes inherited from Nektar::MultiRegions::PreconditionerDiagonal
Array< OneD, NekDouble >	m_diagonals
Protected Attributes inherited from Nektar::MultiRegions::Preconditioner
const std::weak_ptr< GlobalLinSys >	m_linsys
std::string	m_preconType
DNekMatSharedPtr	m_preconditioner
std::weak_ptr< AssemblyMap >	m_locToGloMap

Detailed Description

This class implements jacobi preconditioning building on diagonal version above

Definition at line 140 of file PreconditionerDiagonal.h.

Constructor & Destructor Documentation

PreconditionerJacobi()

Nektar::MultiRegions::PreconditionerJacobi::PreconditionerJacobi	(	const std::shared_ptr< GlobalLinSys > &	plinsys,
		const AssemblyMapSharedPtr &	pLocToGloMap
	)

Definition at line 269 of file PreconditionerDiagonal.cpp.

    : PreconditionerDiagonal(plinsys, pLocToGloMap)
{
}

~PreconditionerJacobi()

Nektar::MultiRegions::PreconditionerJacobi::~PreconditionerJacobi ( )

inlineoverride

Definition at line 164 of file PreconditionerDiagonal.h.

    {
    }

Member Function Documentation

create()

static PreconditionerSharedPtr Nektar::MultiRegions::PreconditionerJacobi::create ( const std::shared_ptr< GlobalLinSys > &  plinsys, const std::shared_ptr< AssemblyMap > &  pLocToGloMap  )

inlinestatic

Creates an instance of this class.

Definition at line 144 of file PreconditionerDiagonal.h.

    {
        PreconditionerSharedPtr p =
            MemoryManager<PreconditionerJacobi>::AllocateSharedPtr(
                plinsys, pLocToGloMap);
        p->InitObject();
        return p;
    }

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

v_BuildPreconditioner()

void Nektar::MultiRegions::PreconditionerJacobi::v_BuildPreconditioner ( )

overrideprotectedvirtual

Reimplemented from Nektar::MultiRegions::PreconditionerDiagonal.

Definition at line 280 of file PreconditionerDiagonal.cpp.

{
    PreconditionerDiagonal::v_BuildPreconditioner();
 
    auto expList = ((m_linsys.lock())->GetLocMat()).lock();
    std::shared_ptr<LibUtilities::SessionReader> session =
        expList->GetSession();
 
    std::string var = m_locToGloMap.lock()->GetVariable();
 
    if (session->DefinesGlobalSysSolnInfo(var, "JacobiIterations"))
    {
        m_niter = std::stoi(
            session->GetGlobalSysSolnInfo(var, "JacobiIterations").c_str());
    }
    else
    {
        m_niter = 3;
    }
}

References Nektar::MultiRegions::Preconditioner::m_linsys, Nektar::MultiRegions::Preconditioner::m_locToGloMap, m_niter, and Nektar::MultiRegions::PreconditionerDiagonal::v_BuildPreconditioner().

v_DoPreconditioner()

void Nektar::MultiRegions::PreconditionerJacobi::v_DoPreconditioner ( const Array< OneD, NekDouble > &  pInput, Array< OneD, NekDouble > &  pOutput, const bool &  isLocal = false  )

overrideprotectedvirtual

Apply a preconditioner to the conjugate gradient method.

Reimplemented from Nektar::MultiRegions::PreconditionerDiagonal.

Definition at line 304 of file PreconditionerDiagonal.cpp.

{
    auto asmMap = m_locToGloMap.lock();
 
    GlobalSysSolnType solvertype = asmMap->GetGlobalSysSolnType();
 
    int nGlobal = solvertype == eIterativeFull
                      ? asmMap->GetNumGlobalCoeffs()
                      : asmMap->GetNumGlobalBndCoeffs();
    int nDir    = asmMap->GetNumGlobalDirBndCoeffs();
    int nNonDir = nGlobal - nDir;
    Array<OneD, NekDouble> wk(nGlobal);
 
    if (IsLocal)
    {
        int nLocal = solvertype == eIterativeFull
                         ? asmMap->GetNumLocalCoeffs()
                         : asmMap->GetNumLocalBndCoeffs();
 
        Array<OneD, NekDouble> wk1(nLocal);
        asmMap->Assemble(pInput, wk);
        Vmath::Vmul(nNonDir, wk.data() + nDir, 1, m_diagonals.data(), 1,
                    wk.data() + nDir, 1);
        Vmath::Zero(nDir, wk, 1);
 
        for (int n = 1; n < m_niter; ++n)
        {
            asmMap->GlobalToLocal(wk, pOutput);
 
            // do Ax operator
            std::dynamic_pointer_cast<GlobalLinSysIterative>(m_linsys.lock())
                ->DoMatrixMultiply(pOutput, wk1);
 
            Vmath::Vsub(nLocal, pInput, 1, wk1, 1, wk1, 1);
 
            asmMap->Assemble(wk1, pOutput);
            Vmath::Vvtvp(nNonDir, pOutput.data() + nDir, 1, m_diagonals.data(),
                         1, wk.data() + nDir, 1, wk.data() + nDir, 1);
        }
 
        asmMap->GlobalToLocal(wk, pOutput);
    }
    else
    {
        Array<OneD, NekDouble> wk1(nGlobal);
        Vmath::Vmul(nNonDir, pInput.data(), 1, m_diagonals.data(), 1,
                    wk.data() + nDir, 1);
        Vmath::Zero(nDir, wk, 1);
 
        for (int n = 1; n < m_niter; ++n)
        {
            // do Ax operator
            std::dynamic_pointer_cast<GlobalLinSysIterative>(m_linsys.lock())
                ->DoMatrixMultiply(wk, wk1);
 
            // b - Ax
            Vmath::Vsub(nNonDir, pInput.data(), 1, wk1.data() + nDir, 1,
                        wk1.data() + nDir, 1);
 
            // new sol = 1/diag (b-Ax) + old sol
            Vmath::Vvtvp(nNonDir, wk1.data() + nDir, 1, m_diagonals.data(), 1,
                         wk.data() + nDir, 1, wk.data() + nDir, 1);
        }
 
        Vmath::Vcopy(nNonDir, wk.data() + nDir, 1, pOutput.data(), 1);
    }
}

References Nektar::MultiRegions::eIterativeFull, Nektar::MultiRegions::PreconditionerDiagonal::m_diagonals, Nektar::MultiRegions::Preconditioner::m_linsys, Nektar::MultiRegions::Preconditioner::m_locToGloMap, m_niter, Vmath::Vcopy(), Vmath::Vmul(), Vmath::Vsub(), Vmath::Vvtvp(), and Vmath::Zero().

v_InitObject()

void Nektar::MultiRegions::PreconditionerJacobi::v_InitObject ( )

overrideprotectedvirtual

Reimplemented from Nektar::MultiRegions::PreconditionerDiagonal.

Definition at line 276 of file PreconditionerDiagonal.cpp.

{
}

Member Data Documentation

className

string Nektar::MultiRegions::PreconditionerJacobi::className

static

Initial value:

=
    GetPreconFactory().RegisterCreatorFunction(
        "Jacobi", PreconditionerJacobi::create, "Jacobi Preconditioning")

Name of class.

Registers the class with the Factory.

Definition at line 156 of file PreconditionerDiagonal.h.

def

std::string Nektar::MultiRegions::PreconditionerJacobi::def

staticprivate

Definition at line 181 of file PreconditionerDiagonal.h.

lookupIds

std::string Nektar::MultiRegions::PreconditionerJacobi::lookupIds[]

staticprivate

Definition at line 180 of file PreconditionerDiagonal.h.

m_niter

int Nektar::MultiRegions::PreconditionerJacobi::m_niter

private

Definition at line 178 of file PreconditionerDiagonal.h.

Referenced by v_BuildPreconditioner(), and v_DoPreconditioner().