PoissonSolverNone.hpp

Go to the documentation of this file.

/*
 * Copyright (C) 2022-2023 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 <walberla_bridge/LatticeWalberla.hpp>
#include <walberla_bridge/electrokinetics/PoissonSolver.hpp>
 
#include <field/AddToStorage.h>
#include <field/GhostLayerField.h>
 
#include <cstddef>
#include <memory>
#include <utility>
 
namespace walberla {
 
template <typename FloatType> class PoissonSolverNone : public PoissonSolver {
private:
  BlockDataID m_potential_field_id;
 
  using PotentialField = GhostLayerField<FloatType, 1>;
 
public:
  explicit PoissonSolverNone(std::shared_ptr<LatticeWalberla> lattice)
      : PoissonSolver(std::move(lattice), 0.0) {
    m_potential_field_id = field::addToStorage<PotentialField>(
        get_lattice().get_blocks(), "potential field", 0.0, field::fzyx,
        get_lattice().get_ghost_layers());
  }
  ~PoissonSolverNone() override = default;
 
  void reset_charge_field() override {}
  void add_charge_to_field(std::size_t, double) override {}
 
  [[nodiscard]] std::size_t get_potential_field_id() const noexcept override {
    return m_potential_field_id;
  }
 
  std::optional<double>
  get_node_potential(Utils::Vector3i const &,
                     [[maybe_unused]] bool consider_ghosts = false) override {
    throw std::runtime_error("PoissonSolverNone has no potential field");
  }
 
  std::vector<double>
  get_slice_potential(Utils::Vector3i const &,
                      Utils::Vector3i const &) const override {
    throw std::runtime_error("PoissonSolverNone has no potential field");
  }
 
  void solve() override {}
  void setup_fft(bool) override {}
 
  [[nodiscard]] bool is_gpu() const noexcept override { return false; }
  [[nodiscard]] bool is_double_precision() const noexcept override {
    return std::is_same_v<FloatType, double>;
  }
};
 
} // namespace walberla