Module oc_file_mod

1.

Purpose: defines the fileinfo type and basic operations on files.

2.

Types

(a)

fileinfo :

member type description

name character(len=128):: file tag

nd integer:: number of file dimensions

esize integer:: file element size

n integer(nd):: SEPlib n for file

o real(nd):: SEPlib o for file

d real(nd):: SEPlib d for file

blon integer:: number of blocks

bloe integer:: number of elements in a block

blob integer:: number of bytes in a block

3.

Functions and subroutines

(a)

subroutine oc_allocatefile(file, t_, maxmem)

Purpose: allocate an object of type fileinfo

(b)

subroutine oc_deallocatefile(file)

Purpose: deallocate an object of type fileinfo

(c)

subroutine oc_infofile(file)

Purpose: print the file informations

(d)

subroutine oc_checksimilarity(file1,file2,caller)

Purpose: check if two files have identical spaces and elements

• caller: string identifying the caller (optional)

(e)

subroutine oc_checkspace(file1,file2,caller)

Purpose: check if two files have identical spaces

• caller: string identifying the caller (optional)

(f)

function oc_allocate(tmp,name,esize,n,o,d) result(t_)

Purpose: allocate a new file

• t_: file tag
• tmp: flag for temporary files
• name: file name
• esize: SEPlib esize (optional)
• n,o,d: SEPlib n,o,d (optional)

(g)

function oc_clone(tmp, t0_,name, maxmem) result(t_)

Purpose: duplicate the structure of a file in a new file

• t_: new file tag
• tmp: flag for temporary files
• t0_: old file tag
• name: new file name

(h)

subroutine oc_append(t_,s_, maxmem)

Purpose: append the contents of file s_ at the end of file t_

(i)

subroutine oc_adddim(t_, nnew)

Purpose: add a new axis to a file

• nnew: SEPlib n

(j)

subroutine oc_shapeheader(t_, esize, n,o,d)

Purpose: shape a file header

• t_: file tag
• name: file name
• esize: SEPlib esize
• n: SEPlib n
• o,d: SEPlib o,d (optional)

(k)

subroutine oc_print(t_, maxmem)

Purpose: print the contents of a file