Documentation 6b54b78464
Loading...
Searching...
No Matches
Public Member Functions | List of all members
CLineletPreconditioner< ScalarType > Class Template Referencefinal
Sparse linear systems

Specialization of preconditioner that uses CSysMatrix class. More...

#include <CPreconditioner.hpp>

Inheritance diagram for CLineletPreconditioner< ScalarType >:
[legend]

Public Member Functions

 CLineletPreconditioner (CSysMatrix< ScalarType > &matrix_ref, CGeometry *geometry_ref, const CConfig *config_ref)
 Constructor of the class.
 
 CLineletPreconditioner ()=delete
 
void operator() (const CSysVector< ScalarType > &u, CSysVector< ScalarType > &v) const override
 Operator that defines the preconditioner operation.
 
void Build () override
 
- Public Member Functions inherited from CPreconditioner< ScalarType >
virtual ~CPreconditioner ()=0
 Destructor of the class.
 
virtual bool IsIdentity () const
 Return true to identify the identity preconditioner, may allow some solvers to be more efficient.
 

Additional Inherited Members

- Static Public Member Functions inherited from CPreconditioner< ScalarType >
static CPreconditioner * Create (ENUM_LINEAR_SOLVER_PREC kind, CSysMatrix< ScalarType > &jacobian, CGeometry *geometry, const CConfig *config)
 Factory method.
 

Detailed Description

template<class ScalarType>
class CLineletPreconditioner< ScalarType >

Specialization of preconditioner that uses CSysMatrix class.

Constructor & Destructor Documentation

◆ CLineletPreconditioner() [1/2]

template<class ScalarType >
CLineletPreconditioner< ScalarType >::CLineletPreconditioner ( CSysMatrix< ScalarType > &  matrix_ref,
CGeometry *  geometry_ref,
const CConfig *  config_ref 
)
inline

Constructor of the class.

Parameters
[in]matrix_ref- Matrix reference that will be used to define the preconditioner.
[in]geometry_ref- Geometry associated with the problem.
[in]config_ref- Config of the problem.

◆ CLineletPreconditioner() [2/2]

template<class ScalarType >
CLineletPreconditioner< ScalarType >::CLineletPreconditioner ( )
delete
Note
This class cannot be default constructed as that would leave us with invalid Pointers.

Member Function Documentation

◆ Build()

template<class ScalarType >
void CLineletPreconditioner< ScalarType >::Build ( )
inlineoverridevirtual
Note
Request the associated matrix to build the preconditioner.

Reimplemented from CPreconditioner< ScalarType >.

◆ operator()()

template<class ScalarType >
void CLineletPreconditioner< ScalarType >::operator() ( const CSysVector< ScalarType > &  u,
CSysVector< ScalarType > &  v 
) const
inlineoverridevirtual

Operator that defines the preconditioner operation.

Parameters
[in]u- CSysVector that is being preconditioned.
[out]v- CSysVector that is the result of the preconditioning.

Implements CPreconditioner< ScalarType >.

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