PSCF v1.2
Public Member Functions | List of all members
pscfpp.file.File Class Reference

Class that contains metadata for a file. More...

Inheritance diagram for pscfpp.file.File:
pscfpp.file.Directory

Public Member Functions

 __init__ (self, path=None, scan=1)
 Constructor.
 
 __str__ (self)
 String representation of file data.
 
 __repr__ (self)
 String representation of file data.
 
 open (self, mode)
 Open this file in specified mode.
 
 write (self, filename)
 Write XML representation to a file.
 
 __eq__ (self, other)
 Test for equality of files.
 
 __ne__ (self, other)
 Test for inequality of files.
 

Detailed Description

Class that contains metadata for a file.

Definition at line 103 of file file.py.

Constructor & Destructor Documentation

◆ __init__()

pscfpp.file.File.__init__ ( self,
path = None,
scan = 1 )

Constructor.

Parameters
pathpath to file
scanbool flag to scan time and size

Reimplemented in pscfpp.file.Directory.

Definition at line 110 of file file.py.

References pscfpp.file.File.mtime, Pscf::PolymerSpecies.path(), Pscf::PolymerTmpl< Block >.path(), Pscf::PolymerTmpl< Block< D > >.path(), pscfpp.file.Directory.path, pscfpp.file.File.path, pscfpp.make.MakeMaker.path, pscfpp.file.Directory.scan(), pscfpp.file.File.scan, Pscf::Homogeneous::Clump.size(), Pscf::Homogeneous::Molecule.size(), Pscf::Mesh< D >.size(), Pscf::MeshIteratorFortran< D >.size(), Pscf::Prdc::Basis< D >::Star.size, Pscf::Prdc::SymmetryGroup< Symmetry >.size(), Pscf::Prdc::SymmetryGroup< SpaceSymmetry< D > >.size(), Pscf::SolventSpecies.size(), Pscf::Vertex.size(), pscfpp.file.File.size, pscfpp.text.Record.size, Util::ArrayStack< Data >.size(), Util::DSArray< Data >.size(), Util::FArray< Data, Capacity >.size(), Util::FArray< Data, 2 >.size(), Util::FArray< double, 6 >.size(), Util::FArray< int, 2 >.size(), Util::FArray< Propagator, 2 >.size(), Util::FArray< Pscf::RealVec< D >, D >.size(), Util::FArray< Rational, D >.size(), Util::FArray< Type, Capacity >.size(), Util::FArray< Util::Average, Dimension *(Dimension+1)/2 >.size(), Util::FArray< Util::Average, Dimension *Dimension >.size(), Util::FArray< Util::FMatrix< double, D, D >, 6 >.size(), Util::FPArray< Data, Capacity >.size(), Util::FSArray< T, N >.size(), Util::FSArray< bool, 6 >.size(), Util::FSArray< double, 6 >.size(), Util::FSArray< Type, Capacity >.size(), Util::GArray< Data >.size(), Util::GArray< int >.size(), Util::GArray< Propagator const * >.size(), Util::GArray< Propagator< D > const * >.size(), Util::GArray< Pscf::ParameterType >.size(), Util::GArray< Pscf::Prdc::Basis::Star >.size(), Util::GArray< Rational >.size(), Util::GArray< TP const * >.size(), Util::GArray< Util::AutoCorrStage< Data, Product > * >.size(), Util::GArray< Util::Pair< int > >.size(), Util::Grid.size(), Util::GridArray< Data >.size(), Util::GStack< Data >.size(), Util::List< Data >.size(), Util::Manager< Data >.size(), Util::Manager< Analyzer< D > >.size(), Util::Manager< McMove< D > >.size(), Util::MemoryCounter.size(), Util::PArray< Data >.size(), Util::RingBuffer< Data >.size(), Util::RingBuffer< DArray< double > >.size(), Util::RingBuffer< DeviceArray< cudaReal > >.size(), Util::RingBuffer< FieldCUDA >.size(), Util::RingBuffer< T >.size(), and Util::SSet< Data, Capacity >.size().

Member Function Documentation

◆ __str__()

