Kratos::LinearSolverFactory< TSparseSpace, TLocalSpace > Class Template Reference

Here we add the functions needed for the registration of linear solvers. More...

#include <linear_solver_factory.h>

Inheritance diagram for Kratos::LinearSolverFactory< TSparseSpace, TLocalSpace >:

Collaboration diagram for Kratos::LinearSolverFactory< TSparseSpace, TLocalSpace >:

Public Member Functions
Life Cycle
virtual	~LinearSolverFactory ()
Operations
virtual bool	Has (const std::string SolverType) const
	This method checks if the linear solver is registered. More...
virtual LinearSolver< TSparseSpace, TLocalSpace >::Pointer	Create (Kratos::Parameters Settings) const
	This method creates a new solver. More...

Protected Member Functions
Protected Operators
virtual LinearSolver< TSparseSpace, TLocalSpace >::Pointer	CreateSolver (Kratos::Parameters Settings) const
	This method is an auxiliar method to create a new solver. More...

Type Definitions
typedef LinearSolverFactory< TSparseSpace, TLocalSpace >	FactoryType
	The definition of the custom class. More...
	KRATOS_CLASS_POINTER_DEFINITION (LinearSolverFactory)
	Pointer definition of LinearSolverFactory. More...

Detailed Description

template<typename TSparseSpace, typename TLocalSpace>
class Kratos::LinearSolverFactory< TSparseSpace, TLocalSpace >

Here we add the functions needed for the registration of linear solvers.

Defines the base linear solver factory

Author

Riccardo Rossi

Vicente Mataix Ferrandiz

Template Parameters

TSparseSpace	The sparse space definition
TLocalSpace	The dense space definition

Member Typedef Documentation

FactoryType

template<typename TSparseSpace , typename TLocalSpace >

typedef LinearSolverFactory<TSparseSpace,TLocalSpace> Kratos::LinearSolverFactory< TSparseSpace, TLocalSpace >::FactoryType

The definition of the custom class.

Constructor & Destructor Documentation

~LinearSolverFactory()

template<typename TSparseSpace , typename TLocalSpace >

virtual Kratos::LinearSolverFactory< TSparseSpace, TLocalSpace >::~LinearSolverFactory ( )

inlinevirtual

Member Function Documentation

Create()

template<typename TSparseSpace , typename TLocalSpace >

virtual LinearSolver<TSparseSpace,TLocalSpace>::Pointer Kratos::LinearSolverFactory< TSparseSpace, TLocalSpace >::Create ( Kratos::Parameters  Settings ) const

inlinevirtual

This method creates a new solver.

Returns

The pointer to the solver of interest

CreateSolver()

template<typename TSparseSpace , typename TLocalSpace >

virtual LinearSolver<TSparseSpace,TLocalSpace>::Pointer Kratos::LinearSolverFactory< TSparseSpace, TLocalSpace >::CreateSolver ( Kratos::Parameters  Settings ) const

inlineprotectedvirtual

This method is an auxiliar method to create a new solver.

Returns

The pointer to the solver of interest

Reimplemented in Kratos::StandardLinearSolverFactory< TSparseSpace, TLocalSpace, TLinearSolverType >, Kratos::TrilinosLinearSolverFactory< TSparseSpace, TLocalSpace, TLinearSolverType >, and Kratos::DenseLinearSolverFactory< TGlobalSpace, TLocalSpace, TLinearSolverType >.

Has()

template<typename TSparseSpace , typename TLocalSpace >

virtual bool Kratos::LinearSolverFactory< TSparseSpace, TLocalSpace >::Has ( const std::string  SolverType ) const

inlinevirtual

This method checks if the linear solver is registered.

Returns

True if registered, false otherwise

KRATOS_CLASS_POINTER_DEFINITION()

template<typename TSparseSpace , typename TLocalSpace >

Kratos::LinearSolverFactory< TSparseSpace, TLocalSpace >::KRATOS_CLASS_POINTER_DEFINITION

(

LinearSolverFactory< TSparseSpace, TLocalSpace >

)

Pointer definition of LinearSolverFactory.

---

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

• /home/runner/work/Documentation/Documentation/master/kratos/factories/linear_solver_factory.h