#include <PreconditionerLinearWithBlock.h>

Inheritance diagram for Nektar::MultiRegions::PreconditionerLinearWithBlock:

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

virtual	~PreconditionerLinearWithBlock ()

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	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
virtual void	v_InitObject () override

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

virtual 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_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...

Protected Attributes
PreconditionerSharedPtr	m_linSpacePrecon

PreconditionerSharedPtr	m_blockPrecon

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

Detailed Description

This class implements preconditioning for the conjugate gradient matrix solver.

Definition at line 49 of file PreconditionerLinearWithBlock.h.

Constructor & Destructor Documentation

◆ PreconditionerLinearWithBlock()

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

Definition at line 63 of file PreconditionerLinearWithBlock.cpp.

     : Preconditioner(plinsys, pLocToGloMap)
 {
 }

◆ ~PreconditionerLinearWithBlock()

virtual Nektar::MultiRegions::PreconditionerLinearWithBlock::~PreconditionerLinearWithBlock ( )

inlinevirtual

Definition at line 72 of file PreconditionerLinearWithBlock.h.

73 {

74 }

Member Function Documentation

◆ create()

static PreconditionerSharedPtr Nektar::MultiRegions::PreconditionerLinearWithBlock::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 PreconditionerLinearWithBlock.h.

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

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

◆ v_BuildPreconditioner()

void Nektar::MultiRegions::PreconditionerLinearWithBlock::v_BuildPreconditioner ( )

overrideprotectedvirtual

Reimplemented from Nektar::MultiRegions::Preconditioner.

Definition at line 84 of file PreconditionerLinearWithBlock.cpp.

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

References m_blockPrecon, and m_linSpacePrecon.

◆ v_DoPreconditioner()

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

overrideprotectedvirtual

Apply a preconditioner to the conjugate gradient method.

Reimplemented from Nektar::MultiRegions::Preconditioner.

Definition at line 93 of file PreconditionerLinearWithBlock.cpp.

 {
     int nGlobal = pInput.size();
  
     Array<OneD, NekDouble> OutputBlock(nGlobal, 0.0);
     Array<OneD, NekDouble> OutputLinear(nGlobal, 0.0);
     Array<OneD, NekDouble> InputLinear(nGlobal, 0.0);
  
     // Apply Low Energy preconditioner
     m_blockPrecon->DoPreconditioner(pInput, OutputBlock);
  
     // Apply linear space preconditioner
     m_linSpacePrecon->DoPreconditionerWithNonVertOutput(pInput, pOutput,
                                                         OutputBlock);
 }

References m_blockPrecon, and m_linSpacePrecon.

◆ v_InitObject()

void Nektar::MultiRegions::PreconditionerLinearWithBlock::v_InitObject ( )

overrideprotectedvirtual

Reimplemented from Nektar::MultiRegions::Preconditioner.

Definition at line 73 of file PreconditionerLinearWithBlock.cpp.

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

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

Member Data Documentation

◆ className

string Nektar::MultiRegions::PreconditionerLinearWithBlock::className

static

Initial value:

=
    GetPreconFactory().RegisterCreatorFunction(
        "FullLinearSpaceWithBlock", PreconditionerLinearWithBlock::create,
        "Full Linear space and block preconditioning")