ippl::preconditioner< Field > Struct Template Reference

#include <Preconditioner.h>

Inheritance diagram for ippl::preconditioner< Field >:

Collaboration diagram for ippl::preconditioner< Field >:

Public Types
using	mesh_type = typename Field::Mesh_t
using	layout_type = typename Field::Layout_t

Public Member Functions
	preconditioner ()
	preconditioner (std::string name)
virtual	~preconditioner ()=default
virtual Field	operator() (Field &u)
virtual void	init_fields (Field &b)
std::string	get_type ()

Static Public Attributes
static constexpr unsigned	Dim = Field::dim

Protected Attributes
std::string	type_m

Detailed Description

template<typename Field>
struct ippl::preconditioner< Field >

Definition at line 22 of file Preconditioner.h.

Member Typedef Documentation

layout_type

template<typename Field>

using ippl::preconditioner< Field >::layout_type = typename Field::Layout_t

Definition at line 25 of file Preconditioner.h.

mesh_type

template<typename Field>

using ippl::preconditioner< Field >::mesh_type = typename Field::Mesh_t

Definition at line 24 of file Preconditioner.h.

Constructor & Destructor Documentation

preconditioner() [1/2]

template<typename Field>

ippl::preconditioner< Field >::preconditioner ( )

inline

Definition at line 27 of file Preconditioner.h.

References type_m.

Referenced by ippl::gs_preconditioner< Field, LowerF, UpperF, InvDiagF >::gs_preconditioner(), ippl::jacobi_preconditioner< Field, InvDiagF >::jacobi_preconditioner(), ippl::polynomial_chebyshev_preconditioner< Field, OperatorF >::polynomial_chebyshev_preconditioner(), ippl::polynomial_chebyshev_preconditioner< Field, OperatorF >::polynomial_chebyshev_preconditioner(), ippl::polynomial_newton_preconditioner< Field, OperatorF >::polynomial_newton_preconditioner(), ippl::polynomial_newton_preconditioner< Field, OperatorF >::polynomial_newton_preconditioner(), ippl::richardson_preconditioner< Field, UpperAndLowerF, InvDiagF >::richardson_preconditioner(), ippl::richardson_preconditioner_alt< Field, OperatorF, InvDiagF >::richardson_preconditioner_alt(), and ippl::ssor_preconditioner< Field, LowerF, UpperF, InvDiagF, DiagF >::ssor_preconditioner().

Here is the caller graph for this function:

preconditioner() [2/2]

template<typename Field>

ippl::preconditioner< Field >::preconditioner ( std::string name )

inline

Definition at line 30 of file Preconditioner.h.

References type_m.

~preconditioner()

template<typename Field>

virtual ippl::preconditioner< Field >::~preconditioner ( )

virtualdefault

Member Function Documentation

get_type()

template<typename Field>

std::string ippl::preconditioner< Field >::get_type ( )

inline

Definition at line 47 of file Preconditioner.h.

References type_m.

init_fields()

template<typename Field>

virtual void ippl::preconditioner< Field >::init_fields ( Field & b )

inlinevirtual

Reimplemented in ippl::gs_preconditioner< Field, LowerF, UpperF, InvDiagF >, ippl::richardson_preconditioner< Field, UpperAndLowerF, InvDiagF >, ippl::richardson_preconditioner_alt< Field, OperatorF, InvDiagF >, and ippl::ssor_preconditioner< Field, LowerF, UpperF, InvDiagF, DiagF >.

Definition at line 42 of file Preconditioner.h.

References ippl::Field< T, Dim, Mesh, Centering, ViewArgs >::deepCopy().

Here is the call graph for this function:

operator()()

template<typename Field>

virtual Field ippl::preconditioner< Field >::operator() ( Field & u )

inlinevirtual

Reimplemented in ippl::gs_preconditioner< Field, LowerF, UpperF, InvDiagF >, ippl::jacobi_preconditioner< Field, InvDiagF >, ippl::polynomial_chebyshev_preconditioner< Field, OperatorF >, ippl::polynomial_newton_preconditioner< Field, OperatorF >, ippl::richardson_preconditioner< Field, UpperAndLowerF, InvDiagF >, ippl::richardson_preconditioner_alt< Field, OperatorF, InvDiagF >, and ippl::ssor_preconditioner< Field, LowerF, UpperF, InvDiagF, DiagF >.

Definition at line 36 of file Preconditioner.h.

References ippl::Field< T, Dim, Mesh, Centering, ViewArgs >::deepCopy().

Here is the call graph for this function:

Member Data Documentation

Dim

template<typename Field>

unsigned ippl::preconditioner< Field >::Dim = Field::dim

staticconstexpr

Definition at line 23 of file Preconditioner.h.

type_m

template<typename Field>

std::string ippl::preconditioner< Field >::type_m

protected

Definition at line 50 of file Preconditioner.h.

Referenced by get_type(), preconditioner(), and preconditioner().

---

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

• Preconditioner.h