Nektar::MultiRegions::PreconditionerLinearWithLowEnergy Class Reference

#include <PreconditionerLinearWithLowEnergy.h>

Inheritance diagram for Nektar::MultiRegions::PreconditionerLinearWithLowEnergy:

Public Member Functions
	PreconditionerLinearWithLowEnergy (const std::shared_ptr< GlobalLinSys > &plinsys, const AssemblyMapSharedPtr &pLocToGloMap)
	~PreconditionerLinearWithLowEnergy () 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_DoTransformBasisToLowEnergy (Array< OneD, NekDouble > &pInOut) override
	Transform from original basis to low energy basis. More...
void	v_DoTransformCoeffsFromLowEnergy (Array< OneD, NekDouble > &pInOut) override
	Transform from low energy coeffs to orignal basis. More...
void	v_DoTransformCoeffsToLowEnergy (const Array< OneD, NekDouble > &pInput, Array< OneD, NekDouble > &pOutput) override
	Multiply by the block inverse transformation matrix. More...
void	v_DoTransformBasisFromLowEnergy (const Array< OneD, NekDouble > &pInput, Array< OneD, NekDouble > &pOutput) override
	Multiply by the block transposed inverse transformation matrix. More...
DNekScalMatSharedPtr	v_TransformedSchurCompl (int n, int offset, const std::shared_ptr< DNekScalMat > &loc_mat) override
	Get block elemental transposed transformation matrix \(\mathbf{R}^{T}\). More...
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_lowEnergyPrecon
Array< OneD, NekDouble >	m_invMultiplicity
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
LibUtilities::CommSharedPtr	m_comm

Detailed Description

This class implements preconditioning for the conjugate gradient matrix solver.

Definition at line 47 of file PreconditionerLinearWithLowEnergy.h.

Constructor & Destructor Documentation

PreconditionerLinearWithLowEnergy()

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

Definition at line 62 of file PreconditionerLinearWithLowEnergy.cpp.

    : Preconditioner(plinsys, pLocToGloMap)
{
}

~PreconditionerLinearWithLowEnergy()

Nektar::MultiRegions::PreconditionerLinearWithLowEnergy::~PreconditionerLinearWithLowEnergy ( )

inlineoverride

Definition at line 70 of file PreconditionerLinearWithLowEnergy.h.

    {
    }

Member Function Documentation

create()

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

inlinestatic

Creates an instance of this class.

Definition at line 51 of file PreconditionerLinearWithLowEnergy.h.

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

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

v_BuildPreconditioner()

void Nektar::MultiRegions::PreconditionerLinearWithLowEnergy::v_BuildPreconditioner ( )

overrideprotectedvirtual

Reimplemented from Nektar::MultiRegions::Preconditioner.

Definition at line 142 of file PreconditionerLinearWithLowEnergy.cpp.

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

References m_linSpacePrecon, and m_lowEnergyPrecon.

v_DoPreconditioner()

void Nektar::MultiRegions::PreconditionerLinearWithLowEnergy::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 151 of file PreconditionerLinearWithLowEnergy.cpp.

