P3M solver. More...

#include <p3m.hpp>

Inheritance diagram for CoulombP3M:

Collaboration diagram for CoulombP3M:

Public Member Functions
	CoulombP3M (P3MParameters const &p3m_params)

virtual	~CoulombP3M ()=default

virtual bool	is_tuned () const noexcept=0

virtual bool	is_gpu () const noexcept=0

virtual bool	is_double_precision () const noexcept=0

virtual void	init ()=0
	Recalculate all derived parameters.

virtual void	on_activation ()=0

void	on_boxl_change ()
	Recalculate all box-length-dependent parameters.

void	on_node_grid_change () const

void	on_periodicity_change () const

void	on_cell_structure_change ()

void	sanity_checks () const

virtual void	count_charged_particles ()=0
	Count the number of charged particles and calculate the sum of the squared charges.

virtual void	count_charged_particles_elc (std::size_t, double, double)=0

virtual void	adapt_epsilon_elc ()=0

virtual void	tune ()=0
	Tune P3M parameters to desired accuracy.

virtual void	charge_assign ()=0
	Assign the physical charges using the tabulated charge assignment function.

virtual void	assign_charge (double q, Utils::Vector3d const &real_pos, bool skip_cache)=0
	Assign a single charge into the current charge grid.

virtual void	prepare_fft_mesh (bool reset_weights)=0

Utils::Vector3d	pair_force (double q1q2, Utils::Vector3d const &d, double dist) const
	Calculate real-space contribution of p3m Coulomb pair forces.

double	pair_energy (double q1q2, double dist) const
	Calculate real-space contribution of Coulomb pair energy.

virtual Utils::Vector9d	long_range_pressure ()=0
	Compute the k-space part of the pressure tensor.

virtual double	long_range_energy ()=0
	Compute the k-space part of energies.

virtual void	add_long_range_forces ()=0
	Compute the k-space part of forces.

Public Member Functions inherited from Coulomb::Actor< CoulombP3M >
void	set_prefactor (double new_prefactor)

void	sanity_checks_charge_neutrality () const

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)

Public Attributes
P3MParameters const &	p3m_params

Public Attributes inherited from Coulomb::Actor< CoulombP3M >
double	prefactor
	Electrostatics prefactor.

double	charge_neutrality_tolerance
	Relative tolerance for the charge excess during neutrality checks.

Protected Member Functions
virtual void	calc_influence_function_force ()=0

virtual void	calc_influence_function_energy ()=0

void	sanity_checks_boxl () const
	Checks for correctness of the k-space cutoff.

void	sanity_checks_periodicity () const

void	sanity_checks_cell_structure () const

virtual void	scaleby_box_l ()=0

Protected Member Functions inherited from System::Leaf< Class >
auto &	get_system ()

auto &	get_system () const

Additional Inherited Members
Static Public Attributes inherited from Coulomb::Actor< CoulombP3M >
static auto constexpr	charge_neutrality_tolerance_default

Protected Attributes inherited from System::Leaf< Class >
std::weak_ptr< System >	m_system

Detailed Description

P3M solver.

Definition at line 55 of file p3m.hpp.

Constructor & Destructor Documentation

◆ CoulombP3M()

CoulombP3M::CoulombP3M ( P3MParameters const & p3m_params )

inline

Definition at line 59 of file p3m.hpp.

◆ ~CoulombP3M()

virtual CoulombP3M::~CoulombP3M ( )

virtualdefault

Member Function Documentation

◆ adapt_epsilon_elc()

virtual void CoulombP3M::adapt_epsilon_elc ( )

pure virtual

Implemented in CoulombP3MHeffte< FloatType, Architecture, FFTConfig >.

◆ add_long_range_forces()

virtual void CoulombP3M::add_long_range_forces ( )

pure virtual

Compute the k-space part of forces.

Implemented in CoulombP3MHeffte< FloatType, Architecture, FFTConfig >.

◆ assign_charge()

virtual void CoulombP3M::assign_charge	(	double	q,
		Utils::Vector3d const &	real_pos,
		bool	skip_cache
	)

pure virtual

Assign a single charge into the current charge grid.

Parameters

[in]	q	Particle charge
[in]	real_pos	Particle position in real space
[in]	skip_cache	Skip interpolation weights caching.

Implemented in CoulombP3MHeffte< FloatType, Architecture, FFTConfig >.

