Coulomb::Actor< Class > Class Template Reference

#include <actor.hpp>

Inheritance diagram for Coulomb::Actor< Class >:

Collaboration diagram for Coulomb::Actor< Class >:

Public Member Functions
void	set_prefactor (double new_prefactor)
void	sanity_checks_charge_neutrality () const
Public Member Functions inherited from System::Leaf< Actor< Class > >
void	bind_system (std::shared_ptr< System > const &system)
void	detach_system (std::shared_ptr< System > const &system)

Public Attributes
double	prefactor = 0.
	Electrostatics prefactor.
double	charge_neutrality_tolerance = charge_neutrality_tolerance_default
	Relative tolerance for the charge excess during neutrality checks.

Static Public Attributes
static auto constexpr	charge_neutrality_tolerance_default = 2e-12

Additional Inherited Members
Protected Member Functions inherited from System::Leaf< Actor< Class > >
auto &	get_system ()
auto &	get_system () const
Protected Attributes inherited from System::Leaf< Actor< Class > >
std::weak_ptr< System >	m_system

Detailed Description

template<typename Class>
class Coulomb::Actor< Class >

Definition at line 36 of file electrostatics/actor.hpp.

Member Function Documentation

sanity_checks_charge_neutrality()

template<typename Class >

void Coulomb::Actor< Class >::sanity_checks_charge_neutrality ( ) const

inline

Definition at line 56 of file electrostatics/actor.hpp.

References Coulomb::Actor< Class >::charge_neutrality_tolerance, Coulomb::check_charge_neutrality(), and System::Leaf< Actor< Class > >::get_system().

set_prefactor()

template<typename Class >

void Coulomb::Actor< Class >::set_prefactor ( double  new_prefactor )

inline

Definition at line 49 of file electrostatics/actor.hpp.

References Coulomb::Actor< Class >::prefactor.

Member Data Documentation

charge_neutrality_tolerance

template<typename Class >

double Coulomb::Actor< Class >::charge_neutrality_tolerance = charge_neutrality_tolerance_default

Relative tolerance for the charge excess during neutrality checks.

To deactivate neutrality checks, set this value to -1.

Definition at line 47 of file electrostatics/actor.hpp.

Referenced by Coulomb::Actor< Class >::sanity_checks_charge_neutrality().

charge_neutrality_tolerance_default

template<typename Class >

auto constexpr Coulomb::Actor< Class >::charge_neutrality_tolerance_default = 2e-12

staticconstexpr

Definition at line 38 of file electrostatics/actor.hpp.

prefactor

template<typename Class >

double Coulomb::Actor< Class >::prefactor = 0.

Electrostatics prefactor.

Definition at line 42 of file electrostatics/actor.hpp.

Referenced by Coulomb::Actor< Class >::set_prefactor().

---

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

• electrostatics/actor.hpp