MsRSB level builder for single-physics problems. More...

#include <MsrsbLevelBuilder.hpp>

Inheritance diagram for geos::multiscale::MsrsbLevelBuilder< LAI >:

Public Types
using	Base = MsrsbLevelBuilderBase< LAI >
	Alias for base type.

using	Vector = typename Base::Vector
	Alias for vector type.

using	Matrix = typename Base::Matrix
	Alias for matrix type.

Public Types inherited from geos::multiscale::MsrsbLevelBuilderBase< LAI >
using	Base = LevelBuilderBase< LAI >
	Alias for base type.

using	Vector = typename Base::Vector
	Alias for vector type.

using	Matrix = typename Base::Matrix
	Alias for matrix type.

using	Operator = typename Base::Operator
	Alias for operator type.

Public Types inherited from geos::multiscale::LevelBuilderBase< LAI >
using	Vector = typename LAI::ParallelVector
	Alias for vector type.

using	Matrix = typename LAI::ParallelMatrix
	Alias for matrix type.

using	Operator = LinearOperator< Vector >
	Alias for operator type.

Public Member Functions
	MsrsbLevelBuilder (string name, LinearSolverParameters params)
	Constructor. More...

virtual void	initializeFineLevel (DomainPartition &domain, geos::DofManager const &dofManager, MPI_Comm const &comm) override
	Initialize the finest level (level 0). More...

virtual void	initializeCoarseLevel (LevelBuilderBase< LAI > &fineLevel, Matrix const &fineMatrix) override
	Initialize a coarse level (levels 1 and above). More...

multiscale::MeshLevel &	mesh ()

multiscale::MeshLevel const &	mesh () const

multiscale::MeshObjectManager &	manager ()

multiscale::MeshObjectManager const &	manager () const

integer	numComp () const

virtual bool	updateProlongation (Matrix const &fineMatrix) override
	Update current level's prolongation using a new previous level matrix. More...

virtual std::unique_ptr< PreconditionerBase< LAI > >	makeCoarseSolver () const override
	Instantiate coarsest level solver. More...

Public Member Functions inherited from geos::multiscale::MsrsbLevelBuilderBase< LAI >
	MsrsbLevelBuilderBase (string name, LinearSolverParameters params)
	Constructor. More...

virtual Matrix const &	prolongation () const override

virtual Operator const &	restriction () const override

virtual Matrix const &	matrix () const override

virtual PreconditionerBase< LAI > const *	presmoother () const override

PreconditionerBase< LAI > *	presmoother ()

virtual PreconditionerBase< LAI > const *	postsmoother () const override

PreconditionerBase< LAI > *	postsmoother ()

multiscale::DofManager &	dofManager ()

multiscale::DofManager const &	dofManager () const

virtual void	compute (Matrix const &fineMatrix) override
	Compute the current level. More...

Public Member Functions inherited from geos::multiscale::LevelBuilderBase< LAI >
	LevelBuilderBase (string name, LinearSolverParameters params)
	Constructor. More...

virtual	~LevelBuilderBase ()=default
	Destructor.

Additional Inherited Members
Static Public Member Functions inherited from geos::multiscale::LevelBuilderBase< LAI >
static std::unique_ptr< LevelBuilderBase< LAI > >	create (string name, LinearSolverParameters params)
	Factory interface to create level instances. More...

Protected Attributes inherited from geos::multiscale::MsrsbLevelBuilderBase< LAI >
MsrsbLevelBuilderBase const *	m_fineLevel {}
	Pointer to the fine level.

Matrix	m_prolongation
	Prolongation matrix P.

std::unique_ptr< Operator >	m_restriction
	Restriction (kept as abstract operator to allow for memory efficiency, e.g. when R = P^T)

Matrix	m_matrix
	Level operator matrix.

multiscale::DofManager	m_dofManager
	DofManager for the matrix.

std::unique_ptr< PreconditionerBase< LAI > >	m_preSmoother
	Pre-smoothing operator.

std::unique_ptr< PreconditionerBase< LAI > >	m_postSmoother
	Post-smoothing operator.

LinearSolverParameters	m_params
	Linear solver top-level parameters.

string	m_name
	Level name (label)

Protected Attributes inherited from geos::multiscale::LevelBuilderBase< LAI >
string	m_name
	Level name (label)

LinearSolverParameters	m_params
	Linear solver top-level parameters.

Detailed Description

template<typename LAI>
class geos::multiscale::MsrsbLevelBuilder< LAI >

MsRSB level builder for single-physics problems.

