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

Periodically write field frames (snapshots) to a trajectory file. More...

#include <TrajectoryWriter.h>

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

Public Member Functions
void	readParameters (std::istream &in) override
	Read interval and output file name.
void	setup () override
	Setup before main simulation loop.
void	sample (long iStep) override
	Write a frame/snapshot to the trajectory file.
void	output () override
	Close trajectory file after run.

Protected Member Functions
	TrajectoryWriter (typename T::Simulator &simulator, typename T::System &system)
	Constructor.
	~TrajectoryWriter ()=default
	Destructor.
void	writeHeader (std::ofstream &out)
	Write data that should appear once, at beginning of the file.
void	writeFrame (std::ofstream &out, long iStep)
	Write data that should appear in every frame.

Detailed Description

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

Periodically write field frames (snapshots) to a trajectory file.

Specializations of this template are used as base classes for two closely analogous class templates, also named TrajectoryWriter, 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 34 of file fts/analyzer/TrajectoryWriter.h.

Constructor & Destructor Documentation

TrajectoryWriter()

template<int D, class T>

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

protected

Constructor.

Parameters

simulator	parent Simulator object
system	parent System object

Definition at line 24 of file TrajectoryWriter.tpp.

References Util::ParamComposite::setClassName().

~TrajectoryWriter()

template<int D, class T>

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

protecteddefault

Destructor.

Member Function Documentation

readParameters()

template<int D, class T>

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

override

Read interval and output file name.

Parameters

in	input parameter file

Definition at line 35 of file TrajectoryWriter.tpp.

setup()

template<int D, class T>

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

override

Setup before main simulation loop.

Definition at line 45 of file TrajectoryWriter.tpp.

sample()

template<int D, class T>

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

override

Write a frame/snapshot to the trajectory file.

Parameters

iStep

step index

Definition at line 57 of file TrajectoryWriter.tpp.

References writeFrame().

output()

template<int D, class T>

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

override

Close trajectory file after run.

Definition at line 69 of file TrajectoryWriter.tpp.

writeHeader()

template<int D, class T>

void Pscf::Rp::TrajectoryWriter< D, T >::writeHeader ( std::ofstream & out )

protected

Write data that should appear once, at beginning of the file.

Parameters

out	output file stream

Definition at line 76 of file TrajectoryWriter.tpp.

writeFrame()

template<int D, class T>

void Pscf::Rp::TrajectoryWriter< D, T >::writeFrame ( std::ofstream & out, long iStep )

protected

Write data that should appear in every frame.

Parameters

out	output file stream
iStep	MC time step index

Definition at line 91 of file TrajectoryWriter.tpp.

Referenced by sample().

---

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

• fts/analyzer/TrajectoryWriter.h
• TrajectoryWriter.tpp