Wrapper for Trilinos-Amesos2 Direct Solvers. More...

#include <amesos2_solver.h>

Inheritance diagram for Kratos::Amesos2Solver< TSparseSpaceType, TDenseSpaceType, TReordererType >:

Collaboration diagram for Kratos::Amesos2Solver< TSparseSpaceType, TDenseSpaceType, TReordererType >:

Public Member Functions
Life Cycle
	Amesos2Solver (Parameters settings)
	Constructor with Parameters. More...

	Amesos2Solver (const std::string &SolverName, Teuchos::ParameterList &rParameterList)
	Constructor with solver-name and Teuchos::ParameterList. More...

	Amesos2Solver (const Amesos2Solver &Other)=delete
	Copy constructor. More...

	~Amesos2Solver () override=default
	Destructor. More...

Operators
Amesos2Solver &	operator= (const Amesos2Solver &Other)=delete
	Assignment operator. More...

Operations
bool	Solve (SparseMatrixType &rA, VectorType &rX, VectorType &rB) override

bool	Solve (SparseMatrixType &rA, DenseMatrixType &rX, DenseMatrixType &rB) override

Input and output
void	PrintInfo (std::ostream &rOStream) const override
	Print information about this object. More...

Public Member Functions inherited from Kratos::LinearSolver< TSparseSpaceType, TDenseSpaceType, Reorderer< TSparseSpaceType, TDenseSpaceType > >
	LinearSolver ()
	Default constructor. More...

	LinearSolver (Reorderer< TSparseSpaceType, TDenseSpaceType > NewReorderer)
	Constructor with specific reorderer. More...

	LinearSolver (const LinearSolver &Other)
	Copy constructor. More...

virtual	~LinearSolver ()
	Destructor. More...

LinearSolver &	operator= (const LinearSolver &Other)
	Assignment operator. More...

virtual void	Initialize (SparseMatrixType &rA, VectorType &rX, VectorType &rB)

virtual void	InitializeSolutionStep (SparseMatrixType &rA, VectorType &rX, VectorType &rB)

virtual void	PerformSolutionStep (SparseMatrixType &rA, VectorType &rX, VectorType &rB)

virtual void	FinalizeSolutionStep (SparseMatrixType &rA, VectorType &rX, VectorType &rB)

virtual void	Clear ()

virtual void	Solve (SparseMatrixType &K, SparseMatrixType &M, DenseVectorType &Eigenvalues, DenseMatrixType &Eigenvectors)

virtual bool	AdditionalPhysicalDataIsNeeded ()

virtual void	ProvideAdditionalData (SparseMatrixType &rA, VectorType &rX, VectorType &rB, typename ModelPart::DofsArrayType &rDoFSet, ModelPart &rModelPart)

virtual TReordererType::Pointer	GetReorderer ()

virtual void	SetReorderer (typename TReordererType::Pointer pNewReorderer)

virtual void	SetTolerance (double NewTolerance)
	This method allows to set the tolerance in the linear solver. More...

virtual double	GetTolerance ()
	This method allows to get the tolerance in the linear solver. More...

virtual IndexType	GetIterationsNumber ()

virtual bool	IsConsistent (SparseMatrixType &rA, VectorType &rX, VectorType &rB)
	This method checks if the dimensions of the system of equations are consistent. More...

virtual bool	IsConsistent (SparseMatrixType &rA, DenseMatrixType &rX, DenseMatrixType &rB)
	This method checks if the dimensions of the system of equations are consistent (dense matrix for RHS and unknowns version) More...

virtual bool	IsNotConsistent (SparseMatrixType &rA, VectorType &rX, VectorType &rB)
	This method checks if the dimensions of the system of equations are not consistent. More...

virtual bool	IsNotConsistent (SparseMatrixType &rA, DenseMatrixType &rX, DenseMatrixType &rB)
	This method checks if the dimensions of the system of equations are not consistent. More...

virtual std::string	Info () const
	Turn back information as a string. More...

virtual void	PrintData (std::ostream &rOStream) const
	Print object's data. More...

	KRATOS_CLASS_POINTER_DEFINITION (LinearSolver)
	Pointer definition of LinearSolver. More...

Static Public Member Functions
Inquiry
static bool	HasSolver (const std::string &rAmesosSolverName)

Type Definitions
typedef TSparseSpaceType::MatrixType	SparseMatrixType

typedef TSparseSpaceType::VectorType	VectorType

typedef TDenseSpaceType::MatrixType	DenseMatrixType

	KRATOS_CLASS_POINTER_DEFINITION (Amesos2Solver)
	Pointer definition of Amesos2Solver. More...