{
    ASSERTL0(isLocal == false, "PreconditionerLinearWithLowEnergy"
                               " is only set up for Global iteratives sovles");
    int nDirBndDofs = m_locToGloMap.lock()->GetNumGlobalDirBndCoeffs();
    int nGlobHomBndDofs =
        m_locToGloMap.lock()->GetNumGlobalBndCoeffs() - nDirBndDofs;
    int nLocBndDofs = m_locToGloMap.lock()->GetNumLocalBndCoeffs();
 
    Array<OneD, NekDouble> tmp(nGlobHomBndDofs, 0.0);
 
    Array<OneD, NekDouble> InputLinear(nGlobHomBndDofs);
    Array<OneD, NekDouble> OutputLowEnergy(nGlobHomBndDofs);
    Array<OneD, NekDouble> OutputLinear(nGlobHomBndDofs);
    Array<OneD, NekDouble> local(nLocBndDofs);
 
    // Transform input from low energy to original basis
    Vmath::Vmul(nGlobHomBndDofs, m_invMultiplicity, 1, pInput, 1, OutputLinear,
                1);
    m_locToGloMap.lock()->GlobalToLocalBnd(OutputLinear, local, nDirBndDofs);
    m_lowEnergyPrecon->DoTransformBasisFromLowEnergy(local, local);
    m_locToGloMap.lock()->AssembleBnd(local, InputLinear, nDirBndDofs);
 
    // Apply linear space preconditioner
    m_linSpacePrecon->DoPreconditionerWithNonVertOutput(InputLinear,
                                                        OutputLinear, tmp);
 
    // transform coefficients back to low energy space
    m_locToGloMap.lock()->GlobalToLocalBnd(OutputLinear, local, nDirBndDofs);
    m_lowEnergyPrecon->DoTransformCoeffsToLowEnergy(local, local);
    m_locToGloMap.lock()->LocalBndToGlobal(local, pOutput, nDirBndDofs, false);
 
    // Apply Low Energy preconditioner
    m_lowEnergyPrecon->DoPreconditioner(pInput, OutputLowEnergy);
 
    ASSERTL1(pOutput.size() >= nGlobHomBndDofs, "Output array is not correct");
    Vmath::Vadd(nGlobHomBndDofs, pOutput, 1, OutputLowEnergy, 1, pOutput, 1);
}

References ASSERTL0, ASSERTL1, m_invMultiplicity, m_linSpacePrecon, Nektar::MultiRegions::Preconditioner::m_locToGloMap, m_lowEnergyPrecon, Vmath::Vadd(), and Vmath::Vmul().

v_DoTransformBasisFromLowEnergy()

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

overrideprotectedvirtual

Multiply by the block transposed inverse transformation matrix.

Reimplemented from Nektar::MultiRegions::Preconditioner.

Definition at line 125 of file PreconditionerLinearWithLowEnergy.cpp.

{
    m_lowEnergyPrecon->DoTransformBasisFromLowEnergy(pInput, pOutput);
}

References m_lowEnergyPrecon.

v_DoTransformBasisToLowEnergy()

void Nektar::MultiRegions::PreconditionerLinearWithLowEnergy::v_DoTransformBasisToLowEnergy ( Array< OneD, NekDouble > &  pInOut )

overrideprotectedvirtual

Transform from original basis to low energy basis.

Reimplemented from Nektar::MultiRegions::Preconditioner.

Definition at line 98 of file PreconditionerLinearWithLowEnergy.cpp.

{
    m_lowEnergyPrecon->DoTransformBasisToLowEnergy(pInOut);
}

References m_lowEnergyPrecon.

v_DoTransformCoeffsFromLowEnergy()

void Nektar::MultiRegions::PreconditionerLinearWithLowEnergy::v_DoTransformCoeffsFromLowEnergy ( Array< OneD, NekDouble > &  pInOut )

overrideprotectedvirtual

Transform from low energy coeffs to orignal basis.

Reimplemented from Nektar::MultiRegions::Preconditioner.

Definition at line 107 of file PreconditionerLinearWithLowEnergy.cpp.

{
    m_lowEnergyPrecon->DoTransformCoeffsFromLowEnergy(pInput);
}

References m_lowEnergyPrecon.

v_DoTransformCoeffsToLowEnergy()

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

overrideprotectedvirtual

Multiply by the block inverse transformation matrix.

Reimplemented from Nektar::MultiRegions::Preconditioner.

Definition at line 116 of file PreconditionerLinearWithLowEnergy.cpp.

{
    m_lowEnergyPrecon->DoTransformCoeffsToLowEnergy(pInput, pOutput);
}

References m_lowEnergyPrecon.

v_InitObject()

void Nektar::MultiRegions::PreconditionerLinearWithLowEnergy::v_InitObject ( )

overrideprotectedvirtual

Reimplemented from Nektar::MultiRegions::Preconditioner.

Definition at line 72 of file PreconditionerLinearWithLowEnergy.cpp.

