PSCF v1.4.0
Pscf::Rpc::TrajectoryReader< D > Class Template Reference

Trajectory file reader (base class). More...

#include <TrajectoryReader.h>

Inheritance diagram for Pscf::Rpc::TrajectoryReader< D >:
Pscf::Rp::TrajectoryReader< D, Types< D > >

Public Member Functions

 TrajectoryReader (System< D > &system)
 Constructor.
virtual ~TrajectoryReader ()=default
 Destructor.
Public Member Functions inherited from Pscf::Rp::TrajectoryReader< D, Types< D > >
virtual void open (std::string filename)=0
 Open trajectory file and allocate memory if necessary.
virtual void readHeader ()
 Read header of trajectory file (if any).
virtual bool readFrame ()=0
 Read a single frame.
virtual void close ()=0
 Close the trajectory file.

Additional Inherited Members

Protected Member Functions inherited from Pscf::Rp::TrajectoryReader< D, Types< D > >
 TrajectoryReader (typename Types< D >::System &system)
 Constructor.
 ~TrajectoryReader ()=default
 Destructor.
Types< D >::System & system ()
 Return reference to parent system.

Detailed Description

template<int D>
class Pscf::Rpc::TrajectoryReader< D >

Trajectory file reader (base class).

Specializations of this template with D=1, 2, and 3 are derived from specializations of the base class template Rp::TrajectoryReader, and inherit their public interface and almost all of their source code from this base class. See the documentation of this base class template for details.

Definition at line 32 of file /fts/trajectory/TrajectoryReader.h.

Constructor & Destructor Documentation

◆ TrajectoryReader()

template<int D>
Pscf::Rpc::TrajectoryReader< D >::TrajectoryReader ( System< D > & system)

Constructor.

Parameters
systemparent System object

Definition at line 17 of file TrajectoryReader.cpp.

References Pscf::Rp::TrajectoryReader< D, Types< D > >::system(), and TrajectoryReader().

Referenced by TrajectoryReader().

◆ ~TrajectoryReader()

template<int D>
virtual Pscf::Rpc::TrajectoryReader< D >::~TrajectoryReader ( )
virtualdefault

Destructor.


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