amrex::FFT::Info Struct Reference

#include <AMReX_FFT_Helper.H>

Public Member Functions
Info &	setDomainStrategy (DomainStrategy s)
Info &	setPencilThreshold (int t)
Info &	setTwoDMode (bool x)
Info &	setOneDMode (bool x)
Info &	setBatchSize (int bsize)
Info &	setNumProcs (int n)

Public Attributes
DomainStrategy	domain_strategy = DomainStrategy::automatic
	Domain composition strategy.
int	pencil_threshold = 4
bool	twod_mode = false
bool	oned_mode = false
	We might have a special twod_mode: nx or ny == 1 && nz > 1.
int	batch_size = 1
	Batched FFT size. Only support in R2C, not R2X.
int	nprocs = std::numeric_limits<int>::max()
	Max number of processes to use.

Member Function Documentation

setBatchSize()

Info & amrex::FFT::Info::setBatchSize ( int  bsize )

inline

setDomainStrategy()

Info & amrex::FFT::Info::setDomainStrategy ( DomainStrategy  s )

inline

setNumProcs()

Info & amrex::FFT::Info::setNumProcs ( int  n )

inline

setOneDMode()

Info & amrex::FFT::Info::setOneDMode ( bool  x )

inline

setPencilThreshold()

Info & amrex::FFT::Info::setPencilThreshold ( int  t )

inline

setTwoDMode()

Info & amrex::FFT::Info::setTwoDMode ( bool  x )

inline

Member Data Documentation

batch_size

int amrex::FFT::Info::batch_size = 1

Batched FFT size. Only support in R2C, not R2X.

domain_strategy

DomainStrategy amrex::FFT::Info::domain_strategy = DomainStrategy::automatic

Domain composition strategy.

nprocs

int amrex::FFT::Info::nprocs = std::numeric_limits<int>::max()

Max number of processes to use.

oned_mode

bool amrex::FFT::Info::oned_mode = false

We might have a special twod_mode: nx or ny == 1 && nz > 1.

pencil_threshold

int amrex::FFT::Info::pencil_threshold = 4

For automatic strategy, this is the size per process below which we switch from slab to pencil.

twod_mode

bool amrex::FFT::Info::twod_mode = false

Supported only in 3D. When twod_mode is true, FFT is performed on the first two dimensions only and the third dimension size is the batch size.

---

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

• /home/runner/work/amrex/amrex/Src/FFT/AMReX_FFT_Helper.H