ippl::SolverAlgorithm< FieldLHS, FieldRHS > Class Template Reference

#include <SolverAlgorithm.h>

Inheritance diagram for ippl::SolverAlgorithm< FieldLHS, FieldRHS >:

Collaboration diagram for ippl::SolverAlgorithm< FieldLHS, FieldRHS >:

Public Types
using	lhs_type = FieldLHS
using	rhs_type = FieldRHS

Public Member Functions
virtual void	operator() (lhs_type &lhs, rhs_type &rhs, const ParameterList &params)=0

Detailed Description

template<typename FieldLHS, typename FieldRHS>
class ippl::SolverAlgorithm< FieldLHS, FieldRHS >

Definition at line 16 of file SolverAlgorithm.h.

Member Typedef Documentation

lhs_type

template<typename FieldLHS, typename FieldRHS>

using ippl::SolverAlgorithm< FieldLHS, FieldRHS >::lhs_type = FieldLHS

Definition at line 18 of file SolverAlgorithm.h.

rhs_type

template<typename FieldLHS, typename FieldRHS>

using ippl::SolverAlgorithm< FieldLHS, FieldRHS >::rhs_type = FieldRHS

Definition at line 19 of file SolverAlgorithm.h.

Member Function Documentation

operator()()

template<typename FieldLHS, typename FieldRHS>

virtual void ippl::SolverAlgorithm< FieldLHS, FieldRHS >::operator() ( lhs_type & lhs, rhs_type & rhs, const ParameterList & params )

pure virtual

Solve the problem described by Op(lhs) = rhs, where Op is an unspecified differential operator (handled by derived classes)

Parameters

lhs	The problem's LHS
rhs	The problem's RHS
params	A set of parameters for the solver algorithm

Implemented in ippl::CG< FEMVector< T >, FEMVector< T >, FEMVector< T >, FEMVector< T >, FEMVector< T >, FEMVector< T >, FEMVector< T > >, ippl::CG< lhs_type, lhs_type, lhs_type, lhs_type, lhs_type, FieldLHS, FieldLHS >, ippl::CG< lhs_type, lhs_type, lhs_type, lhs_type, lhs_type, FieldLHS, FieldLHS, FieldLHS >, ippl::CG< OperatorRet, LowerRet, UpperRet, UpperLowerRet, InverseDiagRet, DiagRet, FieldLHS, FieldLHS >, ippl::CG< OperatorRet, LowerRet, UpperRet, UpperLowerRet, InverseDiagRet, FEMVector< T >, FEMVector< T > >, and ippl::PCG< lhs_type, lhs_type, lhs_type, lhs_type, lhs_type, FieldLHS, FieldLHS >.

---

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

• SolverAlgorithm.h