Additional Inherited Members
Public Types inherited from Kratos::LinearSolver< TSparseSpaceType, TDenseSpaceType, Reorderer< TSparseSpaceType, TDenseSpaceType > >
typedef TSparseSpaceType::MatrixType	SparseMatrixType

typedef TSparseSpaceType::MatrixPointerType	SparseMatrixPointerType

typedef TSparseSpaceType::VectorType	VectorType

typedef TSparseSpaceType::VectorPointerType	VectorPointerType

typedef TDenseSpaceType::MatrixType	DenseMatrixType

typedef TDenseSpaceType::VectorType	DenseVectorType

typedef std::size_t	SizeType

typedef TSparseSpaceType::IndexType	IndexType
	The index type definition to be consistent. More...

Detailed Description

template<class TSparseSpaceType, class TDenseSpaceType, class TReordererType = Reorderer<TSparseSpaceType, TDenseSpaceType>>
class Kratos::Amesos2Solver< TSparseSpaceType, TDenseSpaceType, TReordererType >

Wrapper for Trilinos-Amesos2 Direct Solvers.

Amesos2 is the Direct Sparse Solver Package in Trilinos. The goal of Amesos2 is to make AX=B as easy as it sounds, at least for direct methods. Amesos2 provides clean and consistent interfaces to several third party libraries. https://github.com/trilinos/Trilinos/tree/master/packages/amesos2

Member Typedef Documentation

◆ DenseMatrixType

template<class TSparseSpaceType , class TDenseSpaceType , class TReordererType = Reorderer<TSparseSpaceType, TDenseSpaceType>>

typedef TDenseSpaceType::MatrixType Kratos::Amesos2Solver< TSparseSpaceType, TDenseSpaceType, TReordererType >::DenseMatrixType

◆ SparseMatrixType

template<class TSparseSpaceType , class TDenseSpaceType , class TReordererType = Reorderer<TSparseSpaceType, TDenseSpaceType>>

typedef TSparseSpaceType::MatrixType Kratos::Amesos2Solver< TSparseSpaceType, TDenseSpaceType, TReordererType >::SparseMatrixType

◆ VectorType

template<class TSparseSpaceType , class TDenseSpaceType , class TReordererType = Reorderer<TSparseSpaceType, TDenseSpaceType>>

typedef TSparseSpaceType::VectorType Kratos::Amesos2Solver< TSparseSpaceType, TDenseSpaceType, TReordererType >::VectorType

Constructor & Destructor Documentation

◆ Amesos2Solver() [1/3]

template<class TSparseSpaceType , class TDenseSpaceType , class TReordererType = Reorderer<TSparseSpaceType, TDenseSpaceType>>

Kratos::Amesos2Solver< TSparseSpaceType, TDenseSpaceType, TReordererType >::Amesos2Solver ( Parameters settings )

inline

Constructor with Parameters.

◆ Amesos2Solver() [2/3]

template<class TSparseSpaceType , class TDenseSpaceType , class TReordererType = Reorderer<TSparseSpaceType, TDenseSpaceType>>

Kratos::Amesos2Solver< TSparseSpaceType, TDenseSpaceType, TReordererType >::Amesos2Solver	(	const std::string &	SolverName,
		Teuchos::ParameterList &	rParameterList
	)

inline

Constructor with solver-name and Teuchos::ParameterList.

◆ Amesos2Solver() [3/3]

template<class TSparseSpaceType , class TDenseSpaceType , class TReordererType = Reorderer<TSparseSpaceType, TDenseSpaceType>>

Kratos::Amesos2Solver< TSparseSpaceType, TDenseSpaceType, TReordererType >::Amesos2Solver ( const Amesos2Solver< TSparseSpaceType, TDenseSpaceType, TReordererType > & Other )

delete

Copy constructor.

◆ ~Amesos2Solver()

template<class TSparseSpaceType , class TDenseSpaceType , class TReordererType = Reorderer<TSparseSpaceType, TDenseSpaceType>>

Kratos::Amesos2Solver< TSparseSpaceType, TDenseSpaceType, TReordererType >::~Amesos2Solver ( )

overridedefault

Destructor.

Member Function Documentation

◆ HasSolver()

template<class TSparseSpaceType , class TDenseSpaceType , class TReordererType = Reorderer<TSparseSpaceType, TDenseSpaceType>>

static bool Kratos::Amesos2Solver< TSparseSpaceType, TDenseSpaceType, TReordererType >::HasSolver ( const std::string & rAmesosSolverName )

inlinestatic

Check if a specific solver is available Check "Amesos2_Factory.hpp" to see which solvers are available

