1D complex-to-complex FFT class More...

#include <FFT.h>

Inheritance diagram for FFT< CCTransform, 1U, T >:

Collaboration diagram for FFT< CCTransform, 1U, T >:

Public Types
typedef FieldLayout< 1U >	Layout_t

typedef std::complex< T >	Complex_t

typedef BareField< Complex_t, 1U >	ComplexField_t

typedef LField< Complex_t, 1U >	ComplexLField_t

typedef FFTBase< 1U, T >::Domain_t	Domain_t

enum

enum	FFT_e

typedef T	Precision_t

typedef FFTPACK< T >	InternalFFT_t

Public Member Functions
	FFT (const Domain_t &cdomain, const bool transformTheseDims[1U], const bool &compressTemps=false)
	Create a new FFT object with the given domain for the input Field. More...

	FFT (const Domain_t &cdomain, const bool &compressTemps=false)
	Create a new FFT object with the given domain for the input Field. More...

	~FFT (void)

void	transform (int direction, ComplexField_t &f, ComplexField_t &g, const bool &constInput=false)
	Do the FFT: specify +1 or -1 to indicate forward or inverse transform, or specify the user-defined name string for the direction. More...

void	transform (const char *directionName, ComplexField_t &f, ComplexField_t &g, const bool &constInput=false)
	invoke using string for direction name More...

void	transform (int direction, ComplexField_t &f)
	overloaded versions which perform the FFT "in place" More...

void	transform (const char *directionName, ComplexField_t &f)

void	write (std::ostream &out) const
	I/O for FFT object. More...

void	setDirectionName (int direction, const char *directionName)
	Allow the user to name the transform directions, for code clarity. More...

void	setNormFact (Precision_t nf)
	Set the FFT normalization factor (to something other than the default) More...

int	transVnodes () const
	Utility to determine the number of vnodes to use in temporary transpose fields; this is either -1, or a limited number set on the command line. More...

Protected Member Functions
int	getDirection (const char *directionName) const
	translate direction name string into dimension number More...

bool	transformDim (unsigned d) const
	query whether this dimension is to be transformed More...

unsigned	numTransformDims (void) const
	query number of transform dimensions More...

unsigned	activeDimension (unsigned d) const
	get dimension number from list of transformed dimensions More...

InternalFFT_t &	getEngine (void)
	access the internal FFT Engine More...

Precision_t &	getNormFact (void)
	get the FFT normalization factor More...

const Domain_t &	getDomain (void) const
	get our domain More...

bool	checkDomain (const Domain_t &dom1, const Domain_t &dom2) const
	compare indexes of two domains More...

bool	compressTemps (void) const
	do we compress temps? More...

Static Protected Attributes
static GuardCellSizes< Dim >	nullGC
	! These members are used by the derived FFT classes More...

Private Member Functions
void	setup (void)
	setup performs all the initializations necessary after the transform directions have been specified. More...

Private Attributes
Layout_t *	tempLayouts_m
	The temporary field layout. More...

ComplexField_t *	tempFields_m
	The temporary field. More...

std::map< const char *, int >	directions_m
	Stores user-defined names for FFT directions: More...

FFT_e	transformType_m
	Indicates which type of transform we do. More...

bool	transformDims_m [Dim]
	Indicates which dimensions are transformed. More...

unsigned	nTransformDims_m
	Stores the number of dims to be transformed. More...

unsigned *	activeDims_m
	Stores the numbers of these dims (0,1,2). More...

InternalFFT_t	FFTEngine_m
	Internal FFT object for performing serial FFTs. More...

Precision_t	normFact_m
	Normalization factor: More...

Domain_t	Domain_m
	Domain of the input field, mainly used to check axis sizes and ordering, former const Domain_t& Domain_m;. More...

bool	compressTempFields_m
	Switch to turn on/off compression of intermediate Fields (tempFields) as algorithm is finished with them. More...

Detailed Description

template<class T>
class FFT< CCTransform, 1U, T >

1D complex-to-complex FFT class

Definition at line 285 of file FFT.h.

Member Typedef Documentation

◆ Complex_t

template<class T >

typedef std::complex<T> FFT< CCTransform, 1U, T >::Complex_t

Definition at line 291 of file FFT.h.

◆ ComplexField_t

template<class T >

typedef BareField<Complex_t,1U> FFT< CCTransform, 1U, T >::ComplexField_t

Definition at line 292 of file FFT.h.

◆ ComplexLField_t

template<class T >

typedef LField<Complex_t,1U> FFT< CCTransform, 1U, T >::ComplexLField_t

Definition at line 293 of file FFT.h.

◆ Domain_t

template<class T >

typedef FFTBase<1U,T>::Domain_t FFT< CCTransform, 1U, T >::Domain_t

Definition at line 294 of file FFT.h.

◆ InternalFFT_t

typedef FFTPACK<T> FFTBase< Dim, T >::InternalFFT_t

inherited

