EKWalberla.cpp

Go to the documentation of this file.

/*
 * Copyright (C) 2022-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/>.
 */
 
#include "config/config.hpp"
 
#ifdef ESPRESSO_WALBERLA
 
#include "BoxGeometry.hpp"
#include "LocalBox.hpp"
#include "ek/EKReactions.hpp"
#include "ek/EKWalberla.hpp"
#include "errorhandling.hpp"
#include "integrate.hpp"
#include "lb/Implementation.hpp"
#include "lb/LBWalberla.hpp"
#include "system/System.hpp"
 
#include <walberla_bridge/electrokinetics/EKContainer.hpp>
#include <walberla_bridge/electrokinetics/EKinWalberlaBase.hpp>
#include <walberla_bridge/electrokinetics/reactions/EKReactionBase.hpp>
#include <walberla_bridge/lattice_boltzmann/LBWalberlaBase.hpp>
 
#include <cstddef>
#include <memory>
#include <stdexcept>
#include <variant>
 
namespace EK {
 
bool EKWalberla::is_gpu() const { return ek_container->is_gpu(); }
 
double EKWalberla::get_tau() const { return ek_container->get_tau(); }
 
bool EKWalberla::is_ready_for_propagation() const noexcept {
  return not ek_container->empty();
}
 
struct FieldsConnector {
  std::size_t velocity_field_id{};
  std::size_t force_field_id{};
  double lb_density;
  void operator()(LB::Solver::Implementation const &impl) {
    using lb_value_type = std::shared_ptr<LB::LBWalberla>;
    if (impl.solver.has_value()) {
      if (auto const *ptr = std::get_if<lb_value_type>(&(*impl.solver))) {
        auto const &instance = **ptr;
        velocity_field_id = instance.lb_fluid->get_velocity_field_id();
        force_field_id = instance.lb_fluid->get_force_field_id();
        lb_density = instance.lb_fluid->get_density();
      }
    }
  }
};
 
void EKWalberla::propagate() {
  // first calculate the charge for the potential, for that get all the
  // field-ids from the ekspecies pass the potential-field-id to the
  // flux-kernels of the eks for this the integrate function has to be split
  // with a public interface to diffusive and advective-flux this should also
  // allow the back-coupling to the LB with a field-id
 
  if (ek_container->empty()) {
    return;
  }
 
  ek_container->reset_charge();
  for (auto const &ek_species : *ek_container) {
    ek_container->add_charge(ek_species->get_density_id(),
                             ek_species->get_valency());
  }
  ek_container->solve_poisson();
 
  FieldsConnector connector{};
  System::get_system().lb.connect(connector);
  for (auto const &ek_species : *ek_container) {
    try {
      ek_species->integrate(ek_container->get_potential_field_id(),
                            connector.velocity_field_id,
                            connector.force_field_id, connector.lb_density);
    } catch (std::runtime_error const &e) {
      runtimeErrorMsg() << e.what();
    }
  }
 
  perform_reactions();
 
  for (auto const &ek_species : *ek_container) {
    ek_species->ghost_communication();
  }
}
 
void EKWalberla::perform_reactions() {
  for (auto const &ek_reaction : *ek_reactions) {
    ek_reaction->perform_reaction();
  }
}
 
void EKWalberla::veto_time_step(double time_step) const {
  walberla_tau_sanity_checks("EK", ek_container->get_tau(), time_step);
}
 
void EKWalberla::veto_kT(double) const {
  if (not ek_container->empty()) {
    // can only throw, because without agrid, we can't do the unit conversion
    throw std::runtime_error("Temperature change not supported by EK");
  }
}
 
void EKWalberla::sanity_checks(System::System const &system) const {
  auto const &box_geo = *system.box_geo;
  auto const &lattice = ek_container->get_lattice();
  auto const agrid = box_geo.length()[0] / lattice.get_grid_dimensions()[0];
  auto [ek_left, ek_right] = lattice.get_local_domain();
  ek_left *= agrid;
  ek_right *= agrid;
  auto const &md_left = system.local_geo->my_left();
  auto const &md_right = system.local_geo->my_right();
  walberla_agrid_sanity_checks("EK", md_left, md_right, ek_left, ek_right,
                               agrid);
  // EK time step and MD time step must agree
  walberla_tau_sanity_checks("EK", ek_container->get_tau(),
                             system.get_time_step());
}
 
} // namespace EK
 
#endif // ESPRESSO_WALBERLA