src/FFT/FFTBase.cpp

Go to the documentation of this file.

// -*- C++ -*-
/***************************************************************************
 *
 * The IPPL Framework
 * 
 * This program was prepared by PSI. 
 * All rights in the program are reserved by PSI.
 * Neither PSI nor the author(s)
 * makes any warranty, express or implied, or assumes any liability or
 * responsibility for the use of this software
 *
 * Visit http://www.acl.lanl.gov/POOMS for more details
 *
 ***************************************************************************/

// -*- C++ -*-
/***************************************************************************
 *
 * The IPPL Framework
 * 
 *
 * Visit http://people.web.psi.ch/adelmann/ for more details
 *
 ***************************************************************************/

// include files
#include "FFT/FFTBase.h"
#include "Utility/PAssert.h"

/***************************************************************************
  FFTBase.cpp:  constructors and write() member function for FFTBase class
 ***************************************************************************/


// instantiate static null GC object
template <unsigned Dim, class T>
GuardCellSizes<Dim> FFTBase<Dim,T>::nullGC = GuardCellSizes<Dim>();

//=============================================================================
// FFTBase Constructors
//=============================================================================

template <unsigned Dim, class T>
FFTBase<Dim,T>::FFTBase(FFTBase<Dim,T>::FFT_e transform,
                        const FFTBase<Dim,T>::Domain_t& domain, 
                        const bool transformTheseDims[Dim], bool compressTemps)
  : transformType_m(transform),               // transform type
    Domain_m(domain),                         // field domain
    compressTempFields_m(compressTemps)       // compress temp fields?
{

  // Tau profiling
  TAU_TYPE_STRING(taustr, " (FFT_e, " + CT(domain) + ", bool [], bool)");
  TAU_PROFILE("FFTBase::FFTBase", taustr, TAU_FFT);

  // Store which dims are transformed, and count up how many there are
  nTransformDims_m = 0;
  unsigned d;
  for (d=0; d<Dim; ++d) {
    transformDims_m[d] = transformTheseDims[d];
    if (transformTheseDims[d]) ++nTransformDims_m;
  }

  // check that at least one dimension is being transformed
  PInsist(nTransformDims_m>0,"Must transform at least one axis!!");

  // Store the "names" (0,1,2) of these dims in an array of computed size
  activeDims_m = new unsigned[nTransformDims_m];
  int icount = 0;
  for (d=0; d<Dim; ++d)
    if (transformDims_m[d]) activeDims_m[icount++] = d;

}

template <unsigned Dim, class T>
FFTBase<Dim,T>::FFTBase(FFTBase<Dim,T>::FFT_e transform,
                        const FFTBase<Dim,T>::Domain_t& domain,
                        bool compressTemps) 
  : transformType_m(transform),               // transform type
    Domain_m(domain),                         // field domain
    compressTempFields_m(compressTemps)       // compress temp fields?
{

  // Tau profiling
  TAU_TYPE_STRING(taustr, " (FFT_e, " + CT(domain) + ", bool)");
  TAU_PROFILE("FFTBase::FFTBase", taustr, TAU_FFT); 

  // Default, transform all dims:
  nTransformDims_m = Dim;
  activeDims_m = new unsigned[Dim];
  for (unsigned d=0; d<Dim; d++) {
    transformDims_m[d] = true;
    activeDims_m[d] = d;
  }

}

//-----------------------------------------------------------------------------
// I/O: write out information about FFT object:
//-----------------------------------------------------------------------------

template <unsigned Dim, class T>
void FFTBase<Dim,T>::write(ostream& out) const {

  // Tau profiling
  TAU_TYPE_STRING(taustr, " (ostream&)");
  TAU_PROFILE("void " + CT(*this) + "::write", taustr, TAU_FFT | TAU_IO);

  // Dump contents of FFT object
  out << "---------------FFT Object Dump Begin-------------------" << endl;
  // Output the user-defined names for transform directions:
  out << "Map of transform direction names:" << endl;
  map<char*,unsigned>::const_iterator mi, m_end = directions_m.end();
  for (mi = directions_m.begin(); mi != m_end; ++mi)
    out << "[" << (*mi).first << "," << (*mi).second << "]" << endl;
  // Output type of transform
  out << "Transform type = " << transformTypeString_g[transformType_m] << endl;
  // Output which dims are transformed:
  out << "Transform dimensions: ";
  for (unsigned d=0; d<Dim; ++d) {
    out << "dim " << d << " = ";
    if (transformDims_m[d])
      out << "true" << endl;
    else
      out << "false" << endl;
  }
  out << endl;
  out << "Input Field domain = " << Domain_m << endl; // Output the domain.
  out << "---------------FFT Object Dump End---------------------" << endl;

  return;
}


/***************************************************************************
 * $RCSfile: FFTBase.cpp,v $   $Author: adelmann $
 * $Revision: 1.1.1.1 $   $Date: 2003/01/23 07:40:25 $
 * IPPL_VERSION_ID: $Id: FFTBase.cpp,v 1.1.1.1 2003/01/23 07:40:25 adelmann Exp $ 
 ***************************************************************************/

---