Definition at line 66 of file FFTBase.h.

◆ Layout_t

template<class T >

typedef FieldLayout<1U> FFT< CCTransform, 1U, T >::Layout_t

Definition at line 290 of file FFT.h.

◆ Precision_t

typedef T FFTBase< Dim, T >::Precision_t

inherited

Definition at line 59 of file FFTBase.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

inherited

Definition at line 58 of file FFTBase.h.

◆ FFT_e

enum FFTBase::FFT_e

inherited

Definition at line 63 of file FFTBase.h.

Constructor & Destructor Documentation

◆ FFT() [1/2]

template<class T >

FFT< CCTransform, 1U, T >::FFT	(	const Domain_t &	cdomain,
		const bool	transformTheseDims[1U],
		const bool &	compressTemps = `false`
	)

Create a new FFT object with the given domain for the input Field.

Specify which dimensions to transform along. Optional argument compressTemps indicates whether or not to compress temporary Fields in between uses.

◆ FFT() [2/2]

template<class T >

FFT< CCTransform, 1U, T >::FFT	(	const Domain_t &	cdomain,
		const bool &	compressTemps = `false`
	)

Create a new FFT object with the given domain for the input Field.

Transform along all dimensions. Optional argument compressTemps indicates whether or not to compress temporary Fields in between uses.

◆ ~FFT()

template<class T >

FFT< CCTransform, 1U, T >::~FFT ( void )

Definition at line 484 of file FFT.hpp.

Member Function Documentation

◆ activeDimension()

unsigned FFTBase< Dim, T >::activeDimension ( unsigned d ) const

inlineprotectedinherited

get dimension number from list of transformed dimensions

Parameters

d

Returns

Definition at line 151 of file FFTBase.h.

◆ checkDomain()

bool FFTBase< Dim, T >::checkDomain	(	const Domain_t &	dom1,
		const Domain_t &	dom2
	)		const

inlineprotectedinherited

compare indexes of two domains

helper function for comparing domains

Parameters

Dim
dom1
Dim
dom2

Returns

Definition at line 163 of file FFTBase.h.

◆ compressTemps()

bool FFTBase< Dim, T >::compressTemps ( void ) const

inlineprotectedinherited

do we compress temps?

Definition at line 166 of file FFTBase.h.

◆ getDirection()

int FFTBase< Dim, T >::getDirection ( const char * directionName ) const

inlineprotectedinherited

translate direction name string into dimension number

Translate direction name string into dimension number.

Parameters

directionName

Returns

Definition at line 142 of file FFTBase.h.

◆ getDomain()

const Domain_t & FFTBase< Dim, T >::getDomain ( void ) const

inlineprotectedinherited

get our domain

Definition at line 160 of file FFTBase.h.

◆ getEngine()

InternalFFT_t & FFTBase< Dim, T >::getEngine ( void )

inlineprotectedinherited

access the internal FFT Engine

Definition at line 154 of file FFTBase.h.

◆ getNormFact()

Precision_t & FFTBase< Dim, T >::getNormFact ( void )

inlineprotectedinherited

get the FFT normalization factor

Definition at line 157 of file FFTBase.h.

◆ numTransformDims()

unsigned FFTBase< Dim, T >::numTransformDims ( void ) const

inlineprotectedinherited

query number of transform dimensions

Definition at line 148 of file FFTBase.h.

◆ setDirectionName()

void FFTBase< Dim, T >::setDirectionName	(	int	direction,
		const char *	directionName
	)

inlineinherited

Allow the user to name the transform directions, for code clarity.

Parameters

direction
directionName

Typical values might be "x_to_k", "k_to_x", "t_to_omega", "omega_to_t"

Definition at line 110 of file FFTBase.h.

◆ setNormFact()

void FFTBase< Dim, T >::setNormFact ( Precision_t nf )

inlineinherited

Set the FFT normalization factor (to something other than the default)

Parameters

nf

Definition at line 117 of file FFTBase.h.

◆ setup()

template<class T >

void FFT< CCTransform, 1U, T >::setup ( void )

private

setup performs all the initializations necessary after the transform directions have been specified.

Definition at line 463 of file FFT.hpp.

References FFTBase< Dim, T >::compressTemps(), FFTBase< Dim, T >::getDomain(), and PARALLEL.

Here is the call graph for this function:

◆ transform() [1/4]

template<class T >

void FFT< CCTransform, 1U, T >::transform	(	const char *	directionName,
		ComplexField_t &	f
	)

◆ transform() [2/4]

template<class T >

void FFT< CCTransform, 1U, T >::transform	(	const char *	directionName,
		ComplexField_t &	f,
		ComplexField_t &	g,
		const bool &	constInput = `false`
	)

invoke using string for direction name

◆ transform() [3/4]

template<class T >

void FFT< CCTransform, 1U, T >::transform	(	int	direction,
		ComplexField_t &	f
	)

overloaded versions which perform the FFT "in place"

◆ transform() [4/4]

