field_output::field_output_t Type Reference

A simple output saving a list of fields to a file. More...

Inheritance diagram for field_output::field_output_t:

Collaboration diagram for field_output::field_output_t:

Public Member Functions
procedure, pass(this)	init (this, name, nfields, precision, path, format)
	Constructor.
procedure, pass(this)	free (this)
	Destructor.
procedure, pass(this)	sample (this, t)
	Writes the data.
procedure, pass(this)	init_base (this, fname, precision, layout, overwrite)
	Output constructor.
procedure, pass(this)	free_base (this)
	Free the output.
procedure, pass(this)	set_counter (this, n)
	Update the output's file counter.
procedure, pass(this)	set_start_counter (this, n)
	Update the start of output's file counter.
procedure(output_sample), deferred, pass	sample (this, t)
procedure(output_free), deferred, pass	free (this)

Public Attributes
type(field_list_t)	fields
	The list of fields to save.
type(file_t)	file_

Detailed Description

Definition at line 44 of file field_output.f90.

Member Function/Subroutine Documentation

free() [1/2]

procedure, pass(this) field_output::field_output_t::free

(

class(field_output_t), intent(inout)

this

)

Definition at line 51 of file field_output.f90.

free() [2/2]

procedure(output_free), deferred, pass output::output_t::free ( class(output_t), intent(inout)  this )

pure virtualinherited

Definition at line 49 of file output.f90.

free_base()

procedure, pass(this) output::output_t::free_base ( class(output_t), intent(inout)  this )

inherited

Definition at line 45 of file output.f90.

init()

procedure, pass(this) field_output::field_output_t::init	(	class(field_output_t), intent(inout)	this,
		character(len=*), intent(in)	name,
		integer, intent(in)	nfields,
		integer, intent(in), optional	precision,
		character(len=*), intent(in), optional	path,
		character(len=*), intent(in), optional	format
	)

Parameters

name	The base name of the files.
nfields	The number of field pointers to preallocate in the field list.
precision	the precision of the reals in the file.
path	Optional path to the write folder.
format	Optional suffix for the file name.

Definition at line 49 of file field_output.f90.

init_base()

procedure, pass(this) output::output_t::init_base ( class(output_t), intent(inout)  this, character(len=*), intent(inout)  fname, integer, intent(in), optional  precision, integer, intent(in), optional  layout, logical, intent(in), optional  overwrite  )

inherited

Parameters

fname	Name of the output file.
precision	Output precision (sp or dp).

Definition at line 44 of file output.f90.

sample() [1/2]

procedure, pass(this) field_output::field_output_t::sample	(	class(field_output_t), intent(inout)	this,
		real(kind=rp), intent(in)	t
	)

Parameters

t	The time value.

Definition at line 53 of file field_output.f90.

sample() [2/2]

procedure(output_sample), deferred, pass output::output_t::sample ( class(output_t), intent(inout)  this, real(kind=rp), intent(in)  t  )

pure virtualinherited

Definition at line 48 of file output.f90.

set_counter()

procedure, pass(this) output::output_t::set_counter ( class(output_t), intent(inout)  this, integer, intent(in)  n  )

inherited

Definition at line 46 of file output.f90.

set_start_counter()

procedure, pass(this) output::output_t::set_start_counter ( class(output_t), intent(inout)  this, integer, intent(in)  n  )

inherited

Definition at line 47 of file output.f90.

Member Data Documentation

fields

type(field_list_t) field_output::field_output_t::fields

Definition at line 46 of file field_output.f90.

file_

type(file_t) output::output_t::file_

inherited

Definition at line 42 of file output.f90.

---

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

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