ESPResSo
Extensible Simulation Package for Research on Soft Matter Systems
Loading...
Searching...
No Matches
Public Types | Public Member Functions | List of all members
EKContainer< EKSpecies > Class Template Reference

#include <EKContainer.hpp>

Public Types

using value_type = typename container_type::value_type
 
using iterator = typename container_type::iterator
 
using const_iterator = typename container_type::const_iterator
 

Public Member Functions

 EKContainer (double tau, std::shared_ptr< walberla::PoissonSolver > solver)
 
bool contains (std::shared_ptr< EKSpecies > const &ek_species) const noexcept
 
void add (std::shared_ptr< EKSpecies > const &ek_species)
 
void remove (std::shared_ptr< EKSpecies > const &ek_species)
 
iterator begin () noexcept
 
iterator end () noexcept
 
const_iterator begin () const noexcept
 
const_iterator end () const noexcept
 
bool empty () const noexcept
 
void set_poisson_solver (std::shared_ptr< walberla::PoissonSolver > const &solver)
 
double get_tau () const noexcept
 
void set_tau (double tau) noexcept
 
void reset_charge () const
 
void add_charge (std::size_t const id, double valency, bool is_double_precision) const
 
void solve_poisson () const
 
std::size_t get_potential_field_id () const
 
LatticeWalberla const & get_lattice () const noexcept
 

Detailed Description

template<class EKSpecies>
class EKContainer< EKSpecies >

Definition at line 32 of file walberla_bridge/include/walberla_bridge/electrokinetics/EKContainer.hpp.

Member Typedef Documentation

◆ const_iterator

template<class EKSpecies >
using EKContainer< EKSpecies >::const_iterator = typename container_type::const_iterator

Definition at line 38 of file walberla_bridge/include/walberla_bridge/electrokinetics/EKContainer.hpp.

◆ iterator

template<class EKSpecies >
using EKContainer< EKSpecies >::iterator = typename container_type::iterator

Definition at line 37 of file walberla_bridge/include/walberla_bridge/electrokinetics/EKContainer.hpp.

◆ value_type

template<class EKSpecies >
using EKContainer< EKSpecies >::value_type = typename container_type::value_type

Definition at line 36 of file walberla_bridge/include/walberla_bridge/electrokinetics/EKContainer.hpp.

Constructor & Destructor Documentation

◆ EKContainer()

template<class EKSpecies >
EKContainer< EKSpecies >::EKContainer ( double  tau,
std::shared_ptr< walberla::PoissonSolver >  solver 
)
inline

Definition at line 72 of file walberla_bridge/include/walberla_bridge/electrokinetics/EKContainer.hpp.

Member Function Documentation

◆ add()

template<class EKSpecies >
void EKContainer< EKSpecies >::add ( std::shared_ptr< EKSpecies > const &  ek_species)
inline

Definition at line 79 of file walberla_bridge/include/walberla_bridge/electrokinetics/EKContainer.hpp.

References EKContainer< EKSpecies >::contains().

◆ add_charge()

template<class EKSpecies >
void EKContainer< EKSpecies >::add_charge ( std::size_t const  id,
double  valency,
bool  is_double_precision 
) const
inline

Definition at line 109 of file walberla_bridge/include/walberla_bridge/electrokinetics/EKContainer.hpp.

◆ begin() [1/2]

template<class EKSpecies >
const_iterator EKContainer< EKSpecies >::begin ( ) const
inlinenoexcept

Definition at line 92 of file walberla_bridge/include/walberla_bridge/electrokinetics/EKContainer.hpp.

◆ begin() [2/2]

template<class EKSpecies >
iterator EKContainer< EKSpecies >::begin ( )
inlinenoexcept

Definition at line 90 of file walberla_bridge/include/walberla_bridge/electrokinetics/EKContainer.hpp.

◆ contains()

template<class EKSpecies >
bool EKContainer< EKSpecies >::contains ( std::shared_ptr< EKSpecies > const &  ek_species) const
inlinenoexcept

Definition at line 75 of file walberla_bridge/include/walberla_bridge/electrokinetics/EKContainer.hpp.

Referenced by EKContainer< EKSpecies >::add(), and EKContainer< EKSpecies >::remove().

◆ empty()

template<class EKSpecies >
bool EKContainer< EKSpecies >::empty ( ) const
inlinenoexcept

Definition at line 94 of file walberla_bridge/include/walberla_bridge/electrokinetics/EKContainer.hpp.

◆ end() [1/2]

template<class EKSpecies >
const_iterator EKContainer< EKSpecies >::end ( ) const
inlinenoexcept

Definition at line 93 of file walberla_bridge/include/walberla_bridge/electrokinetics/EKContainer.hpp.

◆ end() [2/2]

template<class EKSpecies >
iterator EKContainer< EKSpecies >::end ( )
inlinenoexcept

Definition at line 91 of file walberla_bridge/include/walberla_bridge/electrokinetics/EKContainer.hpp.

◆ get_lattice()

template<class EKSpecies >
LatticeWalberla const & EKContainer< EKSpecies >::get_lattice ( ) const
inlinenoexcept

Definition at line 120 of file walberla_bridge/include/walberla_bridge/electrokinetics/EKContainer.hpp.

◆ get_potential_field_id()

template<class EKSpecies >
std::size_t EKContainer< EKSpecies >::get_potential_field_id ( ) const
inline

Definition at line 116 of file walberla_bridge/include/walberla_bridge/electrokinetics/EKContainer.hpp.

◆ get_tau()

template<class EKSpecies >
double EKContainer< EKSpecies >::get_tau ( ) const
inlinenoexcept

Definition at line 103 of file walberla_bridge/include/walberla_bridge/electrokinetics/EKContainer.hpp.

◆ remove()

template<class EKSpecies >
void EKContainer< EKSpecies >::remove ( std::shared_ptr< EKSpecies > const &  ek_species)
inline

Definition at line 85 of file walberla_bridge/include/walberla_bridge/electrokinetics/EKContainer.hpp.

References EKContainer< EKSpecies >::contains().

◆ reset_charge()

template<class EKSpecies >
void EKContainer< EKSpecies >::reset_charge ( ) const
inline

Definition at line 107 of file walberla_bridge/include/walberla_bridge/electrokinetics/EKContainer.hpp.

◆ set_poisson_solver()

template<class EKSpecies >
void EKContainer< EKSpecies >::set_poisson_solver ( std::shared_ptr< walberla::PoissonSolver > const &  solver)
inline

Definition at line 97 of file walberla_bridge/include/walberla_bridge/electrokinetics/EKContainer.hpp.

◆ set_tau()

template<class EKSpecies >
void EKContainer< EKSpecies >::set_tau ( double  tau)
inlinenoexcept

Definition at line 105 of file walberla_bridge/include/walberla_bridge/electrokinetics/EKContainer.hpp.

◆ solve_poisson()

template<class EKSpecies >
void EKContainer< EKSpecies >::solve_poisson ( ) const
inline

Definition at line 114 of file walberla_bridge/include/walberla_bridge/electrokinetics/EKContainer.hpp.

The documentation for this class was generated from the following files: