IPPL (Independent Parallel Particle Layer)
IPPL
Loading...
Searching...
No Matches
ippl::gs_preconditioner< Field, LowerF, UpperF, InvDiagF > Struct Template Reference

#include <Preconditioner.h>

Inheritance diagram for ippl::gs_preconditioner< Field, LowerF, UpperF, InvDiagF >:
Collaboration diagram for ippl::gs_preconditioner< Field, LowerF, UpperF, InvDiagF >:

Public Types

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

Public Member Functions

 gs_preconditioner (LowerF &&lower, UpperF &&upper, InvDiagF &&inverse_diagonal, unsigned innerloops, unsigned outerloops)
Field operator() (Field &b) override
void init_fields (Field &b) override
std::string get_type ()

Static Public Attributes

static constexpr unsigned Dim = Field::dim

Protected Attributes

LowerF lower_m
UpperF upper_m
InvDiagF inverse_diagonal_m
unsigned innerloops_m
unsigned outerloops_m
Field UL_m
Field r_m
std::string type_m

Detailed Description

template<typename Field, typename LowerF, typename UpperF, typename InvDiagF>
struct ippl::gs_preconditioner< Field, LowerF, UpperF, InvDiagF >

2-step Gauss-Seidel preconditioner

Definition at line 406 of file Preconditioner.h.

Member Typedef Documentation

◆ layout_type

template<typename Field, typename LowerF, typename UpperF, typename InvDiagF>
using ippl::gs_preconditioner< Field, LowerF, UpperF, InvDiagF >::layout_type = typename Field::Layout_t

Definition at line 409 of file Preconditioner.h.

◆ mesh_type

template<typename Field, typename LowerF, typename UpperF, typename InvDiagF>
using ippl::gs_preconditioner< Field, LowerF, UpperF, InvDiagF >::mesh_type = typename Field::Mesh_t

Definition at line 408 of file Preconditioner.h.

Constructor & Destructor Documentation

◆ gs_preconditioner()

template<typename Field, typename LowerF, typename UpperF, typename InvDiagF>
ippl::gs_preconditioner< Field, LowerF, UpperF, InvDiagF >::gs_preconditioner ( LowerF && lower,
UpperF && upper,
InvDiagF && inverse_diagonal,
unsigned innerloops,
unsigned outerloops )
inline

Definition at line 411 of file Preconditioner.h.

References innerloops_m, inverse_diagonal_m, lower_m, outerloops_m, ippl::preconditioner< Field >::preconditioner(), and upper_m.

Here is the call graph for this function:

Member Function Documentation

◆ get_type()

template<typename Field>
std::string ippl::preconditioner< Field >::get_type ( )
inlineinherited

Definition at line 47 of file Preconditioner.h.

References type_m.

◆ init_fields()

template<typename Field, typename LowerF, typename UpperF, typename InvDiagF>
void ippl::gs_preconditioner< Field, LowerF, UpperF, InvDiagF >::init_fields ( Field & b)
inlineoverridevirtual

Reimplemented from ippl::preconditioner< Field >.

Definition at line 470 of file Preconditioner.h.

References ippl::Field< T, Dim, Mesh, Centering, ViewArgs >::get_mesh(), ippl::BareField< T, Dim, ViewArgs >::getLayout(), r_m, and UL_m.

Here is the call graph for this function:

◆ operator()()

template<typename Field, typename LowerF, typename UpperF, typename InvDiagF>
Field ippl::gs_preconditioner< Field, LowerF, UpperF, InvDiagF >::operator() ( Field & b)
inlineoverridevirtual

Reimplemented from ippl::preconditioner< Field >.

Definition at line 421 of file Preconditioner.h.

References ippl::Field< T, Dim, Mesh, Centering, ViewArgs >::get_mesh(), ippl::BareField< T, Dim, ViewArgs >::getLayout(), innerloops_m, inverse_diagonal_m, lower_m, outerloops_m, r_m, UL_m, and upper_m.

Here is the call graph for this function:

Member Data Documentation

◆ Dim

template<typename Field, typename LowerF, typename UpperF, typename InvDiagF>
unsigned ippl::gs_preconditioner< Field, LowerF, UpperF, InvDiagF >::Dim = Field::dim
staticconstexpr

Definition at line 407 of file Preconditioner.h.

◆ innerloops_m

template<typename Field, typename LowerF, typename UpperF, typename InvDiagF>
unsigned ippl::gs_preconditioner< Field, LowerF, UpperF, InvDiagF >::innerloops_m
protected

Definition at line 482 of file Preconditioner.h.

Referenced by gs_preconditioner(), and operator()().

◆ inverse_diagonal_m

template<typename Field, typename LowerF, typename UpperF, typename InvDiagF>
InvDiagF ippl::gs_preconditioner< Field, LowerF, UpperF, InvDiagF >::inverse_diagonal_m
protected

Definition at line 481 of file Preconditioner.h.

Referenced by gs_preconditioner(), and operator()().

◆ lower_m

template<typename Field, typename LowerF, typename UpperF, typename InvDiagF>
LowerF ippl::gs_preconditioner< Field, LowerF, UpperF, InvDiagF >::lower_m
protected

Definition at line 479 of file Preconditioner.h.

Referenced by gs_preconditioner(), and operator()().

◆ outerloops_m

template<typename Field, typename LowerF, typename UpperF, typename InvDiagF>
unsigned ippl::gs_preconditioner< Field, LowerF, UpperF, InvDiagF >::outerloops_m
protected

Definition at line 483 of file Preconditioner.h.

Referenced by gs_preconditioner(), and operator()().

◆ r_m

template<typename Field, typename LowerF, typename UpperF, typename InvDiagF>
Field ippl::gs_preconditioner< Field, LowerF, UpperF, InvDiagF >::r_m
protected

Definition at line 485 of file Preconditioner.h.

Referenced by init_fields(), and operator()().

◆ type_m

template<typename Field>
std::string ippl::preconditioner< Field >::type_m
protectedinherited

Definition at line 50 of file Preconditioner.h.

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

◆ UL_m

template<typename Field, typename LowerF, typename UpperF, typename InvDiagF>
Field ippl::gs_preconditioner< Field, LowerF, UpperF, InvDiagF >::UL_m
protected

Definition at line 484 of file Preconditioner.h.

Referenced by init_fields(), and operator()().

◆ upper_m

template<typename Field, typename LowerF, typename UpperF, typename InvDiagF>
UpperF ippl::gs_preconditioner< Field, LowerF, UpperF, InvDiagF >::upper_m
protected

Definition at line 480 of file Preconditioner.h.

Referenced by gs_preconditioner(), and operator()().

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