OpenPFC  0.1.4
Phase Field Crystal simulation framework
Loading...
Searching...
No Matches
pfc::fft::IFFT Struct Referenceabstract
Inheritance diagram for pfc::fft::IFFT:

Public Member Functions

virtual void forward (const RealVector &in, ComplexVector &out)=0
 Performs the forward FFT transformation.
 
virtual void backward (const ComplexVector &in, RealVector &out)=0
 Performs the backward (inverse) FFT transformation.
 
virtual void reset_fft_time ()=0
 
virtual double get_fft_time () const =0
 
virtual size_t size_inbox () const =0
 
virtual size_t size_outbox () const =0
 
virtual size_t size_workspace () const =0
 
virtual size_t get_allocated_memory_bytes () const =0
 Returns the total memory allocated by HeFFTe in bytes.
 

Member Function Documentation

◆ backward()

virtual void pfc::fft::IFFT::backward ( const ComplexVector &  in,
RealVector &  out 
)
pure virtual

Performs the backward (inverse) FFT transformation.

Parameters
inInput vector of complex values.
outOutput vector of real values.

Implemented in pfc::fft::FFT_Impl< BackendTag >.

Examples
/home/runner/work/OpenPFC/OpenPFC/include/openpfc/fft.hpp.

◆ forward()

virtual void pfc::fft::IFFT::forward ( const RealVector &  in,
ComplexVector &  out 
)
pure virtual

Performs the forward FFT transformation.

Parameters
inInput vector of real values.
outOutput vector of complex values.

Implemented in pfc::fft::FFT_Impl< BackendTag >.

Examples
/home/runner/work/OpenPFC/OpenPFC/include/openpfc/fft.hpp.

◆ get_allocated_memory_bytes()

virtual size_t pfc::fft::IFFT::get_allocated_memory_bytes ( ) const
pure virtual

Returns the total memory allocated by HeFFTe in bytes.

Includes workspace memory used by HeFFTe for FFT operations.

Returns
Total allocated memory in bytes

Implemented in pfc::fft::FFT_Impl< BackendTag >.

Examples
/home/runner/work/OpenPFC/OpenPFC/include/openpfc/fft.hpp.

◆ get_fft_time()

virtual double pfc::fft::IFFT::get_fft_time ( ) const
pure virtual

◆ reset_fft_time()

virtual void pfc::fft::IFFT::reset_fft_time ( )
pure virtual

◆ size_inbox()

virtual size_t pfc::fft::IFFT::size_inbox ( ) const
pure virtual

◆ size_outbox()

virtual size_t pfc::fft::IFFT::size_outbox ( ) const
pure virtual

◆ size_workspace()

virtual size_t pfc::fft::IFFT::size_workspace ( ) const
pure virtual

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