ESPResSo
Extensible Simulation Package for Research on Soft Matter Systems
Loading...
Searching...
No Matches
walberla_bridge/include/walberla_bridge/electrokinetics/reactions/EKReactant.hpp
Go to the documentation of this file.
1
/*
2
* Copyright (C) 2022-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
#pragma once
21
22
#include <
walberla_bridge/electrokinetics/EKinWalberlaBase.hpp
>
23
24
#include <memory>
25
#include <utility>
26
27
namespace
walberla
{
28
29
class
EKReactant
{
30
private
:
31
std::shared_ptr<EKinWalberlaBase> m_ekspecies;
32
double
m_stoech_coeff;
33
double
m_order;
34
35
public
:
36
EKReactant
(std::shared_ptr<EKinWalberlaBase> ekspecies,
double
stoech_coeff,
37
double
order)
38
: m_ekspecies(std::move(ekspecies)), m_stoech_coeff(stoech_coeff),
39
m_order(order) {}
40
41
void
set_stoech_coefficient
(
double
stoech_coeff)
noexcept
{
42
m_stoech_coeff = stoech_coeff;
43
}
44
45
[[nodiscard]]
double
get_stoech_coeff
() const noexcept {
46
return
m_stoech_coeff;
47
}
48
49
void
set_order
(
double
order)
noexcept
{ m_order = order; }
50
51
[[nodiscard]]
double
get_order
() const noexcept {
return
m_order; }
52
53
void
set_species
(std::shared_ptr<EKinWalberlaBase> ekspecies)
noexcept
{
54
m_ekspecies = std::move(ekspecies);
55
}
56
57
[[nodiscard]]
auto
get_species
() const noexcept {
return
m_ekspecies; }
58
};
59
60
}
// namespace walberla
EKinWalberlaBase.hpp
walberla::EKReactant
Definition
walberla_bridge/include/walberla_bridge/electrokinetics/reactions/EKReactant.hpp:29
walberla::EKReactant::set_order
void set_order(double order) noexcept
Definition
walberla_bridge/include/walberla_bridge/electrokinetics/reactions/EKReactant.hpp:49
walberla::EKReactant::get_species
auto get_species() const noexcept
Definition
walberla_bridge/include/walberla_bridge/electrokinetics/reactions/EKReactant.hpp:57
walberla::EKReactant::get_order
double get_order() const noexcept
Definition
walberla_bridge/include/walberla_bridge/electrokinetics/reactions/EKReactant.hpp:51
walberla::EKReactant::set_species
void set_species(std::shared_ptr< EKinWalberlaBase > ekspecies) noexcept
Definition
walberla_bridge/include/walberla_bridge/electrokinetics/reactions/EKReactant.hpp:53
walberla::EKReactant::EKReactant
EKReactant(std::shared_ptr< EKinWalberlaBase > ekspecies, double stoech_coeff, double order)
Definition
walberla_bridge/include/walberla_bridge/electrokinetics/reactions/EKReactant.hpp:36
walberla::EKReactant::set_stoech_coefficient
void set_stoech_coefficient(double stoech_coeff) noexcept
Definition
walberla_bridge/include/walberla_bridge/electrokinetics/reactions/EKReactant.hpp:41
walberla::EKReactant::get_stoech_coeff
double get_stoech_coeff() const noexcept
Definition
walberla_bridge/include/walberla_bridge/electrokinetics/reactions/EKReactant.hpp:45
walberla
\file PackInfoPdfDoublePrecision.cpp \author pystencils
Definition
EKWalberla.hpp:36
src
walberla_bridge
include
walberla_bridge
electrokinetics
reactions
EKReactant.hpp
Generated on Fri Nov 8 2024 02:12:53 for ESPResSo by
1.9.8