ippl::ParticleInteractionBase< ParticleContainer > Class Template Reference

Inheritance diagram for ippl::ParticleInteractionBase< ParticleContainer >:

Collaboration diagram for ippl::ParticleInteractionBase< ParticleContainer >:

Public Member Functions
	ParticleInteractionBase (const ParticleContainer &pc, const ParameterList &params)
	ParticleInteractionBase (const ParticleContainer &pc)
template<typename T >
void	updateParameter (const std::string &key, const T &value)
void	updateParameters (const ParameterList &params)
void	mergeParameters (const ParameterList &params)
virtual void	solve ()=0

Protected Member Functions
virtual void	setDefaultParameters ()

Protected Attributes
const ParticleContainer &	pc_m
ParameterList	params_m

Member Function Documentation

mergeParameters()

template<typename ParticleContainer >

void ippl::ParticleInteractionBase< ParticleContainer >::mergeParameters ( const ParameterList &  params )

inline

Merges another parameter set into the solver's parameters, overwriting existing parameters in case of conflict

Parameters

params

Parameter list with desired values

setDefaultParameters()

template<typename ParticleContainer >

virtual void ippl::ParticleInteractionBase< ParticleContainer >::setDefaultParameters ( )

inlineprotectedvirtual

Utility function for initializing a solver's default parameters (to be overridden for each base class)

solve()

template<typename ParticleContainer >

virtual void ippl::ParticleInteractionBase< ParticleContainer >::solve ( )

pure virtual

Implemented in ippl::TruncatedGreenParticleInteraction< ParticleContainer, VectorAttribute, ScalarAttribute >.

updateParameter()

template<typename ParticleContainer >

template<typename T >

void ippl::ParticleInteractionBase< ParticleContainer >::updateParameter ( const std::string &  key, const T &  value  )

inline

Update one of the solver's parameters

Parameters

key	The parameter key
value	The new value

Exceptions

IpplException

Fails if there is no existing parameter with the given key

updateParameters()

template<typename ParticleContainer >

void ippl::ParticleInteractionBase< ParticleContainer >::updateParameters ( const ParameterList &  params )

inline

Updates all solver parameters based on values in another parameter set

Parameters

params

Parameter list with updated values

Exceptions

IpplException

Fails if the provided parameter list includes keys not already present

---

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

• ippl-src/src/Interaction/ParticleInteractionBase.h