Referenced by charge_assign().

◆ calc_influence_function_energy()

virtual void CoulombP3M::calc_influence_function_energy ( )

protectedpure virtual

Implemented in CoulombP3MHeffte< FloatType, Architecture, FFTConfig >.

◆ calc_influence_function_force()

virtual void CoulombP3M::calc_influence_function_force ( )

protectedpure virtual

Implemented in CoulombP3MHeffte< FloatType, Architecture, FFTConfig >.

◆ charge_assign()

virtual void CoulombP3M::charge_assign ( )

pure virtual

Assign the physical charges using the tabulated charge assignment function.

Implemented in CoulombP3MHeffte< FloatType, Architecture, FFTConfig >.

◆ count_charged_particles()

virtual void CoulombP3M::count_charged_particles ( )

pure virtual

Count the number of charged particles and calculate the sum of the squared charges.

Implemented in CoulombP3MHeffte< FloatType, Architecture, FFTConfig >.

◆ count_charged_particles_elc()

virtual void CoulombP3M::count_charged_particles_elc	(	std::size_t	,
		double	,
		double
	)

pure virtual

Implemented in CoulombP3MHeffte< FloatType, Architecture, FFTConfig >.

Referenced by modify_p3m_sums().

◆ init()

virtual void CoulombP3M::init ( )

pure virtual

Recalculate all derived parameters.

Implemented in CoulombP3MHeffte< FloatType, Architecture, FFTConfig >.

Referenced by on_cell_structure_change().

◆ is_double_precision()

virtual bool CoulombP3M::is_double_precision ( ) const

pure virtualnoexcept

Implemented in CoulombP3MHeffte< FloatType, Architecture, FFTConfig >.

◆ is_gpu()

virtual bool CoulombP3M::is_gpu ( ) const

pure virtualnoexcept

Implemented in CoulombP3MHeffte< FloatType, Architecture, FFTConfig >.

◆ is_tuned()

virtual bool CoulombP3M::is_tuned ( ) const

pure virtualnoexcept

Implemented in CoulombP3MHeffte< FloatType, Architecture, FFTConfig >.

◆ long_range_energy()

virtual double CoulombP3M::long_range_energy ( )

pure virtual

Compute the k-space part of energies.

Implemented in CoulombP3MHeffte< FloatType, Architecture, FFTConfig >.

◆ long_range_pressure()

virtual Utils::Vector9d CoulombP3M::long_range_pressure ( )

pure virtual

Compute the k-space part of the pressure tensor.

Implemented in CoulombP3MHeffte< FloatType, Architecture, FFTConfig >.

◆ on_activation()

virtual void CoulombP3M::on_activation ( )

pure virtual

Implemented in CoulombP3MHeffte< FloatType, Architecture, FFTConfig >.

◆ on_boxl_change()

void CoulombP3M::on_boxl_change ( )

inline

Recalculate all box-length-dependent parameters.

Definition at line 72 of file p3m.hpp.

References scaleby_box_l().

◆ on_cell_structure_change()

void CoulombP3M::on_cell_structure_change ( )

inline

Definition at line 75 of file p3m.hpp.

References init(), and sanity_checks_cell_structure().

◆ on_node_grid_change()

void CoulombP3M::on_node_grid_change ( ) const

inline

Definition at line 73 of file p3m.hpp.

◆ on_periodicity_change()

void CoulombP3M::on_periodicity_change ( ) const

inline

Definition at line 74 of file p3m.hpp.

References sanity_checks_periodicity().

◆ pair_energy()

double CoulombP3M::pair_energy	(	double	q1q2,
		double	dist
	)		const

inline

Calculate real-space contribution of Coulomb pair energy.

Definition at line 167 of file p3m.hpp.

References P3MParameters::alpha, Utils::AS_erfc_part(), p3m_params, Coulomb::Actor< CoulombP3M >::prefactor, P3MParameters::r_cut, and stream.

◆ pair_force()

Utils::Vector3d CoulombP3M::pair_force	(	double	q1q2,
		Utils::Vector3d const &	d,
		double	dist
	)		const

inline

Calculate real-space contribution of p3m Coulomb pair forces.

Definition at line 145 of file p3m.hpp.

References P3MParameters::alpha, Utils::AS_erfc_part(), p3m_params, Coulomb::Actor< CoulombP3M >::prefactor, P3MParameters::r_cut, and stream.

