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

Periodically write c-field snapshots to a trajectory file. More...

#include <ConcentrationWriter.h>

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

Public Member Functions
	ConcentrationWriter (typename T::Simulator &simulator, typename T::System &system)
	Constructor.
void	readParameters (std::istream &in) override
	Read interval and output file name.
void	setup () override
	Initialize before main simulation loop.
void	sample (long iStep) override
	Write a frame/snapshot to trajectory file.
void	output () override
	Close trajectory file after run.

Detailed Description

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

Periodically write c-field snapshots to a trajectory file.

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

Constructor & Destructor Documentation

ConcentrationWriter()

template<int D, class T>

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

Constructor.

Parameters

simulator	parent Simulator object
system	parent System object

Definition at line 26 of file ConcentrationWriter.tpp.

References Util::ParamComposite::setClassName().

Member Function Documentation

readParameters()

template<int D, class T>

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

override

Read interval and output file name.

Parameters

in	input parameter file

Definition at line 38 of file ConcentrationWriter.tpp.

setup()

template<int D, class T>

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

override

Initialize before main simulation loop.

Definition at line 48 of file ConcentrationWriter.tpp.

References UTIL_CHECK.

sample()

template<int D, class T>

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

override

Write a frame/snapshot to trajectory file.

Parameters

iStep

step index

Definition at line 97 of file ConcentrationWriter.tpp.

References UTIL_CHECK.

output()

template<int D, class T>

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

override

Close trajectory file after run.

Definition at line 110 of file ConcentrationWriter.tpp.

---

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

• fts/analyzer/ConcentrationWriter.h
• ConcentrationWriter.tpp