IPPL API Reference
Independent Parallel Particle Layer C++ API
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Protected Member Functions | List of all members
ippl::FFTPeriodicPoissonSolver< FieldLHS, FieldRHS > Class Template Reference
+ Inheritance diagram for ippl::FFTPeriodicPoissonSolver< FieldLHS, FieldRHS >:
+ Collaboration diagram for ippl::FFTPeriodicPoissonSolver< FieldLHS, FieldRHS >:

Public Types

using Field_t = FieldRHS
 
using FFT_t = FFT< RCTransform, FieldRHS >
 
using Complex_t = typename FFT_t::Complex_t
 
using CxField_t = typename FFT_t::ComplexField
 
using Layout_t = FieldLayout< Dim >
 
using Vector_t = Vector< Trhs, Dim >
 
using Base = Poisson< FieldLHS, FieldRHS >
 
using scalar_type = typename FieldLHS::Mesh_t::value_type
 
using vector_type = typename FieldLHS::Mesh_t::vector_type
 
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

 FFTPeriodicPoissonSolver (lhs_type &lhs, rhs_type &rhs)
 
void setRhs (rhs_type &rhs) override
 
void solve () override
 
- 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_t * getHessian ()
 
void setGradient (grad_type &grad)
 

Protected Member Functions

virtual 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_type * grad_mp
 

Member Function Documentation

◆ setDefaultParameters()

template<typename FieldLHS , typename FieldRHS >
virtual void ippl::FFTPeriodicPoissonSolver< 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::FFTPeriodicPoissonSolver< 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::FFTPeriodicPoissonSolver< 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: