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

Periodically write the step index to a log file. More...

#include <StepLogger.h>

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

Public Member Functions
void	readParameters (std::istream &in) override
	Read interval.
void	sample (long iStep) override
	Write the step index to a log file.

Protected Member Functions
	StepLogger (typename T::Simulator &simulator, typename T::System &system)
	Constructor.
	~StepLogger ()=default
	Destructor.

Detailed Description

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

Periodically write the step index to a log file.

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

Template parameters:

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

See also

Manual Page

Definition at line 33 of file fts/analyzer/StepLogger.h.

Constructor & Destructor Documentation

StepLogger()

template<int D, class T>

Pscf::Rp::StepLogger< D, T >::StepLogger ( typename T::Simulator & simulator, typename T::System & system )

protected

Constructor.

Parameters

simulator	parent Simulator object
system	parent System object

Definition at line 23 of file StepLogger.tpp.

References Util::ParamComposite::setClassName().

~StepLogger()

template<int D, class T>

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

protecteddefault

Destructor.

Member Function Documentation

readParameters()

template<int D, class T>

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

override

Read interval.

Parameters

in	input parameter file

Definition at line 32 of file StepLogger.tpp.

sample()

template<int D, class T>

void Pscf::Rp::StepLogger< D, T >::sample ( long iStep )

override

Write the step index to a log file.

Parameters

iStep

step index

Definition at line 39 of file StepLogger.tpp.

References Util::Log::file().

---

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

• fts/analyzer/StepLogger.h
• StepLogger.tpp