heffte_adapter.hpp File Reference

Adapter functions for HeFFTe library integration. More...

#include "openpfc/core/world.hpp"
#include <heffte.h>

Include dependency graph for heffte_adapter.hpp:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
heffte::box3d< int >	pfc::to_heffte_box (const World &world)
	Converts a World object to heffte::box3d<int>.

Detailed Description

Adapter functions for HeFFTe library integration.

This header provides conversion functions between OpenPFC types and HeFFTe library types, enabling seamless integration with the HeFFTe distributed FFT backend.

Key adapters:

• to_heffte_box(): Convert World to heffte::box3d<int>

HeFFTe is used as the FFT backend for spectral methods in OpenPFC, providing efficient distributed-memory parallel FFT operations.

#include <openpfc/backends/heffte_adapter.hpp>
#include <openpfc/core/world.hpp>
 
pfc::World world({64, 64, 64}, {1.0, 1.0, 1.0});
auto heffte_box = pfc::to_heffte_box(world);

See also

fft.hpp for FFT interface

core/world.hpp for World definition

Author

OpenPFC Development Team

Date

2025

Function Documentation

to_heffte_box()

heffte::box3d< int > pfc::to_heffte_box ( const World &  world )

inline

Converts a World object to heffte::box3d<int>.

This function allows explicit conversion of a World object to heffte::box3d<int>. The resulting box represents the entire world domain.

Parameters

world

The World object to convert.

Returns

A heffte::box3d<int> representing the world domain.

Examples

/home/runner/work/OpenPFC/OpenPFC/include/openpfc/model.hpp.

Here is the call graph for this function:

Here is the caller graph for this function: