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

#include <EKPoissonSolver.hpp>

+ Inheritance diagram for ScriptInterface::walberla::EKPoissonSolver:
+ Collaboration diagram for ScriptInterface::walberla::EKPoissonSolver:

Public Member Functions

virtual std::shared_ptr<::walberla::PoissonSolverget_instance () const noexcept=0
 
auto get_conversion_factor_potential () const noexcept
 
::LatticeModel::units_map get_lattice_to_md_units_conversion () const override
 
virtual std::shared_ptr<::walberla::PoissonSolverget_instance () const noexcept=0
 
- Public Member Functions inherited from ScriptInterface::walberla::LatticeModel<::walberla::PoissonSolver, EKPoissonVTKHandle >
Variant do_call_method (std::string const &method_name, VariantMap const &params) override
 
- Public Member Functions inherited from ScriptInterface::AutoParameters< Derived, Base >
std::vector< std::string_view > valid_parameters () const final
 
Variant get_parameter (const std::string &name) const final
 
void do_set_parameter (const std::string &name, const Variant &value) final
 
std::vector< std::pair< std::string, Variant > > serialize_parameters () const final
 
- Public Member Functions inherited from ScriptInterface::ObjectHandle
 ObjectHandle ()=default
 
 ObjectHandle (ObjectHandle const &)=delete
 
ObjectHandleoperator= (ObjectHandle const &)=delete
 
virtual ~ObjectHandle ()=default
 
std::string_view name () const
 
Contextcontext () const
 Responsible context.
 
void construct (VariantMap const &params)
 Construct the handled object.
 
virtual void do_construct (VariantMap const &params)
 
VariantMap get_parameters () const
 Get current parameters.
 
void set_parameter (const std::string &name, const Variant &value)
 Set single parameter.
 
Variant call_method (const std::string &name, const VariantMap &params)
 Call a method on the object.
 
std::string serialize () const
 
- Public Member Functions inherited from ScriptInterface::AutoParameters< EKPoissonSolver >
std::vector< std::string_view > valid_parameters () const final
 
Variant get_parameter (const std::string &name) const final
 
void do_set_parameter (const std::string &name, const Variant &value) final
 
std::vector< std::pair< std::string, Variant > > serialize_parameters () const final
 

Protected Member Functions

void set_potential_conversion (double agrid, double tau)
 
- Protected Member Functions inherited from ScriptInterface::walberla::LatticeModel<::walberla::PoissonSolver, EKPoissonVTKHandle >
virtual void make_instance (VariantMap const &params)=0
 
auto find_vtk (std::shared_ptr< EKPoissonVTKHandle > const &vtk) const
 
auto has_vtk (std::shared_ptr< EKPoissonVTKHandle > const &vtk) const
 
auto serialize_vtk_writers () const
 
- Protected Member Functions inherited from ScriptInterface::AutoParameters< Derived, Base >
 AutoParameters ()=default
 
 AutoParameters (std::vector< AutoParameter > &&params)
 
 ~AutoParameters () override=default
 
bool has_parameter (std::string const &name) const override
 
void add_parameters (std::vector< AutoParameter > &&params)
 
auto constget_parameter_insertion_order () const
 
- Protected Member Functions inherited from ScriptInterface::AutoParameters< EKPoissonSolver >
 AutoParameters ()=default
 
 AutoParameters (std::vector< AutoParameter > &&params)
 
 ~AutoParameters () override=default
 
bool has_parameter (std::string const &name) const override
 
void add_parameters (std::vector< AutoParameter > &&params)
 
auto const & get_parameter_insertion_order () const
 

Protected Attributes

double m_tau
 
double m_conv_potential
 
- Protected Attributes inherited from ScriptInterface::walberla::LatticeModel<::walberla::PoissonSolver, EKPoissonVTKHandle >
std::shared_ptr< LatticeWalberlam_lattice
 
std::shared_ptr< ::walberla::PoissonSolverm_instance
 
std::vector< std::shared_ptr< EKPoissonVTKHandle > > m_vtk_writers
 

Additional Inherited Members

- Static Public Member Functions inherited from ScriptInterface::ObjectHandle
static ObjectRef deserialize (const std::string &state, Context &ctx)
 Make object from serialized state.
 

Detailed Description

Definition at line 50 of file EKPoissonSolver.hpp.

Member Function Documentation

◆ get_conversion_factor_potential()

auto ScriptInterface::walberla::EKPoissonSolver::get_conversion_factor_potential ( ) const
inlinenoexcept

Definition at line 64 of file EKPoissonSolver.hpp.

References m_conv_potential.

◆ get_instance() [1/2]

virtual std::shared_ptr<::walberla::PoissonSolver > ScriptInterface::walberla::EKPoissonSolver::get_instance ( ) const
pure virtualnoexcept

◆ get_instance() [2/2]

virtual std::shared_ptr<::walberla::PoissonSolver > ScriptInterface::walberla::EKPoissonSolver::get_instance ( ) const
pure virtualnoexcept

◆ get_lattice_to_md_units_conversion()

::LatticeModel::units_map ScriptInterface::walberla::EKPoissonSolver::get_lattice_to_md_units_conversion ( ) const
inlineoverridevirtual

◆ set_potential_conversion()

void ScriptInterface::walberla::EKPoissonSolver::set_potential_conversion ( double  agrid,
double  tau 
)
inlineprotected

Member Data Documentation

◆ m_conv_potential

double ScriptInterface::walberla::EKPoissonSolver::m_conv_potential
protected

◆ m_tau

double ScriptInterface::walberla::EKPoissonSolver::m_tau
protected

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