Class for storing data about an individual sweep parameter. More...

#include <SweepParameter.h>

Inheritance diagram for Pscf::Rpc::SweepParameter< D >:

Public Member Functions
	SweepParameter ()
	Default constructor.
	SweepParameter (System< D > &system)
	Constructor that stores a pointer to the parent system.
Public Member Functions inherited from Pscf::Rp::SweepParameter< D, Types< D > >
void	setSystem (typename Types< D >::System &system)
	Set the system associated with this object.
void	setParameterTypesArray (GArray< ParameterType > &array)
	Set the pointer to the array of specialized sweep parameter types.
ParameterType &	parameterType () const
	Get the ParameterType object for a specialized sweep parameter.
int	parameterTypeId () const
	Get the array index for the specialized sweep parameter.
bool	isSpecialized () const
	Is this SweepParameter a specialized parameter type?
void	getInitial ()
	Get initial value of this parameter.
void	update (double newVal)
	Update the corresponding parameter value in the system.
std::string	type () const
	Return a string representation of the parameter type.
void	writeParamType (std::ostream &out) const
	Write the parameter type to an output stream.
int	id (int i) const
	Get id for a sub-object or element to which this is applied.
int	nId () const
	Number of indices associated with this parameter.
double	current ()
	Get the current system parameter value.
double	initial () const
	Get the initial system parameter value.
double	change () const
	Get the total change planned for this parameter during sweep.
void	serialize (Archive ar, const unsigned int version)
	Serialize to or from an archive.

Additional Inherited Members
Protected Member Functions inherited from Pscf::Rp::SweepParameter< D, Types< D > >
	SweepParameter ()
	Default constructor.

Detailed Description

template<int D>
class Pscf::Rpc::SweepParameter< D >

Class for storing data about an individual sweep parameter.

Specializations of this template with D=1, 2, and 3 are derived from corresponding specializations of base class template Rp::SweepParameter, and inherit their public interface and almost all of their source code from this base class.