Class TempLat::FFTWPlanHolder

template <typename T, size_t NDim>

ClassList > TempLat > FFTWPlanHolder

A class which holds FFT plans, and implements FFTLibraryInterface::PlanInterface<T>. The plans are implemented in std::shared_ptr's, so they are only desctructed when the last instance is destructed. More...

• #include <fftwplanholder.h>

Inherits the following classes: TempLat::FFTPlanInterface

Public Types

Type	Name
typedef fftw_plan	plan

Public Functions

Type	Name
	FFTWPlanHolder (MPICartesianGroup group, plan planR2C, plan planC2R)
virtual void	c2r (MemoryBlock< T, NDim > & mBlock)
virtual void	r2c (MemoryBlock< T, NDim > & mBlock)
	~FFTWPlanHolder ()

Public Functions inherited from TempLat::FFTPlanInterface

See TempLat::FFTPlanInterface

Type	Name
virtual void	c2r (MemoryBlock< T, NDim > & mBlock) = 0
virtual void	r2c (MemoryBlock< T, NDim > & mBlock) = 0
virtual	~FFTPlanInterface () = default

Detailed Description

Unit test: ctest -R test-fftwplanholder

Public Types Documentation

typedef plan

using TempLat::FFTWPlanHolder< T, NDim >::plan =  fftw_plan;

---

Public Functions Documentation

function FFTWPlanHolder

inline TempLat::FFTWPlanHolder::FFTWPlanHolder (
    MPICartesianGroup group,
    plan planR2C,
    plan planC2R
) 

---

function c2r

inline virtual void TempLat::FFTWPlanHolder::c2r (
    MemoryBlock < T, NDim > & mBlock
) 

Implements TempLat::FFTPlanInterface::c2r

---

function r2c

inline virtual void TempLat::FFTWPlanHolder::r2c (
    MemoryBlock < T, NDim > & mBlock
) 

Implements TempLat::FFTPlanInterface::r2c

---

function ~FFTWPlanHolder

inline TempLat::FFTWPlanHolder::~FFTWPlanHolder () 

---

---

The documentation for this class was generated from the following file cosmolatticeweb/tmp/code_source/templat/include/TempLat/fft/external/fftw/fftwplanholder.h