DISPATCH
fortranfile.FortranFile Class Reference
Inheritance diagram for fortranfile.FortranFile:
Collaboration diagram for fortranfile.FortranFile:

Public Member Functions

def __init__ (self, fname, args, kwargs)
 
def readRecord (self)
 
def writeRecord (self, s)
 
def readString (self)
 
def writeString (self, s)
 
def readReals (self, prec='f')
 
def writeReals (self, reals, prec='f')
 
def readInts (self, prec='i')
 
def writeInts (self, ints, prec='i')
 

Properties

 ENDIAN
 
 HEADER_PREC
 

Detailed Description

File with methods for dealing with fortran unformatted data files

Definition at line 54 of file fortranfile.py.

Constructor & Destructor Documentation

◆ __init__()

def fortranfile.FortranFile.__init__ (   self,
  fname,
  args,
  kwargs 
)
Open a Fortran unformatted file for writing.

Parameters
----------
endian : character, optional
    Specify the endian-ness of the file.  Possible values are
    '>', '<', '@' and '='.  See the documentation of Python's
    struct module for their meanings.  The deafult is '>' (native
    byte order)
header_prec : character, optional
    Specify the precision used for the record headers.  Possible
    values are 'h', 'i', 'l' and 'q' with their meanings from
    Python's struct module.  The default is 'i' (the system's
    default integer).

Definition at line 92 of file fortranfile.py.

References fortranfile.FortranFile._header_length, fortranfile.FortranFile._read_exactly(), fortranfile.FortranFile.ENDIAN, fortranfile.FortranFile.HEADER_PREC, mpi_buffer_mod::mpi_buffer_t.read(), mpi_io_mod::mpi_io_t.read(), f90nml.parser.Parser.read(), mpi_file_mod::mpi_file_t.write(), buffered_io_mod::buffered_io_t.write(), mpi_io_mod::mpi_io_t.write(), and f90nml.namelist.Namelist.write().

Member Function Documentation

◆ readInts()

def fortranfile.FortranFile.readInts (   self,
  prec = 'i' 
)
Read an array of integers.

Parameters
----------
prec : character, optional
    Specify the precision of the data to be read using 
    character codes from Python's struct module.  Possible
    values are 'h', 'i', 'l' and 'q'

Definition at line 232 of file fortranfile.py.

References fortranfile.FortranFile._int_precisions, fortranfile.FortranFile.ENDIAN, and fortranfile.FortranFile.readRecord().

◆ readReals()

def fortranfile.FortranFile.readReals (   self,
  prec = 'f' 
)
Read in an array of real numbers.

Parameters
----------
prec : character, optional
    Specify the precision of the array using character codes from
    Python's struct module.  Possible values are 'd' and 'f'.

Definition at line 185 of file fortranfile.py.

References fortranfile.FortranFile._real_precisions, fortranfile.FortranFile.ENDIAN, and fortranfile.FortranFile.readRecord().

◆ readRecord()

def fortranfile.FortranFile.readRecord (   self)

◆ readString()

def fortranfile.FortranFile.readString (   self)
Read a string.

Definition at line 169 of file fortranfile.py.

References fortranfile.FortranFile.readRecord().

◆ writeInts()

def fortranfile.FortranFile.writeInts (   self,
  ints,
  prec = 'i' 
)
Write an array of integers in given precision

Parameters
----------
reals : array
    Data to write
prec : string
    Character code for the precision to use in writing

Definition at line 250 of file fortranfile.py.

References fortranfile.FortranFile._int_precisions, fortranfile.FortranFile._write_check(), fortranfile.FortranFile.ENDIAN, mpi_file_mod::mpi_file_t.write(), buffered_io_mod::buffered_io_t.write(), mpi_io_mod::mpi_io_t.write(), and f90nml.namelist.Namelist.write().

◆ writeReals()

def fortranfile.FortranFile.writeReals (   self,
  reals,
  prec = 'f' 
)
Write an array of floats in given precision

Parameters
----------
reals : array
    Data to write
prec` : string
    Character code for the precision to use in writing

Definition at line 208 of file fortranfile.py.

References fortranfile.FortranFile._real_precisions, fortranfile.FortranFile._write_check(), fortranfile.FortranFile.ENDIAN, mpi_file_mod::mpi_file_t.write(), buffered_io_mod::buffered_io_t.write(), mpi_io_mod::mpi_io_t.write(), and f90nml.namelist.Namelist.write().

◆ writeRecord()

def fortranfile.FortranFile.writeRecord (   self,
  s 
)
Write a record with the given bytes.

Parameters
----------
s : the string to write

Definition at line 156 of file fortranfile.py.

References fortranfile.FortranFile._write_check(), mpi_file_mod::mpi_file_t.write(), buffered_io_mod::buffered_io_t.write(), mpi_io_mod::mpi_io_t.write(), and f90nml.namelist.Namelist.write().

Referenced by fortranfile.FortranFile.writeString().

◆ writeString()

def fortranfile.FortranFile.writeString (   self,
  s 
)
Write a string

Parameters
----------
s : the string to write

Definition at line 173 of file fortranfile.py.

References fortranfile.FortranFile.writeRecord().

Property Documentation

◆ ENDIAN

fortranfile.FortranFile.ENDIAN
static
Initial value:
= property(fset=_set_endian,
fget=_get_endian,
doc="Possible endian values are '<', '>', '@', '='"
)

Definition at line 75 of file fortranfile.py.

Referenced by fortranfile.FortranFile.__init__(), fortranfile.FortranFile.readInts(), fortranfile.FortranFile.readReals(), fortranfile.FortranFile.writeInts(), and fortranfile.FortranFile.writeReals().

◆ HEADER_PREC

fortranfile.FortranFile.HEADER_PREC
static
Initial value:
= property(fset=_set_header_prec,
fget=_get_header_prec,
doc="Possible header precisions are 'h', 'i', 'l', 'q'"
)

Definition at line 87 of file fortranfile.py.

Referenced by fortranfile.FortranFile.__init__().


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