Page Menu
Home
c4science
Search
Configure Global Search
Log In
Files
F62387524
fftwmpi_engine.hh
No One
Temporary
Actions
Download File
Edit File
Delete File
View Transforms
Subscribe
Mute Notifications
Award Token
Subscribers
None
File Metadata
Details
File Info
Storage
Attached
Created
Sun, May 12, 20:39
Size
3 KB
Mime Type
text/x-c
Expires
Tue, May 14, 20:39 (2 d)
Engine
blob
Format
Raw Data
Handle
17641104
Attached To
rMUSPECTRE µSpectre
fftwmpi_engine.hh
View Options
/**
* @file fftwmpi_engine.hh
*
* @author Lars Pastewka <lars.pastewka@imtek.uni-freiburg.de>
*
* @date 06 Mar 2017
*
* @brief FFT engine using MPI-parallel FFTW
*
* Copyright © 2017 Till Junge
*
* µFFT is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation, either version 3, or (at
* your option) any later version.
*
* µFFT is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with µFFT; see the file COPYING. If not, write to the
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* * Boston, MA 02111-1307, USA.
*
* Additional permission under GNU GPL version 3 section 7
*
* If you modify this Program, or any covered work, by linking or combining it
* with proprietary FFT implementations or numerical libraries, containing parts
* covered by the terms of those libraries' licenses, the licensors of this
* Program grant you additional permission to convey the resulting work.
*/
#ifndef SRC_LIBMUFFT_FFTWMPI_ENGINE_HH_
#define SRC_LIBMUFFT_FFTWMPI_ENGINE_HH_
#include "fft_engine_base.hh"
#include <fftw3-mpi.h>
namespace
muFFT
{
/**
* implements the `muFFT::FFTEngineBase` interface using the
* FFTW library
*/
template
<
Dim_t
Dim
>
class
FFTWMPIEngine
:
public
FFTEngineBase
<
Dim
>
{
public
:
using
Parent
=
FFTEngineBase
<
Dim
>
;
//!< base class
using
Ccoord
=
typename
Parent
::
Ccoord
;
//!< cell coordinates type
//! field for Fourier transform of second-order tensor
using
Workspace_t
=
typename
Parent
::
Workspace_t
;
//! real-valued second-order tensor
using
Field_t
=
typename
Parent
::
Field_t
;
//! Default constructor
FFTWMPIEngine
()
=
delete
;
//! Constructor with system resolutions
FFTWMPIEngine
(
Ccoord
resolutions
,
Dim_t
nb_components
,
Communicator
comm
=
Communicator
());
//! Copy constructor
FFTWMPIEngine
(
const
FFTWMPIEngine
&
other
)
=
delete
;
//! Move constructor
FFTWMPIEngine
(
FFTWMPIEngine
&&
other
)
=
default
;
//! Destructor
virtual
~
FFTWMPIEngine
()
noexcept
;
//! Copy assignment operator
FFTWMPIEngine
&
operator
=
(
const
FFTWMPIEngine
&
other
)
=
delete
;
//! Move assignment operator
FFTWMPIEngine
&
operator
=
(
FFTWMPIEngine
&&
other
)
=
default
;
// compute the plan, etc
void
initialise
(
FFT_PlanFlags
plan_flags
)
override
;
//! forward transform
Workspace_t
&
fft
(
Field_t
&
field
)
override
;
//! inverse transform
void
ifft
(
Field_t
&
field
)
const
override
;
protected
:
static
int
nb_engines
;
//!< number of times this engine has been instatiated
fftw_plan
plan_fft
{};
//!< holds the plan for forward fourier transform
fftw_plan
plan_ifft
{};
//!< holds the plan for inverse fourier transform
ptrdiff_t
workspace_size
{};
//!< size of workspace buffer returned by planner
Real
*
real_workspace
{};
//!< temporary real workspace that is correctly
//!< padded
bool
initialised
{
false
};
//!< to prevent double initialisation
};
}
// namespace muFFT
#endif
// SRC_LIBMUFFT_FFTWMPI_ENGINE_HH_
Event Timeline
Log In to Comment