Inheritance diagram for csv_file::csv_file_t:

Collaboration diagram for csv_file::csv_file_t:

Public Member Functions
procedure	write (this, data, t)
	Writes data to an output file.

procedure	read (this, data)
	Reads data from an input file.

procedure	set_header (this, hd)
	Sets the header for a csv file.

procedure	set_overwrite (this, overwrite)
	Sets the overwrite flag for a csv file.

procedure	count_lines (this)
	Count the number of lines in a file.

procedure	init (this, fname)
	Generic file constructor.

procedure(generic_file_write), deferred	write (this, data, t)
	Read method.

procedure(generic_file_read), deferred	read (this, data)

procedure	get_fname (this)
	Get a file's name.

procedure	get_base_fname (this)
	Get base name without counter.

procedure	set_counter (this, n)
	Set the file counter to n.

procedure	get_counter (this)
	Get the file counter.

procedure	set_start_counter (this, n)
	Set the file start counter to n.

procedure	get_start_counter (this)
	Get the file start counter.

procedure	increment_counter (this)
	Increment the file counter by 1.

procedure	check_exists (this)
	Ensure the file exists.

procedure	set_overwrite (this, overwrite)
	Set overwrite mode.

Public Attributes
character(len=1024)	header = ""
	Contains header of file.

logical	header_is_written = .false.
	Has header already been written?

logical	serial = .false.
	File format is serial.

logical	overwrite = .false.

Private Attributes
character(len=1024), private	fname

integer, private	counter = -1

integer, private	start_counter = 0

Detailed Description

Definition at line 45 of file csv_file.f90.

Member Function/Subroutine Documentation

◆ check_exists()

procedure generic_file::generic_file_t::check_exists ( class(generic_file_t), intent(in) this )

inherited

Definition at line 71 of file generic_file.f90.

◆ count_lines()

procedure csv_file::csv_file_t::count_lines ( class(csv_file_t), intent(in) this )

Definition at line 58 of file csv_file.f90.

◆ get_base_fname()

procedure generic_file::generic_file_t::get_base_fname ( class(generic_file_t), intent(in) this )

inherited

Definition at line 59 of file generic_file.f90.

◆ get_counter()

procedure generic_file::generic_file_t::get_counter ( class(generic_file_t), intent(in) this )

inherited

Definition at line 63 of file generic_file.f90.

◆ get_fname()

procedure generic_file::generic_file_t::get_fname ( class(generic_file_t), intent(in) this )

inherited

Definition at line 57 of file generic_file.f90.

◆ get_start_counter()

procedure generic_file::generic_file_t::get_start_counter ( class(generic_file_t), intent(in) this )

inherited

Definition at line 67 of file generic_file.f90.

◆ increment_counter()

procedure generic_file::generic_file_t::increment_counter ( class(generic_file_t), intent(inout) this )

inherited

Definition at line 69 of file generic_file.f90.

◆ init()

procedure generic_file::generic_file_t::init	(	class(generic_file_t)	this,
		character(len=*)	fname
	)

inherited

Write method.

Definition at line 51 of file generic_file.f90.

◆ read() [1/2]

procedure csv_file::csv_file_t::read	(	class(csv_file_t)	this,
		class(*), intent(inout), target	data
	)

Parameters

this	csv file in which to read.
data	`matrix_t` or `vector_t`, will contain the read data.

Definition at line 52 of file csv_file.f90.

◆ read() [2/2]

procedure(generic_file_read), deferred generic_file::generic_file_t::read	(	class(generic_file_t)	this,
		class(*), intent(inout), target	data
	)

pure virtualinherited

Definition at line 55 of file generic_file.f90.

◆ set_counter()

procedure generic_file::generic_file_t::set_counter	(	class(generic_file_t), intent(inout)	this,
		integer, intent(in)	n
	)

inherited

Definition at line 61 of file generic_file.f90.

◆ set_header()

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

Parameters

hd Header.

Note: The header will be written "as is", meaning there will be no checks performed on the header separators, number of columns, etc.

Definition at line 54 of file csv_file.f90.

◆ set_overwrite() [1/2]

procedure csv_file::csv_file_t::set_overwrite	(	class(csv_file_t), intent(inout)	this,
		logical, intent(in)	overwrite
	)

Parameters

this	csv file.
overwrite	Overwrite flag.

Definition at line 56 of file csv_file.f90.

◆ set_overwrite() [2/2]

procedure generic_file::generic_file_t::set_overwrite	(	class(generic_file_t), intent(inout)	this,
		logical, intent(in)	overwrite
	)

inherited

Definition at line 73 of file generic_file.f90.

◆ set_start_counter()

procedure generic_file::generic_file_t::set_start_counter	(	class(generic_file_t), intent(inout)	this,
		integer, intent(in)	n
	)

inherited

Definition at line 65 of file generic_file.f90.

◆ write() [1/2]

procedure csv_file::csv_file_t::write	(	class (csv_file_t), intent(inout)	this,
		class(*), intent(in), target	data,
		real(kind=rp), intent(in), optional	t
	)

Parameters

this	csv file to write in.
data	Data to write, can be vector_t or matrix_t.
t	Time.

Definition at line 50 of file csv_file.f90.

◆ write() [2/2]

procedure(generic_file_write), deferred generic_file::generic_file_t::write	(	class(generic_file_t), intent(inout)	this,
		class(*), intent(in), target	data,
		real(kind=rp), intent(in), optional	t
	)

pure virtualinherited

Definition at line 53 of file generic_file.f90.

Member Data Documentation

◆ counter

integer, private generic_file::generic_file_t::counter = -1

privateinherited

Definition at line 44 of file generic_file.f90.

◆ fname

character(len=1024), private generic_file::generic_file_t::fname

privateinherited

Definition at line 43 of file generic_file.f90.

◆ header

character(len=1024) csv_file::csv_file_t::header = ""

Definition at line 46 of file csv_file.f90.

◆ header_is_written

logical csv_file::csv_file_t::header_is_written = .false.

Definition at line 47 of file csv_file.f90.

◆ overwrite

logical generic_file::generic_file_t::overwrite = .false.

inherited

Definition at line 48 of file generic_file.f90.

◆ serial

logical generic_file::generic_file_t::serial = .false.

inherited

Definition at line 47 of file generic_file.f90.

◆ start_counter

integer, private generic_file::generic_file_t::start_counter = 0

privateinherited

Definition at line 45 of file generic_file.f90.

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

/home/runner/work/neko/neko/src/io/csv_file.f90

Public Member Functions

Public Attributes

Private Attributes

Detailed Description

Member Function/Subroutine Documentation

◆ check_exists()

◆ count_lines()

◆ get_base_fname()

◆ get_counter()

◆ get_fname()

◆ get_start_counter()

◆ increment_counter()

◆ init()

◆ read() [1/2]

◆ read() [2/2]

◆ set_counter()

◆ set_header()

◆ set_overwrite() [1/2]

◆ set_overwrite() [2/2]

◆ set_start_counter()

◆ write() [1/2]

◆ write() [2/2]

Member Data Documentation

◆ counter

◆ fname

◆ header

◆ header_is_written

◆ overwrite

◆ serial

◆ start_counter