file::file_t Type Reference

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...

Public Member Functions
procedure, pass(this)	init (this, fname, header, precision, layout, overwrite)
	Constructor.
procedure	write (this, data, t)
	Writes data to a file.
procedure	read (this, data)
	Read data from a file.
procedure	get_fname (this)
	Get a file's name.
procedure	get_base_fname (this)
	Get a file's base name.
procedure	get_counter (this)
	Get a file's counter.
procedure	set_counter (this, n)
	Set a file's counter.
procedure	set_start_counter (this, n)
	Set a file's start counter.
procedure	set_header (this, hd)
	Set a file's header.
procedure	set_precision (this, precision)
	Set a file's output precision.
procedure	set_layout (this, layout)
	Set a file's output layout.
procedure, pass(this)	set_overwrite (this, overwrite)
	Sets the file's overwrite flag.
procedure, pass(this)	free (this)
	File operation destructor.

Public Attributes
class(generic_file_t), allocatable	file_type

Detailed Description

Definition at line 55 of file file.f90.

Member Function/Subroutine Documentation

free()

procedure, pass(this) file::file_t::free

(

class(file_t), intent(inout)

this

)

Definition at line 83 of file file.f90.

get_base_fname()

procedure file::file_t::get_base_fname

(

class(file_t), intent(in)

this

)

Definition at line 67 of file file.f90.

get_counter()

procedure file::file_t::get_counter

(

class(file_t), intent(inout)

this

)

Definition at line 69 of file file.f90.

get_fname()

procedure file::file_t::get_fname

(

class(file_t), intent(in)

this

)

Definition at line 65 of file file.f90.

init()

procedure, pass(this) file::file_t::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 59 of file file.f90.

read()

procedure file::file_t::read	(	class(file_t), intent(in)	this,
		class(*), intent(inout)	data
	)

Parameters

data	Read data.

Definition at line 63 of file file.f90.

set_counter()

procedure file::file_t::set_counter	(	class(file_t), intent(inout)	this,
		integer, intent(in)	n
	)

Definition at line 71 of file file.f90.

set_header()

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

Definition at line 75 of file file.f90.

set_layout()

procedure file::file_t::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 79 of file file.f90.

set_overwrite()

procedure, pass(this) file::file_t::set_overwrite	(	class(file_t), intent(inout)	this,
		logical, intent(in)	overwrite
	)

Definition at line 81 of file file.f90.

set_precision()

procedure file::file_t::set_precision	(	class(file_t), intent(inout)	this,
		integer, intent(in)	precision
	)

Parameters

precision

Precision as defined in num_types.

Definition at line 77 of file file.f90.

set_start_counter()

procedure file::file_t::set_start_counter	(	class(file_t), intent(inout)	this,
		integer, intent(in)	n
	)

Definition at line 73 of file file.f90.

write()

procedure file::file_t::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 61 of file file.f90.

Member Data Documentation

file_type

class(generic_file_t), allocatable file::file_t::file_type

Definition at line 56 of file file.f90.

---

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

• /home/runner/work/neko/neko/src/io/file.f90