ESPResSo
Extensible Simulation Package for Research on Soft Matter Systems
Loading...
Searching...
No Matches
walberla::PoissonSolver Class Referenceabstract

#include <PoissonSolver.hpp>

+ Inheritance diagram for walberla::PoissonSolver:

Public Member Functions

 PoissonSolver (std::shared_ptr< LatticeWalberla > lattice, double permittivity)
 
virtual ~PoissonSolver ()=default
 
virtual void reset_charge_field ()=0
 
virtual void add_charge_to_field (std::size_t id, double valency, bool is_double_precision)=0
 
virtual std::size_t get_potential_field_id () const noexcept=0
 
void set_permittivity (double permittivity) noexcept
 
double get_permittivity () const noexcept
 
auto const & get_lattice () const noexcept
 
virtual void solve ()=0
 

Detailed Description

Definition at line 30 of file PoissonSolver.hpp.

Constructor & Destructor Documentation

◆ PoissonSolver()

walberla::PoissonSolver::PoissonSolver ( std::shared_ptr< LatticeWalberla lattice,
double  permittivity 
)
inline

Definition at line 36 of file PoissonSolver.hpp.

◆ ~PoissonSolver()

virtual walberla::PoissonSolver::~PoissonSolver ( )
virtualdefault

Member Function Documentation

◆ add_charge_to_field()

virtual void walberla::PoissonSolver::add_charge_to_field ( std::size_t  id,
double  valency,
bool  is_double_precision 
)
pure virtual

◆ get_lattice()

auto const & walberla::PoissonSolver::get_lattice ( ) const
inlinenoexcept

◆ get_permittivity()

double walberla::PoissonSolver::get_permittivity ( ) const
inlinenoexcept

Definition at line 51 of file PoissonSolver.hpp.

Referenced by walberla::FFT< FloatType >::add_charge_to_field().

◆ get_potential_field_id()

virtual std::size_t walberla::PoissonSolver::get_potential_field_id ( ) const
pure virtualnoexcept

◆ reset_charge_field()

virtual void walberla::PoissonSolver::reset_charge_field ( )
pure virtual

◆ set_permittivity()

void walberla::PoissonSolver::set_permittivity ( double  permittivity)
inlinenoexcept

Definition at line 47 of file PoissonSolver.hpp.

◆ solve()

virtual void walberla::PoissonSolver::solve ( )
pure virtual

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