#include <PreconditionerLinearWithDiag.h>

Inheritance diagram for Nektar::MultiRegions::PreconditionerLinearWithDiag:

Public Member Functions
	PreconditionerLinearWithDiag (const std::shared_ptr< GlobalLinSys > &plinsys, const AssemblyMapSharedPtr &pLocToGloMap)

	~PreconditionerLinearWithDiag () 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 Attributes
static std::string	className
	Name of class. More...

Protected Member Functions
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 ()

Protected Attributes
PreconditionerSharedPtr	m_linSpacePrecon

PreconditionerSharedPtr	m_diagonalPrecon

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 preconditioning for the conjugate gradient matrix solver.

Definition at line 49 of file PreconditionerLinearWithDiag.h.

Constructor & Destructor Documentation

◆ PreconditionerLinearWithDiag()

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

Definition at line 60 of file PreconditionerLinearWithDiag.cpp.

    : Preconditioner(plinsys, pLocToGloMap)
{
}

◆ ~PreconditionerLinearWithDiag()

Nektar::MultiRegions::PreconditionerLinearWithDiag::~PreconditionerLinearWithDiag ( )

inlineoverride

Definition at line 72 of file PreconditionerLinearWithDiag.h.

73 {

74 }

Member Function Documentation

◆ create()

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

inlinestatic

Creates an instance of this class.

Definition at line 53 of file PreconditionerLinearWithDiag.h.

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

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

◆ v_BuildPreconditioner()

void Nektar::MultiRegions::PreconditionerLinearWithDiag::v_BuildPreconditioner ( )

overrideprotectedvirtual

Reimplemented from Nektar::MultiRegions::Preconditioner.

Definition at line 81 of file PreconditionerLinearWithDiag.cpp.

{
    m_linSpacePrecon->BuildPreconditioner();
    m_diagonalPrecon->BuildPreconditioner();
}

References m_diagonalPrecon, and m_linSpacePrecon.

◆ v_DoPreconditioner()

void Nektar::MultiRegions::PreconditionerLinearWithDiag::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::Preconditioner.

Definition at line 90 of file PreconditionerLinearWithDiag.cpp.

{
    ASSERTL0(isLocal == false, "PreconditionerLinearWithDiag is only set up "
                               "for Global iteratives sovles");
    Array<OneD, NekDouble> OutputDiag(pOutput.size());
    m_diagonalPrecon->DoPreconditioner(pInput, OutputDiag);
 
    // Since linear preconditioner just copies other entries
    // this will only modify the linear space degrees of
    // freedom
    m_linSpacePrecon->DoPreconditionerWithNonVertOutput(pInput, pOutput,
                                                        OutputDiag);
}

References ASSERTL0, m_diagonalPrecon, and m_linSpacePrecon.

◆ v_InitObject()

void Nektar::MultiRegions::PreconditionerLinearWithDiag::v_InitObject ( )

overrideprotectedvirtual

Reimplemented from Nektar::MultiRegions::Preconditioner.

Definition at line 70 of file PreconditionerLinearWithDiag.cpp.

{
    m_linSpacePrecon = GetPreconFactory().CreateInstance(
        "FullLinearSpace", m_linsys.lock(), m_locToGloMap.lock());
    m_diagonalPrecon = GetPreconFactory().CreateInstance(
        "Diagonal", m_linsys.lock(), m_locToGloMap.lock());
}

References Nektar::LibUtilities::NekFactory< tKey, tBase, tParam >::CreateInstance(), Nektar::MultiRegions::GetPreconFactory(), m_diagonalPrecon, m_linSpacePrecon, Nektar::MultiRegions::Preconditioner::m_linsys, and Nektar::MultiRegions::Preconditioner::m_locToGloMap.

Member Data Documentation

◆ className

string Nektar::MultiRegions::PreconditionerLinearWithDiag::className

static

Initial value:

=
    GetPreconFactory().RegisterCreatorFunction(
        "FullLinearSpaceWithDiagonal", PreconditionerLinearWithDiag::create,
        "Full linear space and diagonal preconditioning")