1#ifndef AMREX_FFT_R2C_H_
2#define AMREX_FFT_R2C_H_
3#include <AMReX_Config.H>
21template <
typename T>
class OpenBCSolver;
22template <
typename T>
class Poisson;
23template <
typename T>
class PoissonHybrid;
46template <
typename T = Real, FFT::Direction D = FFT::Direction::both,
bool C = false>
51 using MF = std::conditional_t
52 <
C,
cMF, std::conditional_t<std::is_same_v<T,Real>,
56 template <
typename U>
friend class Poisson;
76 explicit R2C (std::array<int,AMREX_SPACEDIM>
const& domain_size,
110 std::array<int,AMREX_SPACEDIM>
const& local_size);
125 std::pair<std::array<int,AMREX_SPACEDIM>,std::array<int,AMREX_SPACEDIM>>
157 std::array<int,AMREX_SPACEDIM>
const& local_size);
177 std::pair<std::array<int,AMREX_SPACEDIM>,std::array<int,AMREX_SPACEDIM>>
201 template <
typename F, Direction DIR=D>
204 int incomp = 0,
int outcomp = 0)
208 "FFT::R2C::forwardThenBackward(post_forward) currently supports only !twod_mode and batch_size==1");
225 template <Direction DIR=D>
240 template <Direction DIR=D>
242 void forward (
MF const& inmf,
cMF& outmf,
int incomp = 0,
int outcomp = 0);
260 template <
typename RT,
typename CT, Direction DIR=D,
bool CP=C>
262 && (((
sizeof(RT)*2 ==
sizeof(CT)) && (!CP))
263 || ((
sizeof(RT) ==
sizeof(CT)) && CP))
275 template <Direction DIR=D>
290 template <Direction DIR=D>
292 void backward (
cMF const& inmf,
MF& outmf,
int incomp = 0,
int outcomp = 0);
310 template <
typename CT,
typename RT, Direction DIR=D,
bool CP=C>
312 && (((
sizeof(RT)*2 ==
sizeof(CT)) && (!CP))
313 || ((
sizeof(RT) ==
sizeof(CT)) && CP))
336 template <Direction DIR=D>
357 template <
typename F>
360 template <
typename F>
370 void prepare_openbc ();
376 void backward_doit (
cMF const& inmf,
MF& outmf,
379 int incomp = 0,
int outcomp = 0);
381 std::pair<Plan<T>,
Plan<T>> make_c2c_plans (
cMF& inout,
int ndims)
const;
383 [[nodiscard]]
MF& make_m_rx_alias (
IndexType const& ix_type);
388 static Box make_domain_x (
Box const& domain)
403 static Box make_domain_y (
Box const& domain)
408 domain.length(2)-1)),
413 domain.length(2)-1)),
418 static Box make_domain_z (
Box const& domain)
423 domain.length(1)-1)),
428 domain.length(1)-1)),
433 static std::pair<BoxArray,DistributionMapping>
434 make_layout_from_local_domain (std::array<int,AMREX_SPACEDIM>
const& local_start,
435 std::array<int,AMREX_SPACEDIM>
const& local_size);
437 template <
typename FA,
typename RT>
438 std::pair<std::unique_ptr<char,DataDeleter>,std::size_t>
439 install_raw_ptr (FA& fa, RT
const* p);
441 Plan<T> m_fft_fwd_x{};
442 Plan<T> m_fft_bwd_x{};
443 Plan<T> m_fft_fwd_y{};
444 Plan<T> m_fft_bwd_y{};
445 Plan<T> m_fft_fwd_z{};
446 Plan<T> m_fft_bwd_z{};
447 Plan<T> m_fft_fwd_x_half{};
448 Plan<T> m_fft_bwd_x_half{};
453 std::unique_ptr<MultiBlockCommMetaData> m_cmd_x2y;
454 std::unique_ptr<MultiBlockCommMetaData> m_cmd_y2x;
455 std::unique_ptr<MultiBlockCommMetaData> m_cmd_y2z;
456 std::unique_ptr<MultiBlockCommMetaData> m_cmd_z2y;
457 std::unique_ptr<MultiBlockCommMetaData> m_cmd_x2z;
458 std::unique_ptr<MultiBlockCommMetaData> m_cmd_z2x;
459 std::unique_ptr<MultiBlockCommMetaData> m_cmd_x2z_half;
460 std::unique_ptr<MultiBlockCommMetaData> m_cmd_z2x_half;
465 RotateFwd m_dtos_x2z{};
466 RotateBwd m_dtos_z2x{};
474 mutable cMF m_raw_cmf;
476 std::map<IntVect,MF> m_rx_aliases;
478 std::unique_ptr<char,DataDeleter> m_data_1;
479 std::unique_ptr<char,DataDeleter> m_data_2;
482 Box m_spectral_domain_x;
483 Box m_spectral_domain_y;
484 Box m_spectral_domain_z;
486 std::unique_ptr<R2C<T,D,C>> m_r2c_sub;
487 detail::SubHelper m_sub_helper;
491 bool m_do_alld_fft =
false;
492 bool m_slab_decomp =
false;
493 bool m_openbc_half =
false;
496template <
typename T, Direction D,
bool C>
498 : m_real_domain(domain),
499 m_spectral_domain_x(make_domain_x(domain)),
500#if (AMREX_SPACEDIM >= 2)
501 m_spectral_domain_y(make_domain_y(domain)),
502#if (AMREX_SPACEDIM == 3)
503 m_spectral_domain_z(make_domain_z(domain)),
506 m_sub_helper(domain),
511 static_assert(std::is_same_v<float,T> || std::is_same_v<double,T>);
514#if (AMREX_SPACEDIM == 2)
519 int(domain.
length(1) > 1) +
520 int(domain.
length(2) > 1)) >= 2);
525 Box subbox = m_sub_helper.make_box(m_real_domain);
526 if (subbox.
size() != m_real_domain.
size()) {
527 m_r2c_sub = std::make_unique<R2C<T,D,C>>(subbox, m_info);
535#if (AMREX_SPACEDIM == 3)
540 int shortside = m_real_domain.
shortside();
551 m_slab_decomp =
true;
553 m_slab_decomp =
true;
564 m_rx.define(bax, dmx, ncomp, 0,
MFInfo().SetAlloc(
false));
568 for (
auto & b : bl) {
570 b.setBig(0, m_spectral_domain_x.
bigEnd(0));
573 m_cx.
define(cbax, dmx, ncomp, 0,
MFInfo().SetAlloc(
false));
585#if (AMREX_SPACEDIM >= 2)
587 if ((m_real_domain.
length(1) > 1) && !m_slab_decomp && !m_info.
oned_mode)
591 if (cbay.size() == dmx.size()) {
594 cdmy = detail::make_iota_distromap(cbay.size());
596 m_cy.
define(cbay, cdmy, ncomp, 0,
MFInfo().SetAlloc(
false));
600#if (AMREX_SPACEDIM == 3)
602 m_real_domain.
length(1) > 1 &&
603 m_real_domain.
length(2) > 1)
606 {
false,
true,
true},
true);
608 if (cbaz.size() == dmx.size()) {
610 }
else if (cbaz.size() == cdmy.
size()) {
613 cdmz = detail::make_iota_distromap(cbaz.size());
615 m_cz.
define(cbaz, cdmz, ncomp, 0,
MFInfo().SetAlloc(
false));
621 m_data_1 = detail::make_mfs_share(m_rx, m_cx);
622 m_data_2 = detail::make_mfs_share(m_cz, m_cz);
624 m_data_1 = detail::make_mfs_share(m_rx, m_cz);
625 m_data_2 = detail::make_mfs_share(m_cy, m_cy);
627 if (myproc < m_cx.
size()) {
630 m_cx.
setFab(myproc, FAB(box, ncomp, m_rx[myproc].dataPtr()));
635 m_data_1 = detail::make_mfs_share(m_rx, m_cz);
636 m_data_2 = detail::make_mfs_share(m_cx, m_cx);
638 m_data_1 = detail::make_mfs_share(m_rx, m_cy);
639 m_data_2 = detail::make_mfs_share(m_cx, m_cz);
647#if (AMREX_SPACEDIM >= 2)
648 if (! m_cy.
empty()) {
650 m_cmd_x2y = std::make_unique<MultiBlockCommMetaData>
651 (m_cy, m_spectral_domain_y, m_cx,
IntVect(0), m_dtos_x2y);
652 m_cmd_y2x = std::make_unique<MultiBlockCommMetaData>
653 (m_cx, m_spectral_domain_x, m_cy,
IntVect(0), m_dtos_y2x);
656#if (AMREX_SPACEDIM == 3)
657 if (! m_cz.
empty() ) {
660 m_cmd_x2z = std::make_unique<MultiBlockCommMetaData>
661 (m_cz, m_spectral_domain_z, m_cx,
IntVect(0), m_dtos_x2z);
662 m_cmd_z2x = std::make_unique<MultiBlockCommMetaData>
663 (m_cx, m_spectral_domain_x, m_cz,
IntVect(0), m_dtos_z2x);
666 m_cmd_y2z = std::make_unique<MultiBlockCommMetaData>
667 (m_cz, m_spectral_domain_z, m_cy,
IntVect(0), m_dtos_y2z);
668 m_cmd_z2y = std::make_unique<MultiBlockCommMetaData>
669 (m_cy, m_spectral_domain_y, m_cz,
IntVect(0), m_dtos_z2y);
678 if (myproc < m_rx.size())
681 int ndims = m_slab_decomp ? 2 : 1;
682 std::tie(m_fft_fwd_x, m_fft_bwd_x) = make_c2c_plans(m_cx, ndims);
684 Box const& box = m_rx.box(myproc);
685 auto* pr = m_rx[myproc].dataPtr();
688 m_fft_fwd_x.template init_r2c<Direction::forward>(box, pr, pc, m_slab_decomp, ncomp);
689 m_fft_bwd_x = m_fft_fwd_x;
692 m_fft_fwd_x.template init_r2c<Direction::forward>(box, pr, pc, m_slab_decomp, ncomp);
695 m_fft_bwd_x.template init_r2c<Direction::backward>(box, pr, pc, m_slab_decomp, ncomp);
701#if (AMREX_SPACEDIM >= 2)
702 if (! m_cy.
empty()) {
703 std::tie(m_fft_fwd_y, m_fft_bwd_y) = make_c2c_plans(m_cy,1);
706#if (AMREX_SPACEDIM == 3)
707 if (! m_cz.
empty()) {
708 std::tie(m_fft_fwd_z, m_fft_bwd_z) = make_c2c_plans(m_cz,1);
715 m_data_1 = detail::make_mfs_share(m_rx, m_cx);
716 std::tie(m_fft_fwd_x, m_fft_bwd_x) = make_c2c_plans(m_cx,AMREX_SPACEDIM);
718 m_data_1 = detail::make_mfs_share(m_rx, m_rx);
719 m_data_2 = detail::make_mfs_share(m_cx, m_cx);
721 auto const& len = m_real_domain.
length();
722 auto* pr = (
void*)m_rx[0].dataPtr();
723 auto* pc = (
void*)m_cx[0].dataPtr();
725 m_fft_fwd_x.template init_r2c<Direction::forward>(len, pr, pc,
false, ncomp);
726 m_fft_bwd_x = m_fft_fwd_x;
729 m_fft_fwd_x.template init_r2c<Direction::forward>(len, pr, pc,
false, ncomp);
732 m_fft_bwd_x.template init_r2c<Direction::backward>(len, pr, pc,
false, ncomp);
739template <
typename T, Direction D,
bool C>
744template <
typename T, Direction D,
bool C>
747 if (m_fft_bwd_x.plan != m_fft_fwd_x.plan) {
748 m_fft_bwd_x.destroy();
750 if (m_fft_bwd_y.plan != m_fft_fwd_y.plan) {
751 m_fft_bwd_y.destroy();
753 if (m_fft_bwd_z.plan != m_fft_fwd_z.plan) {
754 m_fft_bwd_z.destroy();
756 m_fft_fwd_x.destroy();
757 m_fft_fwd_y.destroy();
758 m_fft_fwd_z.destroy();
759 if (m_fft_bwd_x_half.plan != m_fft_fwd_x_half.plan) {
760 m_fft_bwd_x_half.destroy();
762 m_fft_fwd_x_half.destroy();
765template <
typename T, Direction D,
bool C>
766std::pair<BoxArray,DistributionMapping>
768 std::array<int,AMREX_SPACEDIM>
const& local_size)
772 Box bx(lo, lo+len-1);
779 pmap.reserve(allboxes.size());
780 for (
int i = 0; i < allboxes.size(); ++i) {
781 if (allboxes[i].ok()) {
785 std::erase_if(allboxes, [=] (
Box const& b) {
return b.isEmpty(); });
786 BoxList bl(std::move(allboxes));
787 return std::make_pair(BoxArray(std::move(bl)), DistributionMapping(std::move(pmap)));
789 return std::make_pair(BoxArray(bx), DistributionMapping(Vector<int>({0})));
793template <
typename T, Direction D,
bool C>
795 std::array<int,AMREX_SPACEDIM>
const& local_size)
797 auto const& [ba, dm] = make_layout_from_local_domain(local_start, local_size);
798 m_raw_mf =
MF(ba, dm, m_rx.nComp(), 0,
MFInfo().SetAlloc(
false));
801template <
typename T, Direction D,
bool C>
802std::pair<std::array<int,AMREX_SPACEDIM>,std::array<int,AMREX_SPACEDIM>>
805 m_raw_mf =
MF(m_rx.boxArray(), m_rx.DistributionMap(), m_rx.nComp(), 0,
809 if (myproc < m_rx.size()) {
810 Box const& box = m_rx.box(myproc);
811 return std::make_pair(box.
smallEnd().toArray(),
814 return std::make_pair(std::array<int,AMREX_SPACEDIM>{
AMREX_D_DECL(0,0,0)},
819template <
typename T, Direction D,
bool C>
821 std::array<int,AMREX_SPACEDIM>
const& local_size)
823 auto const& [ba, dm] = make_layout_from_local_domain(local_start, local_size);
824 m_raw_cmf =
cMF(ba, dm, m_rx.nComp(), 0,
MFInfo().SetAlloc(
false));
827template <
typename T, Direction D,
bool C>
828std::pair<std::array<int,AMREX_SPACEDIM>,std::array<int,AMREX_SPACEDIM>>
831 auto const ncomp = m_info.batch_size;
832 auto const& [ba, dm] = getSpectralDataLayout();
837 if (myproc < m_raw_cmf.size()) {
838 Box const& box = m_raw_cmf.box(myproc);
839 return std::make_pair(box.
smallEnd().toArray(), box.
length().toArray());
841 return std::make_pair(std::array<int,AMREX_SPACEDIM>{
AMREX_D_DECL(0,0,0)},
846template <
typename T, Direction D,
bool C>
849 if (
C || m_r2c_sub) {
amrex::Abort(
"R2C: OpenBC not supported with reduced dimensions or complex inputs"); }
851#if (AMREX_SPACEDIM == 3)
852 if (m_do_alld_fft) {
return; }
854 auto const ncomp = m_info.batch_size;
856 if (m_slab_decomp && ! m_fft_fwd_x_half.defined) {
857 auto* fab = detail::get_fab(m_rx);
859 Box bottom_half = m_real_domain;
860 bottom_half.
growHi(2,-m_real_domain.length(2)/2);
861 Box box = fab->box() & bottom_half;
863 auto* pr = fab->dataPtr();
865 detail::get_fab(m_cx)->dataPtr();
867 m_fft_fwd_x_half.template init_r2c<Direction::forward>
868 (box, pr, pc, m_slab_decomp, ncomp);
869 m_fft_bwd_x_half = m_fft_fwd_x_half;
872 m_fft_fwd_x_half.template init_r2c<Direction::forward>
873 (box, pr, pc, m_slab_decomp, ncomp);
876 m_fft_bwd_x_half.template init_r2c<Direction::backward>
877 (box, pr, pc, m_slab_decomp, ncomp);
884 if (m_cmd_x2z && ! m_cmd_x2z_half) {
885 Box bottom_half = m_spectral_domain_z;
888 bottom_half.
growHi(0,-m_spectral_domain_z.length(0)/2);
889 m_cmd_x2z_half = std::make_unique<MultiBlockCommMetaData>
890 (m_cz, bottom_half, m_cx,
IntVect(0), m_dtos_x2z);
893 if (m_cmd_z2x && ! m_cmd_z2x_half) {
894 Box bottom_half = m_spectral_domain_x;
895 bottom_half.
growHi(2,-m_spectral_domain_x.length(2)/2);
896 m_cmd_z2x_half = std::make_unique<MultiBlockCommMetaData>
897 (m_cx, bottom_half, m_cz,
IntVect(0), m_dtos_z2x);
902template <
typename T, Direction D,
bool C>
904R2C<T,D,C>::make_m_rx_alias (
IndexType const& ix_type)
906 auto const key = ix_type.ixType();
907 auto it = m_rx_aliases.find(key);
908 if (it != m_rx_aliases.end()) {
913 for (
auto b : m_rx.
boxArray().boxList()) {
918 MF alias(BoxArray(std::move(bl)), m_rx.DistributionMap(), m_rx.nComp(),
919 m_rx.nGrowVect(), MFInfo{}.SetAlloc(
false));
921 using FAB =
typename MF::fab_type;
922 for (MFIter mfi(alias, MFItInfo().DisableDeviceSync()); mfi.isValid(); ++mfi) {
923 alias.setFab(mfi, FAB(mfi.fabbox(), m_rx.nComp(), m_rx[mfi.index()].dataPtr()));
926 auto [alias_it, inserted] = m_rx_aliases.emplace(key, std::move(alias));
928 return alias_it->second;
931template <
typename T, Direction D,
bool C>
933R2C<T,D,C>::make_m_rx_alias_periodicity (
IndexType const& ix_type,
934 Periodicity
const& period)
const
936 IntVect per = period.intVect();
937 for (
int idim = 0; idim < AMREX_SPACEDIM; ++idim) {
938 if (ix_type.nodeCentered(idim) && per[idim] == 0) {
939 per[idim] = m_real_domain.length(idim);
942 return Periodicity(per);
945template <
typename T, Direction D,
bool C>
946template <Direction DIR>
952 auto const ncomp = m_info.batch_size;
955 if (m_sub_helper.ghost_safe(inmf.nGrowVect())) {
956 m_r2c_sub->forward(m_sub_helper.make_alias_mf(inmf), incomp);
958 MF tmp(inmf.boxArray(), inmf.DistributionMap(), ncomp, 0);
959 tmp.LocalCopy(inmf, incomp, 0, ncomp,
IntVect(0));
960 m_r2c_sub->forward(m_sub_helper.make_alias_mf(tmp),0);
965 if (&m_rx != &inmf) {
966 if (m_rx.boxArray().ixType() == inmf.boxArray().ixType()) {
967 m_rx.ParallelCopy(inmf, incomp, 0, ncomp);
969 MF& rx_alias = make_m_rx_alias(inmf.boxArray().ixType());
970 rx_alias.ParallelCopy(inmf, incomp, 0, ncomp);
976 m_fft_fwd_x.template compute_c2c<Direction::forward>();
978 m_fft_fwd_x.template compute_r2c<Direction::forward>();
983 auto& fft_x = m_openbc_half ? m_fft_fwd_x_half : m_fft_fwd_x;
985 fft_x.template compute_c2c<Direction::forward>();
987 fft_x.template compute_r2c<Direction::forward>();
991 ParallelCopy(m_cy, m_cx, *m_cmd_x2y, 0, 0, ncomp, m_dtos_x2y);
993 m_fft_fwd_y.template compute_c2c<Direction::forward>();
996 ParallelCopy(m_cz, m_cy, *m_cmd_y2z, 0, 0, ncomp, m_dtos_y2z);
998#if (AMREX_SPACEDIM == 3)
999 else if ( m_cmd_x2z) {
1000 if (m_openbc_half) {
1004 {components, m_dtos_x2z};
1005 auto handler = ParallelCopy_nowait(m_cz, m_cx, *m_cmd_x2z_half, packing);
1007 Box upper_half = m_spectral_domain_z;
1010 upper_half.
growLo (0,-m_spectral_domain_z.length(0)/2);
1011 m_cz.setVal(0, upper_half, 0, ncomp);
1013 ParallelCopy_finish(m_cz, std::move(handler), *m_cmd_x2z_half, packing);
1015 ParallelCopy(m_cz, m_cx, *m_cmd_x2z, 0, 0, ncomp, m_dtos_x2z);
1019 m_fft_fwd_z.template compute_c2c<Direction::forward>();
1022template <
typename T, Direction D,
bool C>
1023template <
typename FA,
typename RT>
1024std::pair<std::unique_ptr<char,DataDeleter>,std::size_t>
1029 using FAB =
typename FA::FABType::value_type;
1030 using T_FAB =
typename FAB::value_type;
1031 static_assert(
sizeof(T_FAB) ==
sizeof(RT));
1033 auto const ncomp = m_info.batch_size;
1034 auto const& ia = fa.IndexArray();
1036 T_FAB*
pp =
nullptr;
1039 if ( ! ia.empty() ) {
1041 Box const& box = fa.fabbox(K);
1045 sz =
sizeof(T_FAB) * box.
numPts() * ncomp;
1048 fa.setFab(K, FAB(box,ncomp,
pp));
1052 return std::make_pair(std::unique_ptr<char,DataDeleter>{},std::size_t(0));
1054 return std::make_pair(std::unique_ptr<char,DataDeleter>
1060template <
typename T, Direction D,
bool C>
1061template <
typename RT,
typename CT, Direction DIR,
bool CP>
1063 && (((
sizeof(RT)*2 ==
sizeof(CT)) && (!CP))
1064 || ((
sizeof(RT) ==
sizeof(CT)) && CP))
1067 auto [rdata, rsz] = install_raw_ptr(m_raw_mf, in);
1068 auto [cdata, csz] = install_raw_ptr(m_raw_cmf, out);
1083template <
typename T, Direction D,
bool C>
1084template <Direction DIR>
1091template <
typename T, Direction D,
bool C>
1097 auto const ncomp = m_info.batch_size;
1100 if (m_sub_helper.ghost_safe(outmf.nGrowVect())) {
1101 MF submf = m_sub_helper.make_alias_mf(outmf);
1102 IntVect const& subngout = m_sub_helper.make_iv(ngout);
1103 Periodicity const& subperiod = m_sub_helper.make_periodicity(period);
1104 m_r2c_sub->backward_doit(submf, subngout, subperiod, outcomp);
1106 MF tmp(outmf.boxArray(), outmf.DistributionMap(), ncomp,
1107 m_sub_helper.make_safe_ghost(outmf.nGrowVect()));
1108 this->backward_doit(tmp, ngout, period, 0);
1109 outmf.LocalCopy(tmp, 0, outcomp, ncomp, tmp.nGrowVect());
1114 if (m_do_alld_fft) {
1116 m_fft_bwd_x.template compute_c2c<Direction::backward>();
1118 m_fft_bwd_x.template compute_r2c<Direction::backward>();
1121 if (m_rx.boxArray().ixType() == outmf.boxArray().ixType()) {
1122 outmf.ParallelCopy(m_rx, 0, outcomp, ncomp,
IntVect(0),
1123 dst_nghost, period);
1125 MF& rx_alias = make_m_rx_alias(outmf.boxArray().ixType());
1126 auto const copy_period = make_m_rx_alias_periodicity(outmf.boxArray().ixType(), period);
1127 outmf.ParallelCopy(rx_alias, 0, outcomp, ncomp,
IntVect(0),
1128 dst_nghost, copy_period);
1133 m_fft_bwd_z.template compute_c2c<Direction::backward>();
1135 ParallelCopy(m_cy, m_cz, *m_cmd_z2y, 0, 0, ncomp, m_dtos_z2y);
1137#if (AMREX_SPACEDIM == 3)
1138 else if ( m_cmd_z2x) {
1139 auto const& cmd = m_openbc_half ? m_cmd_z2x_half : m_cmd_z2x;
1140 ParallelCopy(m_cx, m_cz, *cmd, 0, 0, ncomp, m_dtos_z2x);
1144 m_fft_bwd_y.template compute_c2c<Direction::backward>();
1146 ParallelCopy(m_cx, m_cy, *m_cmd_y2x, 0, 0, ncomp, m_dtos_y2x);
1149 auto& fft_x = m_openbc_half ? m_fft_bwd_x_half : m_fft_bwd_x;
1151 fft_x.template compute_c2c<Direction::backward>();
1153 fft_x.template compute_r2c<Direction::backward>();
1156 if (m_rx.boxArray().ixType() == outmf.boxArray().ixType()) {
1157 outmf.ParallelCopy(m_rx, 0, outcomp, ncomp,
IntVect(0),
1158 dst_nghost, period);
1160 MF& rx_alias = make_m_rx_alias(outmf.boxArray().ixType());
1161 auto const copy_period = make_m_rx_alias_periodicity(outmf.boxArray().ixType(), period);
1162 outmf.ParallelCopy(rx_alias, 0, outcomp, ncomp,
IntVect(0),
1163 dst_nghost, copy_period);
1167template <
typename T, Direction D,
bool C>
1168template <
typename CT,
typename RT, Direction DIR,
bool CP>
1170 && (((
sizeof(RT)*2 ==
sizeof(CT)) && (!CP))
1171 || ((
sizeof(RT) ==
sizeof(CT)) && CP))
1174 auto [rdata, rsz] = install_raw_ptr(m_raw_mf, out);
1175 auto [cdata, csz] = install_raw_ptr(m_raw_cmf, in);
1190template <
typename T, Direction D,
bool C>
1197 auto* fab = detail::get_fab(inout);
1198 if (!fab) {
return {fwd, bwd};}
1200 Box const& box = fab->box();
1203 auto const ncomp = m_info.batch_size;
1205#ifdef AMREX_USE_SYCL
1206 fwd.template init_c2c<Direction::forward>(box, pio, ncomp, ndims);
1210 fwd.template init_c2c<Direction::forward>(box, pio, ncomp, ndims);
1213 bwd.template init_c2c<Direction::backward>(box, pio, ncomp, ndims);
1220template <
typename T, Direction D,
bool C>
1221template <
typename F>
1224 if (m_info.twod_mode || m_info.batch_size > 1) {
1226#if (AMREX_SPACEDIM > 1)
1227 }
else if (m_r2c_sub) {
1229#if (AMREX_SPACEDIM == 2)
1231 m_r2c_sub->post_forward_doit_1
1234 post_forward(0, i, 0, sp);
1237 if (m_real_domain.length(0) == 1 && m_real_domain.length(1) == 1) {
1239 m_r2c_sub->post_forward_doit_1
1242 post_forward(0, 0, i, sp);
1244 }
else if (m_real_domain.length(0) == 1 && m_real_domain.length(2) == 1) {
1246 m_r2c_sub->post_forward_doit_1
1249 post_forward(0, i, 0, sp);
1251 }
else if (m_real_domain.length(0) == 1) {
1253 m_r2c_sub->post_forward_doit_1
1256 post_forward(0, i, j, sp);
1258 }
else if (m_real_domain.length(1) == 1) {
1260 m_r2c_sub->post_forward_doit_1
1263 post_forward(i, 0, j, sp);
1266 amrex::Abort(
"R2c::post_forward_doit_0: how did this happen?");
1271 this->post_forward_doit_1(post_forward);
1275template <
typename T, Direction D,
bool C>
1276template <
typename F>
1279 if (m_info.twod_mode || m_info.batch_size > 1) {
1281 }
else if (m_r2c_sub) {
1282 amrex::Abort(
"R2C::post_forward_doit_1: How did this happen?");
1284 if ( ! m_cz.empty()) {
1285 auto* spectral_fab = detail::get_fab(m_cz);
1287 auto const& a = spectral_fab->array();
1291 post_forward(jx,ky,iz,a(iz,jx,ky));
1294 }
else if ( ! m_cy.empty()) {
1295 auto* spectral_fab = detail::get_fab(m_cy);
1297 auto const& a = spectral_fab->array();
1301 post_forward(jx,iy,k,a(iy,jx,k));
1305 auto* spectral_fab = detail::get_fab(m_cx);
1307 auto const& a = spectral_fab->array();
1311 post_forward(i,j,k,a(i,j,k));
1318template <
typename T, Direction D,
bool C>
1321#if (AMREX_SPACEDIM == 3)
1322 if (m_info.oned_mode && !m_info.twod_mode) {
1323 return T(1)/T(
Long(m_real_domain.length(0)));
1324 }
else if (m_info.twod_mode) {
1325 return T(1)/T(
Long(m_real_domain.length(0)) *
1326 Long(m_real_domain.length(1)));
1328#elif (AMREX_SPACEDIM == 2)
1329 if (m_info.oned_mode) {
1330 return T(1)/T(
Long(m_real_domain.length(0)));
1334 return T(1)/T(m_real_domain.numPts());
1338template <
typename T, Direction D,
bool C>
1339template <Direction DIR>
1344#if (AMREX_SPACEDIM > 1)
1347 return std::make_pair(cmf, m_sub_helper.inverse_order(order));
1350 if (!m_cz.empty()) {
1352 }
else if (!m_cy.empty()) {
1359template <
typename T, Direction D,
bool C>
1360template <Direction DIR>
1366 auto const ncomp = m_info.batch_size;
1370 bool inmf_safe = m_sub_helper.ghost_safe(inmf.nGrowVect());
1371 MF inmf_sub, inmf_tmp;
1374 inmf_sub = m_sub_helper.make_alias_mf(inmf);
1375 incomp_sub = incomp;
1377 inmf_tmp.define(inmf.boxArray(), inmf.DistributionMap(), ncomp, 0);
1378 inmf_tmp.LocalCopy(inmf, incomp, 0, ncomp,
IntVect(0));
1379 inmf_sub = m_sub_helper.make_alias_mf(inmf_tmp);
1383 bool outmf_safe = m_sub_helper.ghost_safe(outmf.
nGrowVect());
1384 cMF outmf_sub, outmf_tmp;
1387 outmf_sub = m_sub_helper.make_alias_mf(outmf);
1388 outcomp_sub = outcomp;
1391 outmf_sub = m_sub_helper.make_alias_mf(outmf_tmp);
1395 m_r2c_sub->forward(inmf_sub, outmf_sub, incomp_sub, outcomp_sub);
1404 if (!m_cz.empty()) {
1407 (outmf, m_spectral_domain_x, m_cz,
IntVect(0), dtos);
1408 ParallelCopy(outmf, m_cz, cmd, 0, outcomp, ncomp, dtos);
1409 }
else if (!m_cy.empty()) {
1411 (outmf, m_spectral_domain_x, m_cy,
IntVect(0), m_dtos_y2x);
1412 ParallelCopy(outmf, m_cy, cmd, 0, outcomp, ncomp, m_dtos_y2x);
1419template <
typename T, Direction D,
bool C>
1420template <Direction DIR>
1427template <
typename T, Direction D,
bool C>
1429 Periodicity const& period,
int incomp,
int outcomp)
1433 auto const ncomp = m_info.batch_size;
1437 bool inmf_safe = m_sub_helper.ghost_safe(inmf.nGrowVect());
1438 cMF inmf_sub, inmf_tmp;
1441 inmf_sub = m_sub_helper.make_alias_mf(inmf);
1442 incomp_sub = incomp;
1444 inmf_tmp.define(inmf.boxArray(), inmf.DistributionMap(), ncomp, 0);
1445 inmf_tmp.LocalCopy(inmf, incomp, 0, ncomp,
IntVect(0));
1446 inmf_sub = m_sub_helper.make_alias_mf(inmf_tmp);
1450 bool outmf_safe = m_sub_helper.ghost_safe(outmf.nGrowVect());
1451 MF outmf_sub, outmf_tmp;
1454 outmf_sub = m_sub_helper.make_alias_mf(outmf);
1455 outcomp_sub = outcomp;
1457 IntVect const& ngtmp = m_sub_helper.make_safe_ghost(outmf.nGrowVect());
1458 outmf_tmp.define(outmf.boxArray(), outmf.DistributionMap(), ncomp, ngtmp);
1459 outmf_sub = m_sub_helper.make_alias_mf(outmf_tmp);
1463 IntVect const& subngout = m_sub_helper.make_iv(ngout);
1464 Periodicity
const& subperiod = m_sub_helper.make_periodicity(period);
1465 m_r2c_sub->backward_doit(inmf_sub, outmf_sub, subngout, subperiod, incomp_sub, outcomp_sub);
1468 outmf.LocalCopy(outmf_tmp, 0, outcomp, ncomp, outmf_tmp.nGrowVect());
1473 if (!m_cz.empty()) {
1475 MultiBlockCommMetaData cmd
1476 (m_cz, m_spectral_domain_z, inmf,
IntVect(0), dtos);
1478 }
else if (!m_cy.empty()) {
1479 MultiBlockCommMetaData cmd
1480 (m_cy, m_spectral_domain_y, inmf,
IntVect(0), m_dtos_x2y);
1481 ParallelCopy(m_cy, inmf, cmd, incomp, 0, ncomp, m_dtos_x2y);
1483 m_cx.ParallelCopy(inmf, incomp, 0, ncomp);
1485 backward_doit(outmf, ngout, period, outcomp);
1489template <
typename T, Direction D,
bool C>
1490std::pair<BoxArray,DistributionMapping>
1493#if (AMREX_SPACEDIM > 1)
1495 auto const& [ba, dm] = m_r2c_sub->getSpectralDataLayout();
1496 return std::make_pair(m_sub_helper.inverse_boxarray(ba), dm);
1500#if (AMREX_SPACEDIM == 3)
1501 if (!m_cz.empty()) {
1502 BoxList bl = m_cz.boxArray().boxList();
1503 for (
auto& b : bl) {
1504 auto lo = b.smallEnd();
1505 auto hi = b.bigEnd();
1506 std::swap(lo[0], lo[1]);
1507 std::swap(lo[1], lo[2]);
1508 std::swap(hi[0], hi[1]);
1509 std::swap(hi[1], hi[2]);
1513 return std::make_pair(
BoxArray(std::move(bl)), m_cz.DistributionMap());
1516#if (AMREX_SPACEDIM >= 2)
1517 if (!m_cy.empty()) {
1518 BoxList bl = m_cy.boxArray().boxList();
1519 for (
auto& b : bl) {
1520 auto lo = b.smallEnd();
1521 auto hi = b.bigEnd();
1522 std::swap(lo[0], lo[1]);
1523 std::swap(hi[0], hi[1]);
1527 return std::make_pair(
BoxArray(std::move(bl)), m_cy.DistributionMap());
1531 return std::make_pair(m_cx.boxArray(), m_cx.DistributionMap());
1536template <
typename T = Real, FFT::Direction D = FFT::Direction::both>
#define BL_PROFILE(a)
Definition AMReX_BLProfiler.H:551
#define AMREX_ALWAYS_ASSERT_WITH_MESSAGE(EX, MSG)
Definition AMReX_BLassert.H:49
#define AMREX_ALWAYS_ASSERT(EX)
Definition AMReX_BLassert.H:50
#define AMREX_GPU_DEVICE
Definition AMReX_GpuQualifiers.H:18
amrex::ParmParse pp
Input file parser instance for the given namespace.
Definition AMReX_HypreIJIface.cpp:15
#define AMREX_D_DECL(a, b, c)
Definition AMReX_SPACE.H:171
virtual void * alloc(std::size_t sz)=0
A collection of Boxes stored in an Array.
Definition AMReX_BoxArray.H:564
A class for managing a List of Boxes that share a common IndexType. This class implements operations ...
Definition AMReX_BoxList.H:52
BoxList & shift(int dir, int nzones)
Applies Box::shift(int,int) to each Box in the BoxList.
Definition AMReX_BoxList.cpp:563
__host__ __device__ const IntVectND< dim > & bigEnd() const &noexcept
Return the inclusive upper bound of the box.
Definition AMReX_Box.H:124
__host__ __device__ Long numPts() const noexcept
Return the number of points contained in the BoxND.
Definition AMReX_Box.H:364
__host__ __device__ IntVectND< dim > length() const noexcept
Return the length of the BoxND.
Definition AMReX_Box.H:155
__host__ __device__ int shortside(int &dir) const noexcept
Return length of shortest side. dir is modified to give direction with shortest side: 0....
Definition AMReX_Box.H:445
__host__ __device__ IntVectND< dim > size() const noexcept
Return the length of the BoxND.
Definition AMReX_Box.H:148
__host__ __device__ BoxND & growLo(int idir, int n_cell=1) noexcept
Grow the BoxND on the low end by n_cell cells in direction idir. NOTE: n_cell negative shrinks the Bo...
Definition AMReX_Box.H:670
__host__ __device__ IndexTypeND< dim > ixType() const noexcept
Return the indexing type.
Definition AMReX_Box.H:136
__host__ __device__ BoxND & growHi(int idir, int n_cell=1) noexcept
Grow the BoxND on the high end by n_cell cells in direction idir. NOTE: n_cell negative shrinks the B...
Definition AMReX_Box.H:681
__host__ __device__ const IntVectND< dim > & smallEnd() const &noexcept
Return the inclusive lower bound of the box.
Definition AMReX_Box.H:112
Calculates the distribution of FABs to MPI processes.
Definition AMReX_DistributionMapping.H:43
Long size() const noexcept
Length of the underlying processor map.
Definition AMReX_DistributionMapping.H:129
Convolution-based solver for open boundary conditions using Green's functions.
Definition AMReX_FFT_OpenBCSolver.H:26
3D Poisson solver for periodic, Dirichlet & Neumann boundaries in the first two dimensions,...
Definition AMReX_FFT_Poisson.H:164
Poisson solver for periodic, Dirichlet & Neumann boundaries using FFT.
Definition AMReX_FFT_Poisson.H:32
Parallel Discrete Fourier Transform.
Definition AMReX_FFT_R2C.H:48
std::conditional_t< C, cMF, std::conditional_t< std::is_same_v< T, Real >, MultiFab, FabArray< BaseFab< T > > > > MF
Definition AMReX_FFT_R2C.H:53
R2C & operator=(R2C const &)=delete
~R2C()
Definition AMReX_FFT_R2C.H:745
void setLocalDomain(std::array< int, 3 > const &local_start, std::array< int, 3 > const &local_size)
Set local domain.
Definition AMReX_FFT_R2C.H:794
R2C(Box const &domain, Info const &info=Info{})
Constructor.
Definition AMReX_FFT_R2C.H:497
void post_forward_doit_1(F const &post_forward)
CUDA-visible helper that redistributes and applies post_forward for the batched layout.
Definition AMReX_FFT_R2C.H:1277
T scalingFactor() const
Scaling factor. If the data goes through forward and then backward, the result multiplied by the scal...
Definition AMReX_FFT_R2C.H:1319
std::pair< cMF *, IntVect > getSpectralData() const
Get the internal spectral data.
void post_forward_doit_0(F const &post_forward)
CUDA-visible hook that walks internal spectral data and applies post_forward.
Definition AMReX_FFT_R2C.H:1222
std::pair< std::array< int, 3 >, std::array< int, 3 > > getLocalDomain() const
Get local domain.
Definition AMReX_FFT_R2C.H:803
std::pair< BoxArray, DistributionMapping > getSpectralDataLayout() const
Get BoxArray and DistributionMapping for spectral data.
Definition AMReX_FFT_R2C.H:1491
void forwardThenBackward(MF const &inmf, MF &outmf, F const &post_forward, int incomp=0, int outcomp=0)
Forward and then backward transform.
Definition AMReX_FFT_R2C.H:203
R2C(std::array< int, 3 > const &domain_size, Info const &info=Info{})
Constructor.
Definition AMReX_FFT_R2C.H:740
FabArray< BaseFab< GpuComplex< T > > > cMF
Definition AMReX_FFT_R2C.H:50
std::pair< std::array< int, 3 >, std::array< int, 3 > > getLocalSpectralDomain() const
Get local spectral domain.
Definition AMReX_FFT_R2C.H:829
void setLocalSpectralDomain(std::array< int, 3 > const &local_start, std::array< int, 3 > const &local_size)
Set local spectral domain.
Definition AMReX_FFT_R2C.H:820
IntVect nGrowVect() const noexcept
Definition AMReX_FabArrayBase.H:80
int size() const noexcept
Return the number of FABs in the FabArray.
Definition AMReX_FabArrayBase.H:110
const DistributionMapping & DistributionMap() const noexcept
Return constant reference to associated DistributionMapping.
Definition AMReX_FabArrayBase.H:130
bool empty() const noexcept
Definition AMReX_FabArrayBase.H:89
Box fabbox(int K) const noexcept
Return the Kth FABs Box in the FabArray. That is, the region the Kth fab is actually defined on.
Definition AMReX_FabArrayBase.cpp:217
const BoxArray & boxArray() const noexcept
Return a constant reference to the BoxArray that defines the valid region associated with this FabArr...
Definition AMReX_FabArrayBase.H:95
void setFab(int boxno, std::unique_ptr< FAB > elem)
Explicitly set the Kth FAB in the FabArray to point to elem.
Definition AMReX_FabArray.H:2397
void ParallelCopy(const FabArray< FAB > &src, const Periodicity &period=Periodicity::NonPeriodic(), CpOp op=FabArrayBase::COPY)
Definition AMReX_FabArray.H:873
typename std::conditional_t< IsBaseFab< BaseFab< GpuComplex< T > > >::value, BaseFab< GpuComplex< T > >, FABType >::value_type value_type
Definition AMReX_FabArray.H:355
void define(const BoxArray &bxs, const DistributionMapping &dm, int nvar, int ngrow, const MFInfo &info=MFInfo(), const FabFactory< FAB > &factory=DefaultFabFactory< FAB >())
Define this FabArray identically to that performed by the constructor having an analogous function si...
Definition AMReX_FabArray.H:2213
void LocalCopy(FabArray< SFAB > const &src, int scomp, int dcomp, int ncomp, IntVect const &nghost)
Perform local copy of FabArray data.
Definition AMReX_FabArray.H:1989
A collection (stored as an array) of FArrayBox objects.
Definition AMReX_MultiFab.H:40
This provides length of period for periodic domains. 0 means it is not periodic in that direction....
Definition AMReX_Periodicity.H:17
static const Periodicity & NonPeriodic() noexcept
Definition AMReX_Periodicity.cpp:52
This class is a thin wrapper around std::vector. Unlike vector, Vector::operator[] provides bound che...
Definition AMReX_Vector.H:29
amrex_long Long
Definition AMReX_INT.H:30
void ParallelForOMP(T n, L const &f) noexcept
Performance-portable kernel launch function with optional OpenMP threading.
Definition AMReX_GpuLaunch.H:328
Arena * The_Arena()
Definition AMReX_Arena.cpp:820
int NProcs() noexcept
Definition AMReX_ParallelDescriptor.H:255
Definition AMReX_FFT_Helper.H:53
void dtod_memcpy_async(void *p_d_dst, const void *p_d_src, const std::size_t sz) noexcept
Definition AMReX_GpuDevice.H:449
void streamSynchronize() noexcept
Definition AMReX_GpuDevice.H:310
MPI_Comm CommunicatorSub() noexcept
sub-communicator for current frame
Definition AMReX_ParallelContext.H:70
int MyProcSub() noexcept
my sub-rank in current frame
Definition AMReX_ParallelContext.H:76
int local_to_global_rank(int rank) noexcept
translate between local rank and global rank
Definition AMReX_ParallelContext.H:95
int NProcsSub() noexcept
number of ranks in current frame
Definition AMReX_ParallelContext.H:74
__host__ __device__ void ignore_unused(const Ts &...)
This shuts up the compiler about unused variables.
Definition AMReX.H:139
BoxND< 3 > Box
Box is an alias for amrex::BoxND instantiated with AMREX_SPACEDIM.
Definition AMReX_BaseFwd.H:30
bool is_aligned(const void *p, std::size_t alignment) noexcept
Return whether the address p is aligned to alignment bytes.
Definition AMReX_Arena.H:39
IndexTypeND< 3 > IndexType
IndexType is an alias for amrex::IndexTypeND instantiated with AMREX_SPACEDIM.
Definition AMReX_BaseFwd.H:36
void ParallelCopy(MF &dst, MF const &src, int scomp, int dcomp, int ncomp, IntVect const &ng_src=IntVect(0), IntVect const &ng_dst=IntVect(0), Periodicity const &period=Periodicity::NonPeriodic())
dst = src w/ MPI communication
Definition AMReX_FabArrayUtility.H:1951
BoxArray decompose(Box const &domain, int nboxes, Array< bool, 3 > const &decomp, bool no_overlap)
Decompose domain box into BoxArray.
Definition AMReX_BoxArray.cpp:1943
IntVectND< 3 > IntVect
IntVect is an alias for amrex::IntVectND instantiated with AMREX_SPACEDIM.
Definition AMReX_BaseFwd.H:33
void Abort(const std::string &msg)
Print out message to cerr and exit via abort().
Definition AMReX.cpp:241
__host__ __device__ constexpr T elemwiseMin(T const &a, T const &b) noexcept
Return the element-wise minimum of the given values for types like XDim3.
Definition AMReX_Algorithm.H:63
BoxArray const & boxArray(FabArrayBase const &fa)
Definition AMReX_FabArrayBase.cpp:2862
Definition AMReX_FFT_Helper.H:83
bool twod_mode
Definition AMReX_FFT_Helper.H:94
bool oned_mode
Definition AMReX_FFT_Helper.H:103
int batch_size
Batched FFT size. Only support in R2C, not R2X.
Definition AMReX_FFT_Helper.H:106
DomainStrategy domain_strategy
Domain composition strategy.
Definition AMReX_FFT_Helper.H:85
int nprocs
Max number of processes to use.
Definition AMReX_FFT_Helper.H:109
int pencil_threshold
Definition AMReX_FFT_Helper.H:89
Definition AMReX_FFT_Helper.H:360
std::conditional_t< std::is_same_v< float, T >, cuComplex, cuDoubleComplex > VendorComplex
Definition AMReX_FFT_Helper.H:364
FabArray memory allocation information.
Definition AMReX_FabArray.H:68
MFInfo & SetAlloc(bool a) noexcept
Definition AMReX_FabArray.H:75
This class specializes behaviour on local copies and unpacking receive buffers.
Definition AMReX_NonLocalBC.H:642
Contains information about which components take part of the data transaction.
Definition AMReX_NonLocalBC.H:550
int n_components
Definition AMReX_NonLocalBC.H:553
Communication datatype (note: this structure also works without MPI)
Definition AMReX_ccse-mpi.H:78