Parameters

rAmesosSolverName. Name of the solver

Returns: Whether the specified solver is available

◆ KRATOS_CLASS_POINTER_DEFINITION()

template<class TSparseSpaceType , class TDenseSpaceType , class TReordererType = Reorderer<TSparseSpaceType, TDenseSpaceType>>

Kratos::Amesos2Solver< TSparseSpaceType, TDenseSpaceType, TReordererType >::KRATOS_CLASS_POINTER_DEFINITION ( Amesos2Solver< TSparseSpaceType, TDenseSpaceType, TReordererType > )

Pointer definition of Amesos2Solver.

◆ operator=()

template<class TSparseSpaceType , class TDenseSpaceType , class TReordererType = Reorderer<TSparseSpaceType, TDenseSpaceType>>

Amesos2Solver& Kratos::Amesos2Solver< TSparseSpaceType, TDenseSpaceType, TReordererType >::operator= ( const Amesos2Solver< TSparseSpaceType, TDenseSpaceType, TReordererType > & Other )

delete

Assignment operator.

◆ PrintInfo()

template<class TSparseSpaceType , class TDenseSpaceType , class TReordererType = Reorderer<TSparseSpaceType, TDenseSpaceType>>

void Kratos::Amesos2Solver< TSparseSpaceType, TDenseSpaceType, TReordererType >::PrintInfo ( std::ostream & rOStream ) const

inlineoverridevirtual

Print information about this object.

Reimplemented from Kratos::LinearSolver< TSparseSpaceType, TDenseSpaceType, Reorderer< TSparseSpaceType, TDenseSpaceType > >.

◆ Solve() [1/2]

template<class TSparseSpaceType , class TDenseSpaceType , class TReordererType = Reorderer<TSparseSpaceType, TDenseSpaceType>>

bool Kratos::Amesos2Solver< TSparseSpaceType, TDenseSpaceType, TReordererType >::Solve	(	SparseMatrixType &	rA,
		DenseMatrixType &	rX,
		DenseMatrixType &	rB
	)

inlineoverridevirtual

Multi solve method for solving a set of linear systems with same coefficient matrix. Solves the linear system Ax=b and puts the result on SystemVector& rX. rX is also th initial guess for iterative methods.

Parameters

rA.	System matrix
rX.	Solution vector.
rB.	Right hand side vector.

Reimplemented from Kratos::LinearSolver< TSparseSpaceType, TDenseSpaceType, Reorderer< TSparseSpaceType, TDenseSpaceType > >.

◆ Solve() [2/2]

template<class TSparseSpaceType , class TDenseSpaceType , class TReordererType = Reorderer<TSparseSpaceType, TDenseSpaceType>>

bool Kratos::Amesos2Solver< TSparseSpaceType, TDenseSpaceType, TReordererType >::Solve	(	SparseMatrixType &	rA,
		VectorType &	rX,
		VectorType &	rB
	)

inlineoverridevirtual

Normal solve method. Solves the linear system Ax=b and puts the result on SystemVector& rX. rX is also th initial guess for iterative methods.

Parameters

rA.	System matrix
rX.	Solution vector.
rB.	Right hand side vector.

Reimplemented from Kratos::LinearSolver< TSparseSpaceType, TDenseSpaceType, Reorderer< TSparseSpaceType, TDenseSpaceType > >.

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

/home/runner/work/Documentation/Documentation/master/applications/TrilinosApplication/external_includes/amesos2_solver.h

Public Member Functions

Static Public Member Functions

Type Definitions

Additional Inherited Members

Detailed Description

template<class TSparseSpaceType, class TDenseSpaceType, class TReordererType = Reorderer<TSparseSpaceType, TDenseSpaceType>> class Kratos::Amesos2Solver< TSparseSpaceType, TDenseSpaceType, TReordererType >

Member Typedef Documentation

◆ DenseMatrixType

◆ SparseMatrixType

◆ VectorType

Constructor & Destructor Documentation

◆ Amesos2Solver() [1/3]

◆ Amesos2Solver() [2/3]

◆ Amesos2Solver() [3/3]

◆ ~Amesos2Solver()

Member Function Documentation

◆ HasSolver()

◆ KRATOS_CLASS_POINTER_DEFINITION()

◆ operator=()

◆ PrintInfo()

◆ Solve() [1/2]

◆ Solve() [2/2]

template<class TSparseSpaceType, class TDenseSpaceType, class TReordererType = Reorderer<TSparseSpaceType, TDenseSpaceType>>
class Kratos::Amesos2Solver< TSparseSpaceType, TDenseSpaceType, TReordererType >