Template Parameters

LAI	linear algebra interface type

Definition at line 37 of file MsrsbLevelBuilder.hpp.

Constructor & Destructor Documentation

◆ MsrsbLevelBuilder()

template<typename LAI >

geos::multiscale::MsrsbLevelBuilder< LAI >::MsrsbLevelBuilder	(	string	name,
		LinearSolverParameters	params
	)

explicit

Constructor.

Parameters

name	level name
params	linear solver parameters

Member Function Documentation

◆ initializeCoarseLevel()

template<typename LAI >

virtual void geos::multiscale::MsrsbLevelBuilder< LAI >::initializeCoarseLevel	(	LevelBuilderBase< LAI > &	fineLevel,
		Matrix const &	fineMatrix
	)

overridevirtual

Initialize a coarse level (levels 1 and above).

Parameters

fineLevel	the previous (fine) level
fineMatrix	the previous (fine) level system matrix

Implements geos::multiscale::LevelBuilderBase< LAI >.

◆ initializeFineLevel()

template<typename LAI >

virtual void geos::multiscale::MsrsbLevelBuilder< LAI >::initializeFineLevel	(	DomainPartition &	domain,
		geos::DofManager const &	dofManager,
		MPI_Comm const &	comm
	)

overridevirtual

Initialize the finest level (level 0).

Parameters

domain	the physical domain object
dofManager	the source DofManager
comm	MPI communicator

Implements geos::multiscale::LevelBuilderBase< LAI >.

◆ makeCoarseSolver()

template<typename LAI >

virtual std::unique_ptr< PreconditionerBase< LAI > > geos::multiscale::MsrsbLevelBuilder< LAI >::makeCoarseSolver ( ) const

overridevirtual

Instantiate coarsest level solver.

Returns: owning pointer to the solver

Implements geos::multiscale::LevelBuilderBase< LAI >.

◆ manager() [1/2]

template<typename LAI >

multiscale::MeshObjectManager& geos::multiscale::MsrsbLevelBuilder< LAI >::manager ( )

inline

Returns: the mesh object manager corresponding to the type of dof being solved for (nodal or cell-centered)

Definition at line 88 of file MsrsbLevelBuilder.hpp.

◆ manager() [2/2]

template<typename LAI >

multiscale::MeshObjectManager const& geos::multiscale::MsrsbLevelBuilder< LAI >::manager ( ) const

inline

Returns: the mesh object manager corresponding to the type of dof being solved for (nodal or cell-centered)

Definition at line 96 of file MsrsbLevelBuilder.hpp.

◆ mesh() [1/2]

template<typename LAI >

multiscale::MeshLevel& geos::multiscale::MsrsbLevelBuilder< LAI >::mesh ( )

inline

Returns: the constructed multiscale mesh level

Definition at line 78 of file MsrsbLevelBuilder.hpp.

◆ mesh() [2/2]

template<typename LAI >

multiscale::MeshLevel const& geos::multiscale::MsrsbLevelBuilder< LAI >::mesh ( ) const

inline

Returns: the constructed multiscale mesh level

Definition at line 83 of file MsrsbLevelBuilder.hpp.

◆ numComp()

template<typename LAI >

integer geos::multiscale::MsrsbLevelBuilder< LAI >::numComp ( ) const

inline

Returns: the number of dof components solved for

Definition at line 104 of file MsrsbLevelBuilder.hpp.

◆ updateProlongation()

template<typename LAI >

virtual bool geos::multiscale::MsrsbLevelBuilder< LAI >::updateProlongation ( Matrix const & fineMatrix )

overridevirtual

Update current level's prolongation using a new previous level matrix.

Parameters

fineMatrix the previous level matrix

Returns: whether an update was actually performed (it may not be when the change is below threshold)

Implements geos::multiscale::MsrsbLevelBuilderBase< LAI >.

The documentation for this class was generated from the following file:

coreComponents/linearAlgebra/multiscale/msrsb/MsrsbLevelBuilder.hpp

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

template<typename LAI> class geos::multiscale::MsrsbLevelBuilder< LAI >

Constructor & Destructor Documentation

◆ MsrsbLevelBuilder()

Member Function Documentation

◆ initializeCoarseLevel()

◆ initializeFineLevel()

◆ makeCoarseSolver()

◆ manager() [1/2]

◆ manager() [2/2]

◆ mesh() [1/2]

◆ mesh() [2/2]

◆ numComp()

◆ updateProlongation()

template<typename LAI>
class geos::multiscale::MsrsbLevelBuilder< LAI >