Amplitude.h

Go to the documentation of this file.

#if !defined( AMPLITUDE )
#define AMPLITUDE

//******************************************************************************
// This file is part of AmpTools, a package for performing Amplitude Analysis
// 
// Copyright Trustees of Indiana University 2010, all rights reserved
// 
// This software written by Matthew Shepherd, Ryan Mitchell, and 
//                  Hrayr Matevosyan at Indiana University, Bloomington
// 
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// 1. Redistributions of source code must retain the above copyright
//    notice and author attribution, this list of conditions and the
//    following disclaimer. 
// 2. Redistributions in binary form must reproduce the above copyright
//    notice and author attribution, this list of conditions and the
//    following disclaimer in the documentation and/or other materials
//    provided with the distribution.
// 3. Neither the name of the University nor the names of its contributors
//    may be used to endorse or promote products derived from this software
//    without specific prior written permission.
// 
// Creation of derivative forms of this software for commercial
// utilization may be subject to restriction; written permission may be
// obtained from the Trustees of Indiana University.
// 
// INDIANA UNIVERSITY AND THE AUTHORS MAKE NO REPRESENTATIONS OR WARRANTIES, 
// EXPRESS OR IMPLIED.  By way of example, but not limitation, INDIANA 
// UNIVERSITY MAKES NO REPRESENTATIONS OR WARRANTIES OF MERCANTABILITY OR 
// FITNESS FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF THIS SOFTWARE OR 
// DOCUMENTATION WILL NOT INFRINGE ANY PATENTS, COPYRIGHTS, TRADEMARKS, 
// OR OTHER RIGHTS.  Neither Indiana University nor the authors shall be 
// held liable for any liability with respect to any claim by the user or 
// any other party arising from use of the program.
//******************************************************************************

#include <map>
#include <complex>
#include <vector>
#include <string>
#include <cassert>

#include "IUAmpTools/Kinematics.h"
#include "GPUManager/GPUCustomTypes.h"

#ifdef GPU_ACCELERATION 
#include "cuda_runtime.h"
#include "GPUManager/CUDA-Complex.cuh"
class GPUManager;
#endif //GPU_ACCELERATION

using std::complex;
using namespace std;

class Kinematics;
class AmpParameter;

class Amplitude
{
  
public:
  
  Amplitude( ) : m_isDefault(true) { }
  
  Amplitude( const vector< string >& args ) : m_isDefault(false),
  m_args(args){ }
  
  virtual ~Amplitude(){}
  
  virtual string name() const = 0;
  
  bool containsFreeParameters() const;
  
  virtual Amplitude* newAmplitude( const vector< string >& args ) const = 0;
  
  virtual Amplitude* clone() const = 0;
  
  bool isDefault() const { return ( m_isDefault == true ); }
  
  vector<string> arguments() const { return m_args; }
  
  virtual void init(){}
  
  bool setParPtr( const string& name, const double* ptr ) const;
  
  bool setParValue( const string& name, double val ) const;
  
  virtual void updatePar( const AmpParameter& par ) {}
  
  bool updatePar( const string& name ) const;
  
  // speed may be enhanced if the two functions below are combined
  // as this avoids an extra function call, but puts more complicated
  // calcAllAmplitudes loops in user code
  
  virtual void calcAmplitudeAll( GDouble* pdData, GDouble* pdAmps, int iNEvents,
                                const vector< vector< int > >* pvPermutations ) const;
  
  
  virtual complex< GDouble > calcAmplitude( GDouble** pKin ) const = 0;
  
  
  complex< GDouble > calcAmplitude( const Kinematics* pKin ) const;
  
  
  complex< GDouble > calcAmplitude( const Kinematics* pKin, 
                                   const vector < int >& permutation ) const;
  
  
#ifdef GPU_ACCELERATION 
  
  virtual void calcAmplitudeGPU( dim3 dimGrid, dim3 dimBlock, GPU_AMP_PROTO,
                                const vector< int >& perm ) const;
  
  virtual void launchGPUKernel( dim3 dimGrid, dim3 dimBlock, GPU_AMP_PROTO ) const {
    
    cout << "\nNo GPU function for calculating " << name() << " is defined." << endl;
    assert( false );
  }
  
#endif //GPU_ACCELERATION
  
protected:
  
  void registerParameter( AmpParameter& par );
  
  inline const vector< int >& getCurrentPermutation() const { return m_currentPermutation; }
  
  
private:
  
  bool m_isDefault;
  
  vector<string> m_args;
  
  vector< AmpParameter* > m_registeredParams;
  
  mutable vector< int > m_currentPermutation;
};


#endif