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

#include <solver.hpp>

+ Collaboration diagram for Dipoles::Solver:

Classes

struct  Implementation
 

Public Types

using ShortRangeForceKernel = std::function< ParticleForce(Particle const &, Particle const &, Utils::Vector3d const &, double, double)>
 
using ShortRangeEnergyKernel = std::function< double(Particle const &, Particle const &, Utils::Vector3d const &, double, double)>
 

Public Member Functions

void sanity_checks () const
 
double cutoff () const
 
void on_observable_calc ()
 
void on_dipoles_change ()
 
void on_boxl_change ()
 
void on_node_grid_change ()
 
void on_periodicity_change ()
 
void on_cell_structure_change ()
 
void on_particle_change ()
 
void calc_pressure_long_range () const
 
void calc_long_range_force (ParticleRange const &particles) const
 
double calc_energy_long_range (ParticleRange const &particles) const
 
void calc_long_range_field (ParticleRange const &particles) const
 
 Solver ()
 
std::optional< ShortRangeForceKernelpair_force_kernel () const
 
std::optional< ShortRangeEnergyKernelpair_energy_kernel () const
 

Public Attributes

std::unique_ptr< Implementationimpl
 Pointer-to-implementation.
 
bool reinit_on_observable_calc
 Whether to reinitialize the solver on observable calculation.
 

Detailed Description

Definition at line 39 of file magnetostatics/solver.hpp.

Member Typedef Documentation

◆ ShortRangeEnergyKernel

using Dipoles::Solver::ShortRangeEnergyKernel = std::function<double(Particle const &, Particle const &, Utils::Vector3d const &, double, double)>

Definition at line 72 of file magnetostatics/solver.hpp.

◆ ShortRangeForceKernel

using Dipoles::Solver::ShortRangeForceKernel = std::function<ParticleForce(Particle const &, Particle const &, Utils::Vector3d const &, double, double)>

Definition at line 69 of file magnetostatics/solver.hpp.

Constructor & Destructor Documentation

◆ Solver()

Dipoles::Solver::Solver ( )

Definition at line 44 of file dipoles.cpp.

References impl, and reinit_on_observable_calc.

Member Function Documentation

◆ calc_energy_long_range()

double Dipoles::Solver::calc_energy_long_range ( ParticleRange const &  particles) const

Definition at line 205 of file dipoles.cpp.

References impl.

◆ calc_long_range_field()

void Dipoles::Solver::calc_long_range_field ( ParticleRange const &  particles) const

Definition at line 213 of file dipoles.cpp.

References impl.

◆ calc_long_range_force()

void Dipoles::Solver::calc_long_range_force ( ParticleRange const &  particles) const

Definition at line 199 of file dipoles.cpp.

References impl.

Referenced by calc_long_range_forces().

◆ calc_pressure_long_range()

void Dipoles::Solver::calc_pressure_long_range ( ) const

Definition at line 193 of file dipoles.cpp.

References impl, and runtimeWarningMsg.

Referenced by System::System::calculate_pressure().

◆ cutoff()

double Dipoles::Solver::cutoff ( ) const

Definition at line 90 of file dipoles.cpp.

References impl.

◆ on_boxl_change()

void Dipoles::Solver::on_boxl_change ( )

Definition at line 64 of file dipoles.cpp.

References impl, and visit_try_catch().

◆ on_cell_structure_change()

void Dipoles::Solver::on_cell_structure_change ( )

Definition at line 83 of file dipoles.cpp.

References impl, and visit_try_catch().

◆ on_dipoles_change()

void Dipoles::Solver::on_dipoles_change ( )

Definition at line 57 of file dipoles.cpp.

References impl, reinit_on_observable_calc, and visit_try_catch().

◆ on_node_grid_change()

void Dipoles::Solver::on_node_grid_change ( )

Definition at line 70 of file dipoles.cpp.

References impl.

◆ on_observable_calc()

void Dipoles::Solver::on_observable_calc ( )

Definition at line 101 of file dipoles.cpp.

References impl, and reinit_on_observable_calc.

◆ on_particle_change()

void Dipoles::Solver::on_particle_change ( )
inline

Definition at line 56 of file magnetostatics/solver.hpp.

References reinit_on_observable_calc.

◆ on_periodicity_change()

void Dipoles::Solver::on_periodicity_change ( )

Definition at line 76 of file dipoles.cpp.

References impl, and visit_try_catch().

◆ pair_energy_kernel()

std::optional< Solver::ShortRangeEnergyKernel > Dipoles::Solver::pair_energy_kernel ( ) const
inline

Definition at line 111 of file dipoles_inline.hpp.

References impl.

◆ pair_force_kernel()

std::optional< Solver::ShortRangeForceKernel > Dipoles::Solver::pair_force_kernel ( ) const
inline

Definition at line 100 of file dipoles_inline.hpp.

References impl.

◆ sanity_checks()

void Dipoles::Solver::sanity_checks ( ) const

Definition at line 51 of file dipoles.cpp.

References impl.

Member Data Documentation

◆ impl

◆ reinit_on_observable_calc

bool Dipoles::Solver::reinit_on_observable_calc

Whether to reinitialize the solver on observable calculation.

Definition at line 45 of file magnetostatics/solver.hpp.

Referenced by on_dipoles_change(), on_observable_calc(), on_particle_change(), and Solver().


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