Cabana 0.8.0-dev
 
Loading...
Searching...
No Matches
Cabana::Grid::Experimental::FastFourierTransformParams Class Reference

Parameters controlling details for fast Fourier transforms. More...

#include <Cabana_Grid_FastFourierTransform.hpp>

Public Member Functions

void setAlltoAll (FFTCommPattern value)
 Set MPI communication strategy.
 
void setAlltoAll (bool value)
 Set MPI communication strategy.
 
void setPencils (bool value)
 Set data exchange type (pencil or slab).
 
void setReorder (bool value)
 Set data handling (contiguous or strided memory).
 
FFTCommPattern getAlltoAll () const
 Get MPI communication strategy.
 
bool getPencils () const
 Get data exchange type (pencil or slab).
 
bool getReorder () const
 Get data handling (contiguous or strided memory).
 

Detailed Description

Parameters controlling details for fast Fourier transforms.

Member Function Documentation

◆ getAlltoAll()

FFTCommPattern Cabana::Grid::Experimental::FastFourierTransformParams::getAlltoAll ( ) const
inline

Get MPI communication strategy.

Returns
Using AllToAll or not.

◆ getPencils()

bool Cabana::Grid::Experimental::FastFourierTransformParams::getPencils ( ) const
inline

Get data exchange type (pencil or slab).

Returns
Using pencil (true) or slab (false) decomposition.

◆ getReorder()

bool Cabana::Grid::Experimental::FastFourierTransformParams::getReorder ( ) const
inline

Get data handling (contiguous or strided memory).

Returns
Using contiguous (true) or strided (false) memory layout. Contiguous layout requires tensor transposition; strided layout does not.

◆ setAlltoAll() [1/2]

void Cabana::Grid::Experimental::FastFourierTransformParams::setAlltoAll ( bool value)
inline

Set MPI communication strategy.

Parameters
valueUse all to all MPI communication.

◆ setAlltoAll() [2/2]

void Cabana::Grid::Experimental::FastFourierTransformParams::setAlltoAll ( FFTCommPattern value)
inline

Set MPI communication strategy.

Parameters
valueUse all to all MPI communication.

◆ setPencils()

void Cabana::Grid::Experimental::FastFourierTransformParams::setPencils ( bool value)
inline

Set data exchange type (pencil or slab).

Parameters
valueUse pencil (true) or slab (false) decomposition.

◆ setReorder()

void Cabana::Grid::Experimental::FastFourierTransformParams::setReorder ( bool value)
inline

Set data handling (contiguous or strided memory).

Parameters
valueUse contiguous (true) or strided (false) memory layout. Contiguous layout requires tensor transposition; strided layout does not.

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