underling_fftw.h

Go to the documentation of this file.

/***************************************************************************
//-----------------------------------------------------------------------bl-
// underling 0.3.1: an FFTW MPI-based library for 3D pencil decompositions
// https://github.com/RhysU/underling
//
// Copyright (C) 2010--2013, 2026 Rhys Ulerich
// Copyright (C) 2012, 2013 The PECOS Development Team
//
// This file is part of underling.
//
// underling is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// underling 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 General Public License
// along with underling.  If not, see <http://www.gnu.org/licenses/>.
//-----------------------------------------------------------------------el-
// $Id$
***************************************************************************/
 
#ifndef UNDERLING_FFTW_H
#define UNDERLING_FFTW_H
 
#include <underling/underling.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct underling_fftw_plan_s *underling_fftw_plan;
 
#define UNDERLING_FFTW_PACKED_LONG_N2 (1U << 6)
 
#define UNDERLING_FFTW_PACKED_LONG_N0 (1U << 7)
 
#define UNDERLING_FFTW_PACKED_ALL                                       \
        (UNDERLING_FFTW_PACKED_LONG_N2 | UNDERLING_FFTW_PACKED_LONG_N0)
 
#define UNDERLING_FFTW_PACKED_NONE (1U << 8)
 
underling_fftw_plan
underling_fftw_plan_create_c2c_forward(
        const underling_problem problem,
        int long_ni,
        underling_real * in,
        underling_real * out,
        unsigned fftw_rigor_flags,
        unsigned packed_flags) UNDERLING_API;
 
underling_fftw_plan
underling_fftw_plan_create_c2c_backward(
        const underling_problem problem,
        int long_ni,
        underling_real * in,
        underling_real * out,
        unsigned fftw_rigor_flags,
        unsigned packed_flags) UNDERLING_API;
 
underling_fftw_plan
underling_fftw_plan_create_r2c_forward(
        const underling_problem problem,
        int long_ni,
        underling_real * in,
        underling_real * out,
        unsigned fftw_rigor_flags,
        unsigned packed_flags) UNDERLING_API;
 
underling_fftw_plan
underling_fftw_plan_create_c2r_backward(
        const underling_problem problem,
        int long_ni,
        underling_real * in,
        underling_real * out,
        unsigned fftw_rigor_flags,
        unsigned packed_flags) UNDERLING_API;
 
underling_fftw_plan
underling_fftw_plan_create_inverse(
        const underling_fftw_plan plan_to_invert,
        underling_real * in,
        underling_real * out,
        unsigned fftw_rigor_flags) UNDERLING_API;
 
int
underling_fftw_plan_execute(
        const underling_fftw_plan plan,
        underling_real * in,
        underling_real * out) UNDERLING_API;
 
void
underling_fftw_plan_destroy(
        underling_fftw_plan plan) UNDERLING_API;
 
void
underling_fftw_fprint_plan(
        const underling_fftw_plan plan,
        FILE *output_file) UNDERLING_API;
 
typedef struct underling_fftw_extents {
    int start[5];
 
    int size[5];
 
    int stride[5];
 
    int order[5];
} underling_fftw_extents;
 
extern const underling_fftw_extents UNDERLING_FFTW_EXTENTS_INVALID;
 
int
underling_fftw_extents_cmp(
        const underling_fftw_extents * const e1,
        const underling_fftw_extents * const e2) UNDERLING_API;
 
void
underling_fftw_fprint_extents(
        const underling_fftw_extents *extents,
        FILE *output_file) UNDERLING_API;
 
underling_fftw_extents
underling_fftw_local_extents_input(
        const underling_fftw_plan plan) UNDERLING_API;
 
underling_fftw_extents
underling_fftw_local_extents_output(
        const underling_fftw_plan plan) UNDERLING_API;
 
int
underling_fftw_local_input(
        const underling_fftw_plan plan,
        int *start,
        int *size,
        int *stride,
        int *order) UNDERLING_API;
 
int
underling_fftw_local_output(
        const underling_fftw_plan plan,
        int *start,
        int *size,
        int *stride,
        int *order) UNDERLING_API;
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif // UNDERLING_FFTW_H