ESPResSo
Extensible Simulation Package for Research on Soft Matter Systems
Loading...
Searching...
No Matches
LBFluidSlice.cpp
Go to the documentation of this file.
1/*
2 * Copyright (C) 2021-2023 The ESPResSo project
3 *
4 * This file is part of ESPResSo.
5 *
6 * ESPResSo is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
10 *
11 * ESPResSo is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
18 */
19
20#include "config/config.hpp"
21
22#ifdef WALBERLA
23
24#include "LBFluidSlice.hpp"
25
26#include "LatticeSlice.impl.hpp"
27
28#include <stdexcept>
29#include <string>
30#include <type_traits>
31#include <vector>
32
34
35Variant LBFluidSlice::do_call_method(std::string const &name,
36 VariantMap const &params) {
37 if (name == "get_slice_size") {
39 }
40 if (name == "get_slice_ranges") {
41 return {std::vector<Variant>{m_slice_lower_corner, m_slice_upper_corner}};
42 }
43 if (name == "get_lb_sip") {
44 return {m_lb_sip};
45 }
46 if (name == "get_value_shape") {
47 auto const name = get_value<std::string>(params, "name");
48 if (m_shape_val.count(name) == 0) {
50 throw std::runtime_error("Unknown fluid property '" + name + "'");
51 });
52 }
53 return m_shape_val.at(name);
54 }
55 if (name == "get_lattice_speed") {
56 return 1. / m_conv_velocity;
57 }
58
59 // slice getter/setter callback
60 auto const call = [this, &params](auto method_ptr,
61 std::vector<int> const &data_dims,
62 double units = 1.) -> Variant {
63 auto &obj = *m_lb_fluid;
64 if constexpr (std::is_invocable_v<decltype(method_ptr), LatticeModel *,
65 Utils::Vector3i const &,
66 Utils::Vector3i const &>) {
67 return gather_3d(params, data_dims, obj, method_ptr, units);
68 } else {
69 scatter_3d(params, data_dims, obj, method_ptr, units);
70 return {};
71 }
72 };
73
74 if (name == "get_population") {
75 auto const pop_size = m_shape_val.at("population");
76 return call(&LatticeModel::get_slice_population, pop_size);
77 }
78 if (name == "set_population") {
79 auto const pop_size = m_shape_val.at("population");
80 return call(&LatticeModel::set_slice_population, pop_size);
81 }
82 if (name == "get_density") {
83 return call(&LatticeModel::get_slice_density, {1}, 1. / m_conv_dens);
84 }
85 if (name == "set_density") {
86 return call(&LatticeModel::set_slice_density, {1}, m_conv_dens);
87 }
88 if (name == "get_velocity") {
89 return call(&LatticeModel::get_slice_velocity, {3}, 1. / m_conv_velocity);
90 }
91 if (name == "set_velocity") {
92 return call(&LatticeModel::set_slice_velocity, {3}, m_conv_velocity);
93 }
94 if (name == "get_is_boundary") {
95 return call(&LatticeModel::get_slice_is_boundary, {1});
96 }
97 if (name == "get_velocity_at_boundary") {
99 1. / m_conv_velocity);
100 }
101 if (name == "set_velocity_at_boundary") {
102 auto const retval = call(&LatticeModel::set_slice_velocity_at_boundary, {1},
103 m_conv_velocity);
104 m_lb_fluid->reallocate_ubb_field();
105 return retval;
106 }
107 if (name == "get_pressure_tensor") {
108 return call(&LatticeModel::get_slice_pressure_tensor, {3, 3},
109 1. / m_conv_press);
110 }
111 if (name == "get_pressure_tensor_neq") {
112 auto variant = do_call_method("get_pressure_tensor", params);
113 if (context()->is_head_node()) {
114 auto constexpr c_sound_sq = 1. / 3.;
115 auto const density = m_lb_fluid->get_density();
116 auto const diagonal_term = density * c_sound_sq / m_conv_press;
117 // modify existing variant in-place
118 auto &vec = *(boost::get<std::vector<double>>(
119 &(boost::get<std::vector<Variant>>(&variant)->at(0))));
120 for (auto it = vec.begin(); it < vec.end(); it += 9) {
121 *(it + 0) -= diagonal_term;
122 *(it + 4) -= diagonal_term;
123 *(it + 8) -= diagonal_term;
124 }
125 }
126 return variant;
127 }
128 if (name == "get_last_applied_force") {
130 1. / m_conv_force);
131 }
132 if (name == "set_last_applied_force") {
133 return call(&LatticeModel::set_slice_last_applied_force, {3}, m_conv_force);
134 }
135
136 return {};
137}
138
139} // namespace ScriptInterface::walberla
140
141#endif // WALBERLA
Interface of a lattice-based fluid model.
virtual std::vector< double > get_slice_velocity(Utils::Vector3i const &lower_corner, Utils::Vector3i const &upper_corner) const =0
Get slice velocity.
virtual void set_slice_velocity_at_boundary(Utils::Vector3i const &lower_corner, Utils::Vector3i const &upper_corner, std::vector< std::optional< Utils::Vector3d > > const &velocity)=0
Set slice velocity boundary conditions.
virtual std::vector< double > get_slice_density(Utils::Vector3i const &lower_corner, Utils::Vector3i const &upper_corner) const =0
Get slice density.
virtual std::vector< double > get_slice_population(Utils::Vector3i const &lower_corner, Utils::Vector3i const &upper_corner) const =0
Get slice population.
virtual std::vector< std::optional< Utils::Vector3d > > get_slice_velocity_at_boundary(Utils::Vector3i const &lower_corner, Utils::Vector3i const &upper_corner) const =0
Get slice velocity boundary conditions.
virtual void set_slice_population(Utils::Vector3i const &lower_corner, Utils::Vector3i const &upper_corner, std::vector< double > const &population)=0
Set slice population.
virtual std::vector< double > get_slice_pressure_tensor(Utils::Vector3i const &lower_corner, Utils::Vector3i const &upper_corner) const =0
Get slice pressure tensor.
virtual void set_slice_density(Utils::Vector3i const &lower_corner, Utils::Vector3i const &upper_corner, std::vector< double > const &density)=0
Set slice density.
virtual void set_slice_velocity(Utils::Vector3i const &lower_corner, Utils::Vector3i const &upper_corner, std::vector< double > const &velocity)=0
Set slice velocity.
virtual std::vector< bool > get_slice_is_boundary(Utils::Vector3i const &lower_corner, Utils::Vector3i const &upper_corner) const =0
Check if slice has velocity boundary conditions.
virtual void set_slice_last_applied_force(Utils::Vector3i const &lower_corner, Utils::Vector3i const &upper_corner, std::vector< double > const &force)=0
Set stored force that was applied on slice in the last time step.
virtual std::vector< double > get_slice_last_applied_force(Utils::Vector3i const &lower_corner, Utils::Vector3i const &upper_corner) const =0
Get stored force that was applied on slice in the last time step.
virtual void parallel_try_catch(std::function< void()> const &cb) const =0
boost::string_ref name() const
Context * context() const
Responsible context.
Variant do_call_method(std::string const &name, VariantMap const &params) override
Variant gather_3d(VariantMap const &params, std::vector< int > const &data_dims, LatticeModel const &lattice_model, std::vector< T >(LatticeModel::*getter)(Utils::Vector3i const &, Utils::Vector3i const &) const, double units_conversion=1.) const
void scatter_3d(VariantMap const &params, std::vector< int > const &data_dims, LatticeModel &lattice_model, void(LatticeModel::*setter)(Utils::Vector3i const &, Utils::Vector3i const &, std::vector< T > const &), double units_conversion=1.)
This file contains the defaults for ESPResSo.
std::unordered_map< std::string, Variant > VariantMap
Definition Variant.hpp:82
boost::make_recursive_variant< None, bool, int, std::size_t, double, std::string, ObjectRef, Utils::Vector3b, Utils::Vector3i, Utils::Vector2d, Utils::Vector3d, Utils::Vector4d, std::vector< int >, std::vector< double >, std::vector< boost::recursive_variant_ >, std::unordered_map< int, boost::recursive_variant_ >, std::unordered_map< std::string, boost::recursive_variant_ > >::type Variant
Possible types for parameters.
Definition Variant.hpp:80
static SteepestDescentParameters params
Currently active steepest descent instance.