template<class T >

void FFT< CCTransform, 1U, T >::transform	(	int	direction,
		ComplexField_t &	f,
		ComplexField_t &	g,
		const bool &	constInput = `false`
	)

Do the FFT: specify +1 or -1 to indicate forward or inverse transform, or specify the user-defined name string for the direction.

User provides separate input and output fields optional argument constInput indicates whether or not to treat the input Field argument f as const. If not, we can use it as a temporary in order to avoid an additional data transpose.

◆ transformDim()

bool FFTBase< Dim, T >::transformDim ( unsigned d ) const

inlineprotectedinherited

query whether this dimension is to be transformed

Parameters

d

Returns

Definition at line 145 of file FFTBase.h.

◆ transVnodes()

int FFTBase< Dim, T >::transVnodes ( ) const

inlineinherited

Utility to determine the number of vnodes to use in temporary transpose fields; this is either -1, or a limited number set on the command line.

Returns

Definition at line 125 of file FFTBase.h.

◆ write()

void FFTBase< Dim, T >::write ( std::ostream & out ) const

inherited

I/O for FFT object.

Parameters

out

Definition at line 102 of file FFTBase.hpp.

Member Data Documentation

◆ activeDims_m

unsigned* FFTBase< Dim, T >::activeDims_m

privateinherited

Stores the numbers of these dims (0,1,2).

Definition at line 176 of file FFTBase.h.

◆ compressTempFields_m

bool FFTBase< Dim, T >::compressTempFields_m

privateinherited

Switch to turn on/off compression of intermediate Fields (tempFields) as algorithm is finished with them.

Definition at line 188 of file FFTBase.h.

◆ directions_m

std::map<const char*,int> FFTBase< Dim, T >::directions_m

privateinherited

Stores user-defined names for FFT directions:

Definition at line 171 of file FFTBase.h.

◆ Domain_m

Domain_t FFTBase< Dim, T >::Domain_m

privateinherited

Domain of the input field, mainly used to check axis sizes and ordering, former const Domain_t& Domain_m;.

Definition at line 185 of file FFTBase.h.

◆ FFTEngine_m

InternalFFT_t FFTBase< Dim, T >::FFTEngine_m

privateinherited

Internal FFT object for performing serial FFTs.

Definition at line 179 of file FFTBase.h.

◆ normFact_m

Precision_t FFTBase< Dim, T >::normFact_m

privateinherited

Normalization factor:

Definition at line 182 of file FFTBase.h.

◆ nTransformDims_m

unsigned FFTBase< Dim, T >::nTransformDims_m

privateinherited

Stores the number of dims to be transformed.

Definition at line 175 of file FFTBase.h.

◆ nullGC

GuardCellSizes< Dim > FFTBase< Dim, T >::nullGC

staticprotectedinherited

! These members are used by the derived FFT classes

null GuardCellSizes object for checking BareField arguments to transform

Definition at line 139 of file FFTBase.h.

◆ tempFields_m

template<class T >

ComplexField_t* FFT< CCTransform, 1U, T >::tempFields_m

private

The temporary field.

Definition at line 353 of file FFT.h.

◆ tempLayouts_m

template<class T >

Layout_t* FFT< CCTransform, 1U, T >::tempLayouts_m

private

The temporary field layout.

Definition at line 348 of file FFT.h.

◆ transformDims_m

bool FFTBase< Dim, T >::transformDims_m[Dim]

privateinherited

Indicates which dimensions are transformed.

Definition at line 174 of file FFTBase.h.

◆ transformType_m

FFT_e FFTBase< Dim, T >::transformType_m

privateinherited

Indicates which type of transform we do.

Definition at line 173 of file FFTBase.h.

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

Public Types

Public Member Functions

Protected Member Functions

Static Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ Complex_t

◆ ComplexField_t

◆ ComplexLField_t

◆ Domain_t

◆ InternalFFT_t

◆ Layout_t

◆ Precision_t

Member Enumeration Documentation

◆ anonymous enum

◆ FFT_e

Constructor & Destructor Documentation

◆ FFT() [1/2]

◆ FFT() [2/2]

◆ ~FFT()

Member Function Documentation

◆ activeDimension()

◆ checkDomain()

◆ compressTemps()

◆ getDirection()

◆ getDomain()

◆ getEngine()

◆ getNormFact()

◆ numTransformDims()

◆ setDirectionName()

◆ setNormFact()

◆ setup()

◆ transform() [1/4]

◆ transform() [2/4]

◆ transform() [3/4]

◆ transform() [4/4]

◆ transformDim()

◆ transVnodes()

◆ write()

Member Data Documentation

◆ activeDims_m

◆ compressTempFields_m

◆ directions_m

◆ Domain_m

◆ FFTEngine_m

◆ normFact_m

◆ nTransformDims_m

◆ nullGC

◆ tempFields_m

◆ tempLayouts_m

◆ transformDims_m

◆ transformType_m