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

Sweep in which parameters vary linearly with sweep variable s. More...

#include <LinearSweep.h>

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

Public Member Functions
void	readParameters (std::istream &in)
	Read parameters from param file.
void	setup ()
	Setup operation at the beginning of a sweep.
void	setParameters (double s)
	Set state parameters before solving an SCFT problem.
void	outputSummary (std::ostream &out)
	Output data to a running summary.

Protected Member Functions
	LinearSweep (typename T::System &system)
	Constructor.

Detailed Description

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

Sweep in which parameters vary linearly with sweep variable s.

See also

Manual page

Definition at line 29 of file rp/scft/sweep/LinearSweep.h.

Constructor & Destructor Documentation

LinearSweep()

template<int D, class T>

Pscf::Rp::LinearSweep< D, T >::LinearSweep ( typename T::System & system )

protected

Constructor.

Parameters

system

parent system object

Definition at line 19 of file LinearSweep.tpp.

Member Function Documentation

readParameters()

template<int D, class T>

void Pscf::Rp::LinearSweep< D, T >::readParameters

(

std::istream &

in

)

Read parameters from param file.

Parameters

in	parameter file input stream

Definition at line 24 of file LinearSweep.tpp.

References Pscf::SweepTmpl< BasisFieldStateT >::parameterTypes_, and Util::ParamComposite::read().

setup()

template<int D, class T>

void Pscf::Rp::LinearSweep< D, T >::setup

(

)

Setup operation at the beginning of a sweep.

Gets and stores initial values of individual swept parameters.

Definition at line 54 of file LinearSweep.tpp.

setParameters()

template<int D, class T>

void Pscf::Rp::LinearSweep< D, T >::setParameters

(

double

s

)

Set state parameters before solving an SCFT problem.

Called by SweepTmpl::sweep() for each state in a sweep.

Parameters

s	path length coordinate, in [0,1]

Definition at line 70 of file LinearSweep.tpp.

outputSummary()

template<int D, class T>

void Pscf::Rp::LinearSweep< D, T >::outputSummary

(

std::ostream &

out

)

Output data to a running summary.

Parameters

out	output file, open for writing

Definition at line 81 of file LinearSweep.tpp.

---

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

• rp/scft/sweep/LinearSweep.h
• LinearSweep.tpp