IPPL (Independent Parallel Particle Layer)
IPPL
Loading...
Searching...
No Matches
ippl::ParticleInteractionBase< ParticleContainer > Class Template Referenceabstract

#include <ParticleInteractionBase.h>

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
virtual ~ParticleInteractionBase ()=default

Protected Member Functions

virtual void setDefaultParameters ()

Protected Attributes

const ParticleContainer & pc_m
ParameterList params_m

Detailed Description

template<typename ParticleContainer>
class ippl::ParticleInteractionBase< ParticleContainer >

Definition at line 19 of file ParticleInteractionBase.h.

Constructor & Destructor Documentation

◆ ParticleInteractionBase() [1/2]

template<typename ParticleContainer>
ippl::ParticleInteractionBase< ParticleContainer >::ParticleInteractionBase ( const ParticleContainer & pc,
const ParameterList & params )
inline

Definition at line 21 of file ParticleInteractionBase.h.

References params_m, pc_m, and setDefaultParameters().

Here is the call graph for this function:

◆ ParticleInteractionBase() [2/2]

template<typename ParticleContainer>
ippl::ParticleInteractionBase< ParticleContainer >::ParticleInteractionBase ( const ParticleContainer & pc)
inlineexplicit

Definition at line 27 of file ParticleInteractionBase.h.

References pc_m, and setDefaultParameters().

Here is the call graph for this function:

◆ ~ParticleInteractionBase()

template<typename ParticleContainer>
virtual ippl::ParticleInteractionBase< ParticleContainer >::~ParticleInteractionBase ( )
virtualdefault

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
paramsParameter list with desired values

Definition at line 57 of file ParticleInteractionBase.h.

References params_m.

◆ 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)

Definition at line 71 of file ParticleInteractionBase.h.

Referenced by ParticleInteractionBase(), and ParticleInteractionBase().

Here is the caller graph for this function:

◆ 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
keyThe parameter key
valueThe new value
Exceptions
IpplExceptionFails if there is no existing parameter with the given key

Definition at line 40 of file ParticleInteractionBase.h.

References params_m.

◆ 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
paramsParameter list with updated values
Exceptions
IpplExceptionFails if the provided parameter list includes keys not already present

Definition at line 50 of file ParticleInteractionBase.h.

References params_m.

Member Data Documentation

◆ params_m

template<typename ParticleContainer>
ParameterList ippl::ParticleInteractionBase< ParticleContainer >::params_m
protected

Definition at line 65 of file ParticleInteractionBase.h.

Referenced by mergeParameters(), ParticleInteractionBase(), ippl::TruncatedGreenParticleInteraction< ParticleContainer, VectorAttribute, ScalarAttribute >::solve(), updateParameter(), and updateParameters().

◆ pc_m

template<typename ParticleContainer>
const ParticleContainer& ippl::ParticleInteractionBase< ParticleContainer >::pc_m
protected

Definition at line 64 of file ParticleInteractionBase.h.

Referenced by ParticleInteractionBase(), ParticleInteractionBase(), and ippl::TruncatedGreenParticleInteraction< ParticleContainer, VectorAttribute, ScalarAttribute >::solve().

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