ESPResSo
Extensible Simulation Package for Research on Soft Matter Systems
Loading...
Searching...
No Matches
DipolarScafacos Struct Reference

#include <scafacos.hpp>

+ Inheritance diagram for DipolarScafacos:
+ Collaboration diagram for DipolarScafacos:

Public Member Functions

 ~DipolarScafacos () override=default
 
void on_activation ()
 
void on_boxl_change ()
 Recalculate all box-length-dependent parameters.
 
void on_node_grid_change () const
 
void on_periodicity_change ()
 
void on_cell_structure_change () const
 
void init () const
 
void sanity_checks () const override
 
- Public Member Functions inherited from ScafacosContextBase
 ScafacosContextBase ()=default
 
virtual ~ScafacosContextBase ()=default
 
virtual void update_particle_data ()=0
 Collect particle data in continuous arrays.
 
virtual void update_particle_forces () const =0
 Write forces back to particles.
 
virtual double long_range_energy ()=0
 Calculate long-range part of the energy.
 
virtual void add_long_range_forces ()=0
 Add long-range part of the forces to particles.
 
virtual void update_system_params ()=0
 Reinitialize number of particles, box shape and periodicity.
 
virtual std::string get_method () const =0
 
virtual std::string get_parameters () const =0
 
- Public Member Functions inherited from Dipoles::Actor< DipolarScafacos >
void set_prefactor (double new_prefactor)
 
- Public Member Functions inherited from System::Leaf< Class >
void bind_system (std::shared_ptr< System > const &system)
 
void detach_system (std::shared_ptr< System > const &system)
 

Additional Inherited Members

- Static Public Member Functions inherited from ScafacosContextBase
static std::vector< std::string > available_methods ()
 
static void sanity_check_method (std::string const &method_name)
 
- Public Attributes inherited from Dipoles::Actor< DipolarScafacos >
double prefactor
 Magnetostatics prefactor.
 
- Protected Member Functions inherited from System::Leaf< Class >
auto & get_system ()
 
auto & get_system () const
 
- Protected Attributes inherited from System::Leaf< Class >
std::weak_ptr< Systemm_system
 

Detailed Description

Definition at line 35 of file core/magnetostatics/scafacos.hpp.

Constructor & Destructor Documentation

◆ ~DipolarScafacos()

DipolarScafacos::~DipolarScafacos ( )
overridedefault

Member Function Documentation

◆ init()

void DipolarScafacos::init ( ) const
inline

Definition at line 45 of file core/magnetostatics/scafacos.hpp.

◆ on_activation()

void DipolarScafacos::on_activation ( )
inline

◆ on_boxl_change()

void DipolarScafacos::on_boxl_change ( )
inline

Recalculate all box-length-dependent parameters.

Definition at line 41 of file core/magnetostatics/scafacos.hpp.

References ScafacosContextBase::update_system_params().

◆ on_cell_structure_change()

void DipolarScafacos::on_cell_structure_change ( ) const
inline

Definition at line 44 of file core/magnetostatics/scafacos.hpp.

◆ on_node_grid_change()

void DipolarScafacos::on_node_grid_change ( ) const
inline

Definition at line 42 of file core/magnetostatics/scafacos.hpp.

◆ on_periodicity_change()

void DipolarScafacos::on_periodicity_change ( )
inline

◆ sanity_checks()

void DipolarScafacos::sanity_checks ( ) const
inlineoverridevirtual

Implements ScafacosContextBase.

Definition at line 47 of file core/magnetostatics/scafacos.hpp.


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