pscfpp.file.File.__str__ ( self)

String representation of file data.

Reimplemented in pscfpp.file.Directory.

Definition at line 120 of file file.py.

References Pscf::PolymerSpecies.path(), Pscf::PolymerTmpl< Block >.path(), Pscf::PolymerTmpl< Block< D > >.path(), pscfpp.file.Directory.path, pscfpp.file.File.path, and pscfpp.make.MakeMaker.path.

Referenced by pscfpp.field.Field.write(), pscfpp.output.State.write(), and pscfpp.output.Thermo.write().

◆ __repr__()

pscfpp.file.File.__repr__ ( self)

String representation of file data.

Reimplemented in pscfpp.file.Directory.

Definition at line 126 of file file.py.

References pscfpp.file.File.mtime, Pscf::PolymerSpecies.path(), Pscf::PolymerTmpl< Block >.path(), Pscf::PolymerTmpl< Block< D > >.path(), pscfpp.file.Directory.path, pscfpp.file.File.path, pscfpp.make.MakeMaker.path, Pscf::Homogeneous::Clump.size(), Pscf::Homogeneous::Molecule.size(), Pscf::Mesh< D >.size(), Pscf::MeshIteratorFortran< D >.size(), Pscf::Prdc::Basis< D >::Star.size, Pscf::Prdc::SymmetryGroup< Symmetry >.size(), Pscf::Prdc::SymmetryGroup< SpaceSymmetry< D > >.size(), Pscf::SolventSpecies.size(), Pscf::Vertex.size(), pscfpp.file.File.size, pscfpp.text.Record.size, Util::ArrayStack< Data >.size(), Util::DSArray< Data >.size(), Util::FArray< Data, Capacity >.size(), Util::FArray< Data, 2 >.size(), Util::FArray< double, 6 >.size(), Util::FArray< int, 2 >.size(), Util::FArray< Propagator, 2 >.size(), Util::FArray< Pscf::RealVec< D >, D >.size(), Util::FArray< Rational, D >.size(), Util::FArray< Type, Capacity >.size(), Util::FArray< Util::Average, Dimension *(Dimension+1)/2 >.size(), Util::FArray< Util::Average, Dimension *Dimension >.size(), Util::FArray< Util::FMatrix< double, D, D >, 6 >.size(), Util::FPArray< Data, Capacity >.size(), Util::FSArray< T, N >.size(), Util::FSArray< bool, 6 >.size(), Util::FSArray< double, 6 >.size(), Util::FSArray< Type, Capacity >.size(), Util::GArray< Data >.size(), Util::GArray< int >.size(), Util::GArray< Propagator const * >.size(), Util::GArray< Propagator< D > const * >.size(), Util::GArray< Pscf::ParameterType >.size(), Util::GArray< Pscf::Prdc::Basis::Star >.size(), Util::GArray< Rational >.size(), Util::GArray< TP const * >.size(), Util::GArray< Util::AutoCorrStage< Data, Product > * >.size(), Util::GArray< Util::Pair< int > >.size(), Util::Grid.size(), Util::GridArray< Data >.size(), Util::GStack< Data >.size(), Util::List< Data >.size(), Util::Manager< Data >.size(), Util::Manager< Analyzer< D > >.size(), Util::Manager< McMove< D > >.size(), Util::MemoryCounter.size(), Util::PArray< Data >.size(), Util::RingBuffer< Data >.size(), Util::RingBuffer< DArray< double > >.size(), Util::RingBuffer< DeviceArray< cudaReal > >.size(), Util::RingBuffer< FieldCUDA >.size(), Util::RingBuffer< T >.size(), and Util::SSet< Data, Capacity >.size().

◆ open()

pscfpp.file.File.open ( self,
mode )

Open this file in specified mode.

Parameters
modemode for opening, e.g., 'w' or 'r'

Definition at line 146 of file file.py.

References pscfpp.file.File.open(), Pscf::PolymerSpecies.path(), Pscf::PolymerTmpl< Block >.path(), Pscf::PolymerTmpl< Block< D > >.path(), pscfpp.file.Directory.path, pscfpp.file.File.path, and pscfpp.make.MakeMaker.path.

