#include <src/particle-system/regu-system.hpp>
template<typename Particles, typename Interactions, ReguType RegType = ReguType::LogH>
hub::system::RegularizedSystem class

Regularized particle System.

Template parameters
Particles
Interactions
RegType

Contents

Regularized particle system. See details Explicit Symplectic Algorithms For Time‐Transformed Hamiltonian , A Class of Symplectic Integrators with Adaptive Time Step for Separable Hamiltonian Systems and A Time-Transformed Leapfrog Scheme.

Constructors, destructors, conversion operators

RegularizedSystem() deleted
RegularizedSystem(RegularizedSystem const&) defaulted
RegularizedSystem(RegularizedSystem&&) defaulted

Public functions

auto operator=(RegularizedSystem const&) -> RegularizedSystem& defaulted
auto operator=(RegularizedSystem&&) -> RegularizedSystem& defaulted
auto omega() -> StateScalar& noexcept
auto omega() const -> StateScalar const & noexcept
auto bindE() -> StateScalar& noexcept
auto bindE() const -> StateScalar const & noexcept
auto increment() -> StateScalarArray& noexcept
auto increment() const -> StateScalarArray const & noexcept

Function documentation

template<typename Particles, typename Interactions, ReguType RegType>
hub::system::RegularizedSystem<Particles, Interactions, RegType>::RegularizedSystem() deleted

Default constructor.

template<typename Particles, typename Interactions, ReguType RegType>
hub::system::RegularizedSystem<Particles, Interactions, RegType>::RegularizedSystem(RegularizedSystem const&) defaulted

Default copy constructor.

template<typename Particles, typename Interactions, ReguType RegType>
hub::system::RegularizedSystem<Particles, Interactions, RegType>::RegularizedSystem(RegularizedSystem&&) defaulted

Default move constructor

template<typename Particles, typename Interactions, ReguType RegType>
RegularizedSystem& hub::system::RegularizedSystem<Particles, Interactions, RegType>::operator=(RegularizedSystem const&) defaulted

Default copy assignment operator

template<typename Particles, typename Interactions, ReguType RegType>
RegularizedSystem& hub::system::RegularizedSystem<Particles, Interactions, RegType>::operator=(RegularizedSystem&&) defaulted

Default move assignment operator

template<typename Particles, typename Interactions, ReguType RegType>
StateScalar& hub::system::RegularizedSystem<Particles, Interactions, RegType>::omega() noexcept

The setter interface of member regu_.omega() in name of omega.

template<typename Particles, typename Interactions, ReguType RegType>
StateScalar const & hub::system::RegularizedSystem<Particles, Interactions, RegType>::omega() const noexcept

The getter interface of member regu_.omega() in name of omega.

template<typename Particles, typename Interactions, ReguType RegType>
StateScalar& hub::system::RegularizedSystem<Particles, Interactions, RegType>::bindE() noexcept

The setter interface of member regu_.bindE() in name of bindE.

template<typename Particles, typename Interactions, ReguType RegType>
StateScalar const & hub::system::RegularizedSystem<Particles, Interactions, RegType>::bindE() const noexcept

The getter interface of member regu_.bindE() in name of bindE.

template<typename Particles, typename Interactions, ReguType RegType>
StateScalarArray& hub::system::RegularizedSystem<Particles, Interactions, RegType>::increment() noexcept

The setter interface of member increment_ in name of increment.

template<typename Particles, typename Interactions, ReguType RegType>
StateScalarArray const & hub::system::RegularizedSystem<Particles, Interactions, RegType>::increment() const noexcept

The getter interface of member increment_ in name of increment.