dipolar_direct_sum.hpp

Go to the documentation of this file.

/*
 * Copyright (C) 2010-2022 The ESPResSo project
 * Copyright (C) 2002,2003,2004,2005,2006,2007,2008,2009,2010
 *   Max-Planck-Institute for Polymer Research, Theory Group
 *
 * This file is part of ESPResSo.
 *
 * ESPResSo 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.
 *
 * ESPResSo 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 this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#pragma once
 
#include "config/config.hpp"
 
#ifdef DIPOLES
 
#include "magnetostatics/actor.hpp"
 
#include "ParticleRange.hpp"
 
/**
 * @brief Dipolar all with all and no replica.
 * Handling of a system of dipoles where no replicas exist.
 * Assumes minimum image convention for those axis in which the
 * system is periodic.
 */
struct DipolarDirectSum : public Dipoles::Actor<DipolarDirectSum> {
  int n_replicas;
  DipolarDirectSum(double prefactor, int n_replicas);
 
  void on_activation() const {}
  void on_boxl_change() const {}
  void on_node_grid_change() const {}
  void on_periodicity_change() const {}
  void on_cell_structure_change() const {}
  void init() const {}
  void sanity_checks() const {}
 
  double long_range_energy(ParticleRange const &particles) const;
  void add_long_range_forces(ParticleRange const &particles) const;
#ifdef DIPOLE_FIELD_TRACKING
  void dipole_field_at_part(ParticleRange const &particles) const;
#endif
};
 
#endif // DIPOLES