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

RealMove generates spatially uncorrelated random field changes. More...

#include <RealMove.h>

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

Public Member Functions
void	readParameters (std::istream &in) override
	Read body of parameter file block.
void	setup () override
	Setup before the simulation loop.

Protected Member Functions
	RealMove (typename T::McSimulator &simulator)
	Constructor.
	~RealMove ()=default
	Destructor.
void	attemptMove () override
	Attempt unconstrained move.

Detailed Description

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

RealMove generates spatially uncorrelated random field changes.

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

Template parameters:

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

See also

Manual Page

Definition at line 36 of file fts/montecarlo/RealMove.h.

Constructor & Destructor Documentation

RealMove()

template<int D, class T>

Pscf::Rp::RealMove< D, T >::RealMove ( typename T::McSimulator & simulator )

protected

Constructor.

Parameters

simulator

parent McSimulator object

Definition at line 23 of file RealMove.tpp.

References Util::ParamComposite::setClassName().

~RealMove()

template<int D, class T>

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

protecteddefault

Destructor.

Member Function Documentation

readParameters()

template<int D, class T>

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

override

Read body of parameter file block.

Parameters

in	input parameter stream

Definition at line 35 of file RealMove.tpp.

References Util::ParamComposite::read().

setup()

template<int D, class T>

void Pscf::Rp::RealMove< D, T >::setup ( )

override

Setup before the simulation loop.

Definition at line 47 of file RealMove.tpp.

attemptMove()

template<int D, class T>

void Pscf::Rp::RealMove< D, T >::attemptMove ( )

overrideprotected

Attempt unconstrained move.

Definition at line 67 of file RealMove.tpp.

---

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

• fts/montecarlo/RealMove.h
• RealMove.tpp