ESPResSo
Extensible Simulation Package for Research on Soft Matter Systems
Loading...
Searching...
No Matches
fft::fft_plan< FloatType > Struct Template Reference

#include <fft.hpp>

+ Inheritance diagram for fft::fft_plan< FloatType >:

Public Types

using fftw_plan = std::conditional_t< std::is_same_v< FloatType, double >, fftw_plan_s *, fftwf_plan_s * >
 

Public Member Functions

 ~fft_plan ()
 
void destroy_plan ()
 

Public Attributes

int dir
 plan direction: forward or backward FFT (enum value from FFTW).
 
fftw_plan plan_handle = nullptr
 plan for the FFT.
 
void(* pack_function )(FloatType const *const, FloatType *const, int const *, int const *, int const *, int)
 packing function for send blocks.
 

Detailed Description

template<typename FloatType>
struct fft::fft_plan< FloatType >

Definition at line 61 of file fft.hpp.

Member Typedef Documentation

◆ fftw_plan

template<typename FloatType >
using fft::fft_plan< FloatType >::fftw_plan = std::conditional_t<std::is_same_v<FloatType, double>, fftw_plan_s *, fftwf_plan_s *>

Definition at line 65 of file fft.hpp.

Constructor & Destructor Documentation

◆ ~fft_plan()

template<typename FloatType >
fft::fft_plan< FloatType >::~fft_plan ( )
inline

Definition at line 68 of file fft.hpp.

References fft::fft_plan< FloatType >::destroy_plan().

Member Function Documentation

◆ destroy_plan()

template<typename FloatType >
void fft::fft_plan< FloatType >::destroy_plan ( )

Definition at line 787 of file fft.cpp.

References fft::fftw< FloatType >::destroy_plan.

Referenced by fft::fft_plan< FloatType >::~fft_plan().

Member Data Documentation

◆ dir

template<typename FloatType >
int fft::fft_plan< FloatType >::dir

plan direction: forward or backward FFT (enum value from FFTW).

Definition at line 71 of file fft.hpp.

◆ pack_function

template<typename FloatType >
void(* fft::fft_plan< FloatType >::pack_function) (FloatType const *const, FloatType *const, int const *, int const *, int const *, int)

packing function for send blocks.

Definition at line 75 of file fft.hpp.

◆ plan_handle

template<typename FloatType >
fftw_plan fft::fft_plan< FloatType >::plan_handle = nullptr

plan for the FFT.

Definition at line 73 of file fft.hpp.


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