System::Leaf< Class > Class Template Reference

Abstract class that represents a component of the system. More...

#include <Leaf.hpp>

Inheritance diagram for System::Leaf< Class >:

Collaboration diagram for System::Leaf< Class >:

Public Member Functions
void	bind_system (std::shared_ptr< System > const &system)
void	detach_system (std::shared_ptr< System > const &system)

Protected Member Functions
auto &	get_system ()
auto &	get_system () const

Protected Attributes
std::weak_ptr< System >	m_system

Detailed Description

template<typename Class>
class System::Leaf< Class >

Abstract class that represents a component of the system.

See System class design for more details.

Definition at line 34 of file core/system/Leaf.hpp.

Member Function Documentation

bind_system()

template<typename Class >

void System::Leaf< Class >::bind_system ( std::shared_ptr< System > const &  system )

inline

Definition at line 51 of file core/system/Leaf.hpp.

References System::Leaf< Class >::m_system.

detach_system()

template<typename Class >

void System::Leaf< Class >::detach_system ( std::shared_ptr< System > const &  system )

inline

Definition at line 57 of file core/system/Leaf.hpp.

References System::Leaf< Class >::m_system.

get_system() [1/2]

template<typename Class >

auto & System::Leaf< Class >::get_system ( )

inlineprotected

Definition at line 38 of file core/system/Leaf.hpp.

References System::Leaf< Class >::m_system.

Referenced by DipolarLayerCorrection::add_force_corrections(), DipolarDirectSumGpu::add_long_range_forces(), ElectrostaticLayerCorrection::add_long_range_forces(), DipolarDirectSum::add_long_range_forces(), DipolarDirectSum::dipole_field_at_part(), DipolarLayerCorrection::energy_correction(), DipolarDirectSumGpu::long_range_energy(), ElectrostaticLayerCorrection::long_range_energy(), DipolarDirectSum::long_range_energy(), DipolarDirectSumGpu::on_activation(), CoulombMMM1D::pair_energy(), CoulombMMM1D::pair_force(), DipolarLayerCorrection::recalc_box_h(), CoulombP3M::sanity_checks_boxl(), DipolarP3M::sanity_checks_boxl(), CoulombP3M::sanity_checks_cell_structure(), DipolarP3M::sanity_checks_cell_structure(), CoulombP3M::sanity_checks_periodicity(), DipolarP3M::sanity_checks_periodicity(), CoulombMMM1D::tune(), CoulombScafacosImpl::tune_impl(), CoulombScafacosImpl::update_particle_data(), DipolarScafacosImpl::update_particle_data(), CoulombScafacosImpl::update_particle_forces(), and DipolarScafacosImpl::update_particle_forces().

get_system() [2/2]

template<typename Class >

auto & System::Leaf< Class >::get_system ( ) const

inlineprotected

Definition at line 44 of file core/system/Leaf.hpp.

References System::Leaf< Class >::m_system.

Member Data Documentation

m_system

template<typename Class >

std::weak_ptr<System> System::Leaf< Class >::m_system

protected

Definition at line 36 of file core/system/Leaf.hpp.

Referenced by System::Leaf< Class >::bind_system(), System::Leaf< Class >::detach_system(), System::Leaf< Class >::get_system(), System::Leaf< Class >::get_system(), ElectrostaticLayerCorrection::on_activation(), and DipolarLayerCorrection::on_activation().

---

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

• core/system/Leaf.hpp