file Module Reference

Module for file I/O operations.

Data Types
type	file_t
	A wrapper around a polymorphic generic_file_t that handles its init. This is essentially a factory for generic_file_t descendants additionally handling special CSV file parameters (header and precision). More...

Functions/Subroutines
subroutine	file_init (this, fname, header, precision, layout, overwrite)
	Constructor.
subroutine	file_free (this)
	File operation destructor.
subroutine	file_write (this, data, t)
	Writes data to a file.
subroutine	file_read (this, data)
	Read data from a file.
character(len=1024) function	file_get_fname (this)
	Get a file's name.
character(len=1024) function	file_get_base_fname (this)
	Get a file's base name.
integer function	file_get_counter (this)
	Get a file's counter.
subroutine	file_set_counter (this, n)
	Set a file's counter.
subroutine	file_set_start_counter (this, n)
	Set a file's start counter.
subroutine	file_set_header (this, hd)
	Set a file's header.
subroutine	file_set_precision (this, precision)
	Set a file's output precision.
subroutine	file_set_layout (this, layout)
	Set a file's output layout.
subroutine	file_set_overwrite (this, overwrite)
	Sets the file's overwrite flag.

Function/Subroutine Documentation

file_free()

subroutine file::file_free

(

class(file_t), intent(inout)

this

)

Definition at line 155 of file file.f90.

file_get_base_fname()

character(len=1024) function file::file_get_base_fname

(

class(file_t), intent(in)

this

)

Definition at line 200 of file file.f90.

file_get_counter()

integer function file::file_get_counter

(

class(file_t), intent(inout)

this

)

Definition at line 214 of file file.f90.

file_get_fname()

character(len=1024) function file::file_get_fname

(

class(file_t), intent(in)

this

)

Definition at line 186 of file file.f90.

file_init()

subroutine file::file_init	(	class(file_t), intent(inout)	this,
		character(len=*), intent(in)	fname,
		character(len=*), intent(in), optional	header,
		integer, intent(in), optional	precision,
		integer, intent(in), optional	layout,
		logical, intent(in), optional	overwrite
	)

Parameters

fname

Filename.

Definition at line 90 of file file.f90.

Here is the call graph for this function:

file_read()

subroutine file::file_read	(	class(file_t), intent(in)	this,
		class(*), intent(inout)	data
	)

Parameters

data	Read data.

Definition at line 177 of file file.f90.

file_set_counter()

subroutine file::file_set_counter	(	class(file_t), intent(inout)	this,
		integer, intent(in)	n
	)

Definition at line 227 of file file.f90.

file_set_header()

subroutine file::file_set_header	(	class(file_t), intent(inout)	this,
		character(len=*), intent(in)	hd
	)

Definition at line 251 of file file.f90.

Here is the call graph for this function:

file_set_layout()

subroutine file::file_set_layout	(	class(file_t), intent(inout)	this,
		integer, intent(in)	layout
	)

Parameters

layout

The data layout as defined in bp_file.f90 and src/io/buffer/.

Definition at line 288 of file file.f90.

Here is the call graph for this function:

file_set_overwrite()

subroutine file::file_set_overwrite	(	class(file_t), intent(inout)	this,
		logical, intent(in)	overwrite
	)

Definition at line 304 of file file.f90.

file_set_precision()

subroutine file::file_set_precision	(	class(file_t), intent(inout)	this,
		integer, intent(in)	precision
	)

Parameters

precision

Precision as defined in num_types.

Definition at line 268 of file file.f90.

Here is the call graph for this function:

file_set_start_counter()

subroutine file::file_set_start_counter	(	class(file_t), intent(inout)	this,
		integer, intent(in)	n
	)

Definition at line 239 of file file.f90.

file_write()

subroutine file::file_write	(	class(file_t), intent(inout)	this,
		class(*), intent(inout)	data,
		real(kind=rp), intent(in), optional	t
	)

Parameters

data	Data to be written.

Definition at line 166 of file file.f90.