IPPL API Reference
Independent Parallel Particle Layer C++ API
Loading...
Searching...
No Matches
ippl::FFTTruncatedGreenPeriodicPoissonSolver< FieldLHS, FieldRHS > Class Template Reference
+ Inheritance diagram for ippl::FFTTruncatedGreenPeriodicPoissonSolver< FieldLHS, FieldRHS >:
+ Collaboration diagram for ippl::FFTTruncatedGreenPeriodicPoissonSolver< FieldLHS, FieldRHS >:

Public Types

using Base = Poisson< FieldLHS, FieldRHS >
 
typedef FFT< RCTransform, FieldRHS > FFT_t
 
typedef FieldRHS Field_t
 
typedef Field< int, Dim, mesh_type, typename FieldLHS::Centering_t > IField_t
 
typedef FFT_t::ComplexField CxField_t
 
typedef Vector< Trhs, Dim > Vector_t
 
typedef FieldLayout< Dim > FieldLayout_t
 
using lhs_type = FieldLHS
 
using rhs_type = FieldRHS
 
- Public Types inherited from ippl::Poisson< FieldLHS, FieldRHS >
enum  OutputType { SOL = 0b01 , GRAD = 0b10 , SOL_AND_GRAD = 0b11 }
 
using lhs_type = FieldLHS
 
using rhs_type = FieldRHS
 
using Tlhs = typename FieldLHS::value_type
 
using Trhs = typename FieldRHS::value_type
 
using grad_type = Field< Vector< Tlhs, Dim >, Dim, Mesh, Centering >
 

Public Member Functions

 FFTTruncatedGreenPeriodicPoissonSolver (rhs_type &rhs, ParameterList &params)
 
 FFTTruncatedGreenPeriodicPoissonSolver (lhs_type &lhs, rhs_type &rhs, ParameterList &params)
 
void setRhs (rhs_type &rhs) override
 
void solve () override
 
void initializeFields ()
 
void greensFunction ()
 
- Public Member Functions inherited from ippl::Poisson< FieldLHS, FieldRHS >
 Poisson ()
 
 Poisson (lhs_type &lhs, rhs_type &rhs)
 
template<typename T >
void updateParameter (const std::string &key, const T &value)
 
void updateParameters (const ParameterList &params)
 
void mergeParameters (const ParameterList &params)
 
virtual void setLhs (lhs_type &lhs)
 
virtual MField_tgetHessian ()
 
void setGradient (grad_type &grad)
 

Protected Member Functions

void setDefaultParameters () override
 

Additional Inherited Members

- Protected Attributes inherited from ippl::Poisson< FieldLHS, FieldRHS >
ParameterList params_m
 
rhs_type * rhs_mp = nullptr
 
lhs_type * lhs_mp = nullptr
 
grad_typegrad_mp
 

Member Function Documentation

◆ setDefaultParameters()

template<typename FieldLHS , typename FieldRHS >
void ippl::FFTTruncatedGreenPeriodicPoissonSolver< FieldLHS, FieldRHS >::setDefaultParameters ( )
inlineoverrideprotectedvirtual

Utility function for initializing a solver's default parameters (to be overridden for each base class)

Reimplemented from ippl::Poisson< FieldLHS, FieldRHS >.

◆ setRhs()

template<typename FieldLHS , typename FieldRHS >
void ippl::FFTTruncatedGreenPeriodicPoissonSolver< FieldLHS, FieldRHS >::setRhs ( rhs_type &  rhs)
overridevirtual

Set the problem RHS

Parameters
rhsReference to problem RHS field

Reimplemented from ippl::Poisson< FieldLHS, FieldRHS >.

◆ solve()

template<typename FieldLHS , typename FieldRHS >
void ippl::FFTTruncatedGreenPeriodicPoissonSolver< FieldLHS, FieldRHS >::solve ( )
overridevirtual

Solve the Poisson problem described by -laplace(lhs) = rhs

Implements ippl::Poisson< FieldLHS, FieldRHS >.


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