Referenced by ForcesKernel::operator()().

◆ prepare_fft_mesh()

virtual void CoulombP3M::prepare_fft_mesh ( bool reset_weights )

pure virtual

Implemented in CoulombP3MHeffte< FloatType, Architecture, FFTConfig >.

Referenced by charge_assign().

◆ sanity_checks()

void CoulombP3M::sanity_checks ( ) const

inline

Definition at line 79 of file p3m.hpp.

References sanity_checks_boxl(), sanity_checks_cell_structure(), Coulomb::Actor< CoulombP3M >::sanity_checks_charge_neutrality(), and sanity_checks_periodicity().

Referenced by CoulombP3MHeffte< FloatType, Architecture, FFTConfig >::on_activation().

◆ sanity_checks_boxl()

void CoulombP3M::sanity_checks_boxl ( ) const

protected

Checks for correctness of the k-space cutoff.

Definition at line 1107 of file p3m_heffte.impl.hpp.

References P3MParameters::cao_cut, P3MParameters::epsilon, System::Leaf< Class >::get_system(), P3MParameters::mesh, P3M_EPSILON_METALLIC, p3m_params, and stream.

Referenced by sanity_checks().

◆ sanity_checks_cell_structure()

void CoulombP3M::sanity_checks_cell_structure ( ) const

protected

Definition at line 1146 of file p3m_heffte.impl.hpp.

References communicator, System::Leaf< Class >::get_system(), HYBRID, REGULAR, and stream.

Referenced by on_cell_structure_change(), and sanity_checks().

◆ sanity_checks_periodicity()

void CoulombP3M::sanity_checks_periodicity ( ) const

protected

Definition at line 1138 of file p3m_heffte.impl.hpp.

References System::Leaf< Class >::get_system(), and stream.

Referenced by on_periodicity_change(), and sanity_checks().

◆ scaleby_box_l()

virtual void CoulombP3M::scaleby_box_l ( )

protectedpure virtual

Implemented in CoulombP3MHeffte< FloatType, Architecture, FFTConfig >.

Referenced by on_boxl_change().

◆ tune()

virtual void CoulombP3M::tune ( )

pure virtual

Tune P3M parameters to desired accuracy.

The parameters mesh, cao, r_cut_iL and alpha_L are tuned to obtain the target accuracy in optimal time. These parameters are stored in the p3m_params object.

The function utilizes the analytic expression of the error estimate for the P3M method in [23] (eq. (8.23)) in order to obtain the rms error in the force for a system of N randomly distributed particles in a cubic box. For the real space error the estimate of Kolafa/Perram is used.

Parameter ranges if not given explicitly in the constructor:

mesh explores the range 0-512 (biased toward values less than 128)
cao explores all possible values
alpha_L is tuned for each tuple (r_cut_iL, mesh, cao) and calculated assuming that the error contributions of real and reciprocal space should be equal

After checking if the total error lies below the target accuracy, the time needed for one force calculation is measured. Parameters that minimize the runtime are kept.

The function is based on routines of the program HE_Q.cpp written by M. Deserno.

Implemented in CoulombP3MHeffte< FloatType, Architecture, FFTConfig >.

Member Data Documentation

◆ p3m_params

P3MParameters const& CoulombP3M::p3m_params

Definition at line 56 of file p3m.hpp.

Referenced by pair_energy(), pair_force(), and sanity_checks_boxl().

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

Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CoulombP3M()

◆ ~CoulombP3M()

Member Function Documentation

◆ adapt_epsilon_elc()

◆ add_long_range_forces()

◆ assign_charge()

◆ calc_influence_function_energy()

◆ calc_influence_function_force()

◆ charge_assign()

◆ count_charged_particles()

◆ count_charged_particles_elc()

◆ init()

◆ is_double_precision()

◆ is_gpu()

◆ is_tuned()

◆ long_range_energy()

◆ long_range_pressure()

◆ on_activation()

◆ on_boxl_change()

◆ on_cell_structure_change()

◆ on_node_grid_change()

◆ on_periodicity_change()

◆ pair_energy()

◆ pair_force()

◆ prepare_fft_mesh()

◆ sanity_checks()

◆ sanity_checks_boxl()

◆ sanity_checks_cell_structure()

◆ sanity_checks_periodicity()

◆ scaleby_box_l()

◆ tune()

Member Data Documentation

◆ p3m_params