Nektar::MultiRegions::PreconditionerNull Class Reference

#include <PreconditionerDiagonal.h>

Inheritance diagram for Nektar::MultiRegions::PreconditionerNull:

Public Member Functions
	PreconditionerNull (const std::shared_ptr< GlobalLinSys > &plinsys, const AssemblyMapSharedPtr &pLocToGloMap)
virtual	~PreconditionerNull ()
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
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...

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

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

Definition at line 98 of file PreconditionerDiagonal.h.

Constructor & Destructor Documentation

PreconditionerNull()

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

Definition at line 212 of file PreconditionerDiagonal.cpp.

    : Preconditioner(plinsys, pLocToGloMap)
{
}

~PreconditionerNull()

virtual Nektar::MultiRegions::PreconditionerNull::~PreconditionerNull ( )

inlinevirtual

Definition at line 121 of file PreconditionerDiagonal.h.

    {
    }

Member Function Documentation

create()

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

inlinestatic

Creates an instance of this class.

Definition at line 102 of file PreconditionerDiagonal.h.

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

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

v_BuildPreconditioner()

void Nektar::MultiRegions::PreconditionerNull::v_BuildPreconditioner ( )

overridevirtual

Reimplemented from Nektar::MultiRegions::Preconditioner.

Definition at line 229 of file PreconditionerDiagonal.cpp.

{
}

v_DoPreconditioner()

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

overridevirtual

Apply a preconditioner to the conjugate gradient method.

Reimplemented from Nektar::MultiRegions::Preconditioner.

Definition at line 236 of file PreconditionerDiagonal.cpp.

{
    Vmath::Vcopy(pInput.size(), pInput, 1, pOutput, 1);
}

References Vmath::Vcopy().

v_InitObject()

void Nektar::MultiRegions::PreconditionerNull::v_InitObject ( )

overridevirtual

Reimplemented from Nektar::MultiRegions::Preconditioner.

Definition at line 222 of file PreconditionerDiagonal.cpp.

{
}

Member Data Documentation

className

string Nektar::MultiRegions::PreconditionerNull::className

static

Initial value:

=
    GetPreconFactory().RegisterCreatorFunction(
        "Null", PreconditionerNull::create, "No Preconditioning")

Name of class.

Definition at line 114 of file PreconditionerDiagonal.h.

def

std::string Nektar::MultiRegions::PreconditionerNull::def

staticprivate

Definition at line 134 of file PreconditionerDiagonal.h.

lookupIds

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

staticprivate

Definition at line 133 of file PreconditionerDiagonal.h.