ippl::ParameterList Class Reference

#include <ParameterList.h>

Collaboration diagram for ippl::ParameterList:

Public Types
using	variant_t = std::variant< double, float, bool, std::string, unsigned int, int, ParameterList >

Public Member Functions
	ParameterList ()=default
	ParameterList (const ParameterList &)=default
template<typename T >
void	add (const std::string &key, const T &value)
template<typename T >
T	get (const std::string &key) const
template<typename T >
T	get (const std::string &key, const T &defval) const
void	merge (const ParameterList &p) noexcept
void	update (const ParameterList &p) noexcept
template<typename T >
void	update (const std::string &key, const T &value)
ParameterList &	operator= (const ParameterList &other)

Protected Attributes
std::map< std::string, variant_t >	params_m

Friends
template<class Stream >
Stream &	operator<< (Stream &stream, const ParameterList &sp)
std::ostream &	operator<< (std::ostream &os, const ParameterList &sp)

Detailed Description

Definition at line 29 of file ParameterList.h.

Member Typedef Documentation

variant_t

using ippl::ParameterList::variant_t = std::variant<double, float, bool, std::string, unsigned int, int, ParameterList>

Definition at line 32 of file ParameterList.h.

Constructor & Destructor Documentation

ParameterList() [1/2]

ippl::ParameterList::ParameterList ( )

default

ParameterList() [2/2]

ippl::ParameterList::ParameterList ( const ParameterList &  )

default

Member Function Documentation

add()

template<typename T >

void ippl::ParameterList::add ( const std::string &  key, const T &  value  )

inline

Add a single parameter to this list.

Parameters

key	is the name of the parameter
value	is the parameter value

Definition at line 44 of file ParameterList.h.

References params_m.

Referenced by FieldSolver< T, Dim >::initFFTSolver(), FieldSolver< T, Dim >::initOpenSolver(), ippl::FEMMaxwellDiffusionSolver< FieldType >::setDefaultParameters(), ippl::Poisson< FieldLHS, FieldRHS >::setDefaultParameters(), ippl::FEMPoissonSolver< FieldLHS, FieldRHS, Order, QuadNumNodes >::setDefaultParameters(), ippl::FFTOpenPoissonSolver< FieldLHS, FieldRHS >::setDefaultParameters(), ippl::FFTPeriodicPoissonSolver< FieldLHS, FieldRHS >::setDefaultParameters(), ippl::FFTTruncatedGreenPeriodicPoissonSolver< FieldLHS, FieldRHS >::setDefaultParameters(), ippl::PoissonCG< FieldLHS, FieldRHS >::setDefaultParameters(), and ippl::PreconditionedFEMPoissonSolver< FieldLHS, FieldRHS >::setDefaultParameters().

get() [1/2]

template<typename T >

T ippl::ParameterList::get ( const std::string &  key ) const

inline

Obtain the value of a parameter. This function throws an error if the key is not contained.

Parameters

key	the name of the parameter

Returns

the value of a parameter

Definition at line 59 of file ParameterList.h.

References params_m.

Referenced by ippl::CG< OperatorRet, LowerRet, UpperRet, UpperLowerRet, InverseDiagRet, DiagRet, FieldLHS, FieldRHS >::operator()(), ippl::CG< OperatorRet, LowerRet, UpperRet, UpperLowerRet, InverseDiagRet, FEMVector< T >, FEMVector< T > >::operator()(), ippl::PCG< OperatorRet, LowerRet, UpperRet, UpperLowerRet, InverseDiagRet, DiagRet, FieldLHS, FieldRHS >::operator()(), and ippl::FFTBase< Field, FFT, Backend, BufferType >::setup().

get() [2/2]

template<typename T >

T ippl::ParameterList::get ( const std::string &  key, const T &  defval  ) const

inline

Obtain the value of a parameter. If the key is not contained, the default value is returned.

Parameters

key	the name of the parameter
defval	the default value of the parameter

Returns

the value of a parameter

Definition at line 75 of file ParameterList.h.

References params_m.

merge()

void ippl::ParameterList::merge ( const ParameterList &  p )

inlinenoexcept

Merge a parameter list into this parameter list.

Parameters

p	the parameter list to merge into this

Definition at line 86 of file ParameterList.h.

References params_m.

Referenced by ippl::FFTOpenPoissonSolver< FieldLHS, FieldRHS >::FFTOpenPoissonSolver(), ippl::FFTTruncatedGreenPeriodicPoissonSolver< FieldLHS, FieldRHS >::FFTTruncatedGreenPeriodicPoissonSolver(), ippl::ParticleInteractionBase< ParticleContainer >::mergeParameters(), ippl::Maxwell< EMField, SourceField >::mergeParameters(), ippl::Poisson< FieldLHS, FieldRHS >::mergeParameters(), and ippl::ParticleInteractionBase< ParticleContainer >::ParticleInteractionBase().

operator=()

ParameterList & ippl::ParameterList::operator= ( const ParameterList &  other )

inline

Definition at line 164 of file ParameterList.h.

References params_m.

update() [1/2]

void ippl::ParameterList::update ( const ParameterList &  p )

inlinenoexcept

Update the parameter values of this list with the values provided in the input parameter list.

Parameters

p	the input parameter list with update parameter values

Definition at line 97 of file ParameterList.h.

References params_m.

Referenced by ippl::FFTOpenPoissonSolver< FieldLHS, FieldRHS >::FFTOpenPoissonSolver(), ippl::FFTTruncatedGreenPeriodicPoissonSolver< FieldLHS, FieldRHS >::FFTTruncatedGreenPeriodicPoissonSolver(), ippl::ParticleInteractionBase< ParticleContainer >::updateParameter(), ippl::Poisson< FieldLHS, FieldRHS >::updateParameter(), ippl::ParticleInteractionBase< ParticleContainer >::updateParameters(), and ippl::Poisson< FieldLHS, FieldRHS >::updateParameters().

update() [2/2]

template<typename T >

void ippl::ParameterList::update ( const std::string &  key, const T &  value  )

inline

Update the single parameter value of this list.

Parameters

key	is the name of the parameter
value	is the parameter value

Definition at line 111 of file ParameterList.h.

References params_m.

Friends And Related Function Documentation

operator<< [1/2]

std::ostream & operator<< ( std::ostream &  os, const ParameterList &  sp  )

friend

Print this parameter list.

Definition at line 137 of file ParameterList.h.

operator<< [2/2]

template<class Stream >

Stream & operator<< ( Stream &  stream, const ParameterList &  sp  )

friend

Definition at line 120 of file ParameterList.h.

Member Data Documentation

params_m

std::map<std::string, variant_t> ippl::ParameterList::params_m

protected

Definition at line 173 of file ParameterList.h.

Referenced by add(), get(), merge(), operator=(), and update().

---

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

• ParameterList.h