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

#include <RampParameter.h>

Inheritance diagram for Pscf::Rpg::RampParameter< D >:

Public Member Functions
	RampParameter ()
	Default constructor.
	RampParameter (Simulator< D > &simulator)
	Constructor that stores a pointer to parent Simulator.
Public Member Functions inherited from Pscf::Rp::RampParameter< D, Types< D > >
void	setSimulator (typename Types< D >::Simulator &simulator)
	Set the simulator and system associated with this object.
void	getInitial ()
	Get and store initial value this parameters.
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 type of 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 ramp.
void	serialize (Archive ar, const unsigned int version)
	Serialize to or from an archive.

Additional Inherited Members
Protected Member Functions inherited from Pscf::Rp::RampParameter< D, Types< D > >
	RampParameter ()
	Default constructor.
	~RampParameter ()=default
	Destructor.

Detailed Description

template<int D>
class Pscf::Rpg::RampParameter< D >

Class for storing data about an individual ramp parameter.

Specializations of this template with D=1, 2, and 3 are derived from specializations of the base class template Rp::RampParameter, and inherit their public interface and almost all of their source code from this base class. See the documentation of this base class for details.