libhoomd/computes_gpu/TableAngleForceComputeGPU.h

   1 /*
   2 Highly Optimized Object-oriented Many-particle Dynamics -- Blue Edition
   3 (HOOMD-blue) Open Source Software License Copyright 2009-2014 The Regents of
   4 the University of Michigan All rights reserved.
   5
   6 HOOMD-blue may contain modifications ("Contributions") provided, and to which
   7 copyright is held, by various Contributors who have granted The Regents of the
   8 University of Michigan the right to modify and/or distribute such Contributions.
   9
  10 You may redistribute, use, and create derivate works of HOOMD-blue, in source
  11 and binary forms, provided you abide by the following conditions:
  12
  13 * Redistributions of source code must retain the above copyright notice, this
  14 list of conditions, and the following disclaimer both in the code and
  15 prominently in any materials provided with the distribution.
  16
  17 * Redistributions in binary form must reproduce the above copyright notice, this
  18 list of conditions, and the following disclaimer in the documentation and/or
  19 other materials provided with the distribution.
  20
  21 * All publications and presentations based on HOOMD-blue, including any reports
  22 or published results obtained, in whole or in part, with HOOMD-blue, will
  23 acknowledge its use according to the terms posted at the time of submission on:
  24 http://codeblue.umich.edu/hoomd-blue/citations.html
  25
  26 * Any electronic documents citing HOOMD-Blue will link to the HOOMD-Blue website:
  27 http://codeblue.umich.edu/hoomd-blue/
  28
  29 * Apart from the above required attributions, neither the name of the copyright
  30 holder nor the names of HOOMD-blue's contributors may be used to endorse or
  31 promote products derived from this software without specific prior written
  32 permission.
  33
  34 Disclaimer
  35
  36 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS ``AS IS'' AND
  37 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  38 WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND/OR ANY
  39 WARRANTIES THAT THIS SOFTWARE IS FREE OF INFRINGEMENT ARE DISCLAIMED.
  40
  41 IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
  42 INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  43 BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  44 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  45 LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
  46 OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  47 ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  48 */
  49
  50 // Maintainer: phillicl
  51
  52 #include "TableAngleForceCompute.h"
  53 #include "TableAngleForceGPU.cuh"
  54 #include "Autotuner.h"
  55
  56 /*! \file TableAngleForceComputeGPU.h
  57     \brief Declares the TableAngleForceComputeGPU class
  58 */
  59
  60 #ifdef NVCC
  61 #error This header cannot be compiled by nvcc
  62 #endif
  63
  64 #ifndef __TABLEANGLEFORCECOMPUTEGPU_H__
  65 #define __TABLEANGLEFORCECOMPUTEGPU_H__
  66
  67 //! Compute table based bond potentials on the GPU
  68 /*! Calculates exactly the same thing as TableAngleForceCompute, but on the GPU
  69
  70     The GPU kernel for calculating this can be found in TableAngleForceComputeGPU.cu/
  71     \ingroup computes
  72 */
  73 class TableAngleForceComputeGPU : public TableAngleForceCompute
  74     {
  75     public:
  76         //! Constructs the compute
  77         TableAngleForceComputeGPU(boost::shared_ptr<SystemDefinition> sysdef,
  78                           unsigned int table_width,
  79                           const std::string& log_suffix="");
  80
  81         //! Destructor
  82         virtual ~TableAngleForceComputeGPU() { }
  83
  84         //! Set autotuner parameters
  85         /*! \param enable Enable/disable autotuning
  86             \param period period (approximate) in time steps when returning occurs
  87         */
  88         virtual void setAutotunerParams(bool enable, unsigned int period)
  89             {
  90             TableAngleForceCompute::setAutotunerParams(enable, period);
  91             m_tuner->setPeriod(period);
  92             m_tuner->setEnabled(enable);
  93             }
  94
  95     private:
  96         boost::scoped_ptr<Autotuner> m_tuner; //!< Autotuner for block size
  97         GPUArray<unsigned int> m_flags;       //!< Flags set during the kernel execution
  98
  99         //! Actually compute the forces
 100         virtual void computeForces(unsigned int timestep);
 101     };
 102
 103 //! Exports the TableAngleForceComputeGPU class to python
 104 void export_TableAngleForceComputeGPU();
 105
 106 #endif