{
    m_linSpacePrecon = GetPreconFactory().CreateInstance(
        "FullLinearSpace", m_linsys.lock(), m_locToGloMap.lock());
    m_lowEnergyPrecon = GetPreconFactory().CreateInstance(
        "LowEnergyBlock", m_linsys.lock(), m_locToGloMap.lock());
 
    // Set up multiplicity array for inverse transposed transformation matrix
    int nDirBnd     = m_locToGloMap.lock()->GetNumGlobalDirBndCoeffs();
    int nGlobHomBnd = m_locToGloMap.lock()->GetNumGlobalBndCoeffs() - nDirBnd;
    int nLocBnd     = m_locToGloMap.lock()->GetNumLocalBndCoeffs();
 
    m_invMultiplicity = Array<OneD, NekDouble>(nGlobHomBnd, 1.0);
    Array<OneD, NekDouble> loc(nLocBnd);
 
    // need to scatter from global array to handle sign changes
    m_locToGloMap.lock()->GlobalToLocalBnd(m_invMultiplicity, loc, nDirBnd);
 
    // Now assemble values back together to get multiplicity
    m_locToGloMap.lock()->AssembleBnd(loc, m_invMultiplicity, nDirBnd);
    Vmath::Sdiv(nGlobHomBnd, 1.0, m_invMultiplicity, 1, m_invMultiplicity, 1);
}

References Nektar::LibUtilities::NekFactory< tKey, tBase, tParam >::CreateInstance(), Nektar::MultiRegions::GetPreconFactory(), CG_Iterations::loc, m_invMultiplicity, m_linSpacePrecon, Nektar::MultiRegions::Preconditioner::m_linsys, Nektar::MultiRegions::Preconditioner::m_locToGloMap, m_lowEnergyPrecon, and Vmath::Sdiv().

v_TransformedSchurCompl()

DNekScalMatSharedPtr Nektar::MultiRegions::PreconditionerLinearWithLowEnergy::v_TransformedSchurCompl ( int  offset, int  bndoffset, const std::shared_ptr< DNekScalMat > &  loc_mat  )

overrideprotectedvirtual

Get block elemental transposed transformation matrix \(\mathbf{R}^{T}\).

Reimplemented from Nektar::MultiRegions::Preconditioner.

Definition at line 131 of file PreconditionerLinearWithLowEnergy.cpp.

{
    DNekScalMatSharedPtr returnval;
    returnval = m_lowEnergyPrecon->TransformedSchurCompl(n, offset, loc_mat);
    return returnval;
}

References m_lowEnergyPrecon.

Member Data Documentation

className

string Nektar::MultiRegions::PreconditionerLinearWithLowEnergy::className

static

Initial value:

=
    GetPreconFactory().RegisterCreatorFunction(
        "FullLinearSpaceWithLowEnergyBlock",
        PreconditionerLinearWithLowEnergy::create,
        "Full Linear space and low energy block preconditioning")

Name of class.

Registers the class with the Factory.

Definition at line 63 of file PreconditionerLinearWithLowEnergy.h.

m_invMultiplicity

Array<OneD, NekDouble> Nektar::MultiRegions::PreconditionerLinearWithLowEnergy::m_invMultiplicity

protected

Definition at line 78 of file PreconditionerLinearWithLowEnergy.h.

Referenced by v_DoPreconditioner(), and v_InitObject().

m_linSpacePrecon

PreconditionerSharedPtr Nektar::MultiRegions::PreconditionerLinearWithLowEnergy::m_linSpacePrecon

protected

Definition at line 75 of file PreconditionerLinearWithLowEnergy.h.

Referenced by v_BuildPreconditioner(), v_DoPreconditioner(), and v_InitObject().

m_lowEnergyPrecon

PreconditionerSharedPtr Nektar::MultiRegions::PreconditionerLinearWithLowEnergy::m_lowEnergyPrecon

protected

Definition at line 76 of file PreconditionerLinearWithLowEnergy.h.

Referenced by v_BuildPreconditioner(), v_DoPreconditioner(), v_DoTransformBasisFromLowEnergy(), v_DoTransformBasisToLowEnergy(), v_DoTransformCoeffsFromLowEnergy(), v_DoTransformCoeffsToLowEnergy(), v_InitObject(), and v_TransformedSchurCompl().