PSCF v1.4.0

Ramp that varies parameters linearly with index. More...

#include <LinearRamp.h>

Inheritance diagram for Pscf::Rpc::LinearRamp< D >:
Pscf::Rp::LinearRamp< D, Types< D > >

Public Member Functions

 LinearRamp (Simulator< D > &simulator)
 Constructor.
Public Member Functions inherited from Pscf::Rp::LinearRamp< D, Types< D > >
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.

Additional Inherited Members

Protected Member Functions inherited from Pscf::Rp::LinearRamp< D, Types< D > >
 LinearRamp (typename Types< D >::Simulator &simulator)
 Constructor.
 ~LinearRamp ()=default
 Destructor.

Detailed Description

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

Ramp that varies parameters linearly with index.

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

See also
Rp::LinearRamp
Manual Page

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

Constructor & Destructor Documentation

◆ LinearRamp()

template<int D>
Pscf::Rpc::LinearRamp< D >::LinearRamp ( Simulator< D > & simulator)

Constructor.

Parameters
simulatorparent Simulator

Definition at line 17 of file LinearRamp.cpp.

References LinearRamp().

Referenced by LinearRamp().


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