#include <PreconditionerLinearWithDiag.h>

Inheritance diagram for Nektar::MultiRegions::PreconditionerLinearWithDiag:

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

virtual	~PreconditionerLinearWithDiag ()

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)

void	DoPreconditionerWithNonVertOutput (const Array< OneD, NekDouble > &pInput, Array< OneD, NekDouble > &pOutput, const Array< OneD, NekDouble > &pNonVertOutput, Array< OneD, NekDouble > &pVertForce=NullNekDouble1DArray)

void	DoTransformToLowEnergy (Array< OneD, NekDouble > &pInOut, int offset)

void	DoTransformToLowEnergy (const Array< OneD, NekDouble > &pInput, Array< OneD, NekDouble > &pOutput)

void	DoTransformFromLowEnergy (Array< OneD, NekDouble > &pInOut)

void	DoMultiplybyInverseTransformationMatrix (const Array< OneD, NekDouble > &pInput, Array< OneD, NekDouble > &pOutput)

void	DoMultiplybyInverseTransposedTransformationMatrix (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 Attributes
PreconditionerSharedPtr	m_linSpacePrecon

PreconditionerSharedPtr	m_diagonalPrecon

Protected Attributes inherited from Nektar::MultiRegions::Preconditioner
const std::weak_ptr< GlobalLinSys >	m_linsys

PreconditionerType	m_preconType

DNekMatSharedPtr	m_preconditioner

std::weak_ptr< AssemblyMap >	m_locToGloMap

LibUtilities::CommSharedPtr	m_comm

Private Member Functions
virtual void	v_InitObject ()

virtual void	v_DoPreconditioner (const Array< OneD, NekDouble > &pInput, Array< OneD, NekDouble > &pOutput)
	Apply a preconditioner to the conjugate gradient method. More...

virtual void	v_BuildPreconditioner ()

Additional Inherited Members
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...

Detailed Description

This class implements preconditioning for the conjugate gradient matrix solver.

Definition at line 50 of file PreconditionerLinearWithDiag.h.

Constructor & Destructor Documentation

◆ PreconditionerLinearWithDiag()

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

Definition at line 64 of file PreconditionerLinearWithDiag.cpp.

             : Preconditioner(plinsys, pLocToGloMap)
         {
         }

◆ ~PreconditionerLinearWithDiag()

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

inlinevirtual

Definition at line 72 of file PreconditionerLinearWithDiag.h.

72 {}

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 54 of file PreconditionerLinearWithDiag.h.

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

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

◆ v_BuildPreconditioner()

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

privatevirtual

Reimplemented from Nektar::MultiRegions::Preconditioner.

Definition at line 83 of file PreconditionerLinearWithDiag.cpp.

References m_diagonalPrecon, and m_linSpacePrecon.

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

◆ v_DoPreconditioner()

void Nektar::MultiRegions::PreconditionerLinearWithDiag::v_DoPreconditioner	(	const Array< OneD, NekDouble > &	pInput,
		Array< OneD, NekDouble > &	pOutput
	)

privatevirtual

Apply a preconditioner to the conjugate gradient method.

Reimplemented from Nektar::MultiRegions::Preconditioner.

Definition at line 93 of file PreconditionerLinearWithDiag.cpp.

References m_diagonalPrecon, and m_linSpacePrecon.

         {
             
             Array<OneD, NekDouble> OutputDiag(pOutput.num_elements());
             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);
         }

◆ v_InitObject()

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

privatevirtual

Reimplemented from Nektar::MultiRegions::Preconditioner.

Definition at line 74 of file PreconditionerLinearWithDiag.cpp.

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.

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

Member Data Documentation

◆ className

string Nektar::MultiRegions::PreconditionerLinearWithDiag::className

static

Initial value:

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

Name of class.

Registers the class with the Factory.

Definition at line 65 of file PreconditionerLinearWithDiag.h.