coulomb.hpp

Go to the documentation of this file.

/*
 * Copyright (C) 2010-2026 The ESPResSo project
 *
 * 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 ESPRESSO_ELECTROSTATICS
 
#include "actor/traits.hpp"
 
#include "electrostatics/solver.hpp"
 
#include "electrostatics/debye_hueckel.hpp"
#include "electrostatics/elc.hpp"
#include "electrostatics/icc.hpp"
#include "electrostatics/mmm1d.hpp"
#include "electrostatics/p3m.hpp"
#include "electrostatics/reaction_field.hpp"
#include "electrostatics/scafacos.hpp"
 
#include <memory>
#include <optional>
#include <type_traits>
#include <variant>
 
#ifdef FFTW3_H
#error "The FFTW3 library shouldn't be visible in this translation unit"
#endif
 
namespace Coulomb {
 
using ElectrostaticsActor =
    std::variant<std::shared_ptr<DebyeHueckel>,
#ifdef ESPRESSO_P3M
                 std::shared_ptr<CoulombP3M>,
                 std::shared_ptr<ElectrostaticLayerCorrection>,
#endif // ESPRESSO_P3M
#ifdef ESPRESSO_MMM1D
                 std::shared_ptr<CoulombMMM1D>,
#endif // ESPRESSO_MMM1D
#ifdef ESPRESSO_SCAFACOS
                 std::shared_ptr<CoulombScafacos>,
#endif // ESPRESSO_SCAFACOS
                 std::shared_ptr<ReactionField>>;
 
using ElectrostaticsExtension = std::variant<std::shared_ptr<ICCStar>>;
 
struct Solver::Implementation {
  /// @brief Main electrostatics solver.
  std::optional<ElectrostaticsActor> solver;
  /// @brief Extension that modifies the solver behavior.
  std::optional<ElectrostaticsExtension> extension;
  Implementation() : solver{}, extension{} {}
};
 
namespace traits {
 
/** @brief The electrostatic method supports pressure calculation. */
template <class T> struct has_pressure : std::true_type {};
#ifdef ESPRESSO_P3M
template <>
struct has_pressure<ElectrostaticLayerCorrection> : std::false_type {};
#endif // ESPRESSO_P3M
#ifdef ESPRESSO_SCAFACOS
template <> struct has_pressure<CoulombScafacos> : std::false_type {};
#endif // ESPRESSO_SCAFACOS
#ifdef ESPRESSO_MMM1D
template <> struct has_pressure<CoulombMMM1D> : std::false_type {};
#endif // ESPRESSO_MMM1D
 
} // namespace traits
} // namespace Coulomb
#endif // ESPRESSO_ELECTROSTATICS