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

Here we add the functions needed for the registration of preconditioners. More...

#include <preconditioner_factory.h>

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

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

Public Member Functions
Life Cycle
virtual	~PreconditionerFactory ()
Operations
virtual bool	Has (const std::string &rSolverType) const
	This method checks if the linear solver is registered. More...
virtual PreconditionerType::Pointer	Create (const std::string &rPreconditionerType) const
	This method creates a new solver. More...

Protected Member Functions
Protected Operators
virtual PreconditionerType::Pointer	CreatePreconditioner () const
	This method is an auxiliar method to create a new solver. More...

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

Detailed Description

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

Here we add the functions needed for the registration of preconditioners.

Defines the base preconditioner 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 PreconditionerFactory<TSparseSpace,TLocalSpace> Kratos::PreconditionerFactory< TSparseSpace, TLocalSpace >::FactoryType

The definition of the custom class.

PreconditionerType

template<typename TSparseSpace , typename TLocalSpace >

typedef Preconditioner<TSparseSpace,TLocalSpace> Kratos::PreconditionerFactory< TSparseSpace, TLocalSpace >::PreconditionerType

The definition of the preconditioner.

Constructor & Destructor Documentation

~PreconditionerFactory()

template<typename TSparseSpace , typename TLocalSpace >

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

inlinevirtual

Member Function Documentation

Create()

template<typename TSparseSpace , typename TLocalSpace >

virtual PreconditionerType::Pointer Kratos::PreconditionerFactory< TSparseSpace, TLocalSpace >::Create ( const std::string &  rPreconditionerType ) const

inlinevirtual

This method creates a new solver.

Returns

The pointer to the solver of interest

CreatePreconditioner()

template<typename TSparseSpace , typename TLocalSpace >

virtual PreconditionerType::Pointer Kratos::PreconditionerFactory< TSparseSpace, TLocalSpace >::CreatePreconditioner ( ) const

inlineprotectedvirtual

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

Returns

The pointer to the solver of interest

Reimplemented in Kratos::StandardPreconditionerFactory< TSparseSpace, TLocalSpace, TPreconditionerType >.

Has()

template<typename TSparseSpace , typename TLocalSpace >

virtual bool Kratos::PreconditionerFactory< TSparseSpace, TLocalSpace >::Has ( const std::string &  rSolverType ) 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::PreconditionerFactory< TSparseSpace, TLocalSpace >::KRATOS_CLASS_POINTER_DEFINITION

(

PreconditionerFactory< TSparseSpace, TLocalSpace >

)

Pointer definition of PreconditionerFactory.

---

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

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