Pscf::Rp::LinearRamp< D, T > Class Template Reference

Linear ramp - parameters vary linearly with step index. More...

#include <LinearRamp.h>

Inheritance diagram for Pscf::Rp::LinearRamp< D, T >:

Public Member Functions
void	readParameters (std::istream &in) override
	Read parameters from parameter file input stream.
void	setup (int nStep) override
	Set nStep and complete initialization.
void	setParameters (int iStep) override
	Set new parameters values in associated System and Simulator.
void	output () override
	Output information at the end of a simulation.

Protected Member Functions
	LinearRamp (typename T::Simulator &simulator)
	Constructor.
	~LinearRamp ()=default
	Destructor.

Detailed Description

template<int D, class T>
class Pscf::Rp::LinearRamp< D, T >

Linear ramp - parameters vary linearly with step index.

Specializations of this class template are used as base classes for two closely analogous class templates, both also named LinearRamp, that are defined in Rpc and Rpg namespaces for use in the pscf_rpc and pscf_rpg programs, respectively.

Template parameters:

• D : dimension
• T : Types class, Rpc::Types<D> or Rpg::Types<D>

See also

Manual Page (Linear Ramp)

Manual Page (Ramp)"

Definition at line 30 of file fts/ramp/LinearRamp.h.

Constructor & Destructor Documentation

LinearRamp()

template<int D, class T>

Pscf::Rp::LinearRamp< D, T >::LinearRamp ( typename T::Simulator & simulator )

protected

Constructor.

Parameters

simulator

parent Simulator object

Definition at line 16 of file LinearRamp.tpp.

References Util::ParamComposite::setClassName().

~LinearRamp()

template<int D, class T>

Pscf::Rp::LinearRamp< D, T >::~LinearRamp ( )

protecteddefault

Destructor.

Member Function Documentation

readParameters()

template<int D, class T>

void Pscf::Rp::LinearRamp< D, T >::readParameters ( std::istream & in )

override

Read parameters from parameter file input stream.

Parameters

in	input parameter file stream

Definition at line 21 of file LinearRamp.tpp.

References Util::ParamComposite::read(), Util::ParamComposite::readDArray(), and UTIL_CHECK.

setup()

template<int D, class T>

void Pscf::Rp::LinearRamp< D, T >::setup ( int nStep )

override

Set nStep and complete initialization.

This method is called just before the beginning of the main simulation loop.

Parameters

nStep

number of steps planned for this simulation

Definition at line 46 of file LinearRamp.tpp.

setParameters()

template<int D, class T>

void Pscf::Rp::LinearRamp< D, T >::setParameters ( int iStep )

override

Set new parameters values in associated System and Simulator.

Parameters

iStep

current simulation step index

Definition at line 58 of file LinearRamp.tpp.

output()

template<int D, class T>

void Pscf::Rp::LinearRamp< D, T >::output ( )

override

Output information at the end of a simulation.

Definition at line 78 of file LinearRamp.tpp.

References Util::Log::file().

---

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

• fts/ramp/LinearRamp.h
• LinearRamp.tpp