Referenced by pscfpp.file.File.open(), pscfpp.file.Directory.write(), and pscfpp.file.File.write().

◆ write()

pscfpp.file.File.write ( self,
filename )

Write XML representation to a file.

Parameters
filenamename of output file

Reimplemented in pscfpp.file.Directory.

Definition at line 154 of file file.py.

References pscfpp.file.File.open(), pscfpp.file.Directory.xml(), and pscfpp.file.File.xml().

◆ __eq__()

pscfpp.file.File.__eq__ ( self,
other )

Test for equality of files.

This function returns true if this and other are equivalent.

Parameters
otherfile to which to compare this one.

Reimplemented in pscfpp.file.Directory.

Definition at line 166 of file file.py.

References Pscf::PolymerSpecies.path(), Pscf::PolymerTmpl< Block >.path(), Pscf::PolymerTmpl< Block< D > >.path(), pscfpp.file.Directory.path, pscfpp.file.File.path, pscfpp.make.MakeMaker.path, Pscf::Homogeneous::Clump.size(), Pscf::Homogeneous::Molecule.size(), Pscf::Mesh< D >.size(), Pscf::MeshIteratorFortran< D >.size(), Pscf::Prdc::Basis< D >::Star.size, Pscf::Prdc::SymmetryGroup< Symmetry >.size(), Pscf::Prdc::SymmetryGroup< SpaceSymmetry< D > >.size(), Pscf::SolventSpecies.size(), Pscf::Vertex.size(), pscfpp.file.File.size, pscfpp.text.Record.size, Util::ArrayStack< Data >.size(), Util::DSArray< Data >.size(), Util::FArray< Data, Capacity >.size(), Util::FArray< Data, 2 >.size(), Util::FArray< double, 6 >.size(), Util::FArray< int, 2 >.size(), Util::FArray< Propagator, 2 >.size(), Util::FArray< Pscf::RealVec< D >, D >.size(), Util::FArray< Rational, D >.size(), Util::FArray< Type, Capacity >.size(), Util::FArray< Util::Average, Dimension *(Dimension+1)/2 >.size(), Util::FArray< Util::Average, Dimension *Dimension >.size(), Util::FArray< Util::FMatrix< double, D, D >, 6 >.size(), Util::FPArray< Data, Capacity >.size(), Util::FSArray< T, N >.size(), Util::FSArray< bool, 6 >.size(), Util::FSArray< double, 6 >.size(), Util::FSArray< Type, Capacity >.size(), Util::GArray< Data >.size(), Util::GArray< int >.size(), Util::GArray< Propagator const * >.size(), Util::GArray< Propagator< D > const * >.size(), Util::GArray< Pscf::ParameterType >.size(), Util::GArray< Pscf::Prdc::Basis::Star >.size(), Util::GArray< Rational >.size(), Util::GArray< TP const * >.size(), Util::GArray< Util::AutoCorrStage< Data, Product > * >.size(), Util::GArray< Util::Pair< int > >.size(), Util::Grid.size(), Util::GridArray< Data >.size(), Util::GStack< Data >.size(), Util::List< Data >.size(), Util::Manager< Data >.size(), Util::Manager< Analyzer< D > >.size(), Util::Manager< McMove< D > >.size(), Util::MemoryCounter.size(), Util::PArray< Data >.size(), Util::RingBuffer< Data >.size(), Util::RingBuffer< DArray< double > >.size(), Util::RingBuffer< DeviceArray< cudaReal > >.size(), Util::RingBuffer< FieldCUDA >.size(), Util::RingBuffer< T >.size(), and Util::SSet< Data, Capacity >.size().

◆ __ne__()

pscfpp.file.File.__ne__ ( self,
other )

Test for inequality of files.

This function returns true if this and other are in-equivalent.

Parameters
otherfile to which to compare this one.

Reimplemented in pscfpp.file.Directory.

Definition at line 179 of file file.py.

The documentation for this class was generated from the following file:
Generated on Mon Apr 14 2025 16:29:28 for PSCF by doxygen 1.12.0