map_file::map_file_t Type Reference

Interface for NEKTON map files. More...

Inheritance diagram for map_file::map_file_t:

Collaboration diagram for map_file::map_file_t:

Public Member Functions
procedure	read (this, data)
	Load NEKTON map file.
procedure	write (this, data, t)
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
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 map_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.

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

read() [2/2]

procedure map_file::map_file_t::read	(	class(map_file_t)	this,
		class(*), intent(inout), target	data
	)

Definition at line 47 of file map_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_overwrite()

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

write() [2/2]

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

Definition at line 48 of file map_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.

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/map_file.f90