Gromacs  2025.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions | Public Attributes
gmx::RocfftPlan Struct Reference

#include <gromacs/fft/rocfft_common_utils.h>

Description

All the persistent data for planning an executing a 3D FFT.

Public Member Functions

 ~RocfftPlan ()
 Destructor.
 
 RocfftPlan ()=default
 Default constructor.
 
 RocfftPlan (rocfft_plan inPlan, rocfft_execution_info inInfo, void *inWorkBuffer)
 Full constructor.
 
 RocfftPlan (RocfftPlan &&other)=default
 Move construct is allowed.
 
RocfftPlanoperator= (RocfftPlan &&other)=default
 Move assign is allowed.
 
 RocfftPlan (const RocfftPlan &other)=delete
 Copy construct is not allowed.
 
RocfftPlanoperator= (const RocfftPlan &other)=delete
 Copy assign is not allowed.
 

Public Attributes

rocfft_plan plan = nullptr
 High level information about the plan.
 
rocfft_execution_info info = nullptr
 Execution details (working buffer, HIP stream to use, etc)
 
void * workBuffer = nullptr
 Persistent work buffer (left unallocated if not needed)
 

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