spatial_average_output::spatial_average_output_t Type Reference

Output for spatially averaged fields. More...

Inheritance diagram for spatial_average_output::spatial_average_output_t:

Collaboration diagram for spatial_average_output::spatial_average_output_t:

Public Member Functions
procedure, pass(this)	init (this, fields, coef, avg_direction, filename)
	Constructor.
procedure, pass(this)	free (this)
	Destructor.
procedure, pass(this)	sample (this, t)
	Sample the current fields, spatially average, and write.
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
	Pointers to the fields to average and write.
type(map_1d_t)	map_1d
	Space averaging object for 2 homogeneous directions.
type(map_2d_t)	map_2d
	Space averaging object for 1 homogeneous direction.
integer	output_dim = 0
	The dimension of the output fields. Either 1 or 2.
type(file_t)	file_

Detailed Description

Definition at line 53 of file spatial_average_output.f90.

Member Function/Subroutine Documentation

free() [1/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() [2/2]

procedure, pass(this) spatial_average_output::spatial_average_output_t::free

(

class(spatial_average_output_t), intent(inout)

this

)

Definition at line 66 of file spatial_average_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) spatial_average_output::spatial_average_output_t::init	(	class(spatial_average_output_t), intent(inout)	this,
		character(len=*), dimension(:), intent(in)	fields,
		type(coef_t), intent(inout), target	coef,
		character(len=*), intent(in)	avg_direction,
		character(len=*), intent(in)	filename
	)

Parameters

fields	Names of the fields to average.
coef	SEM coefficients.
avg_direction	Direction(s) to average in. Either 'x', 'y', 'z', 'xy', 'xz', or 'yz', matching the statistics output semantics.
filename	Base filename for the output file.

Definition at line 64 of file spatial_average_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(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.

sample() [2/2]

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

Parameters

t	The current time value.

Definition at line 68 of file spatial_average_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) spatial_average_output::spatial_average_output_t::fields

Definition at line 55 of file spatial_average_output.f90.

file_

type(file_t) output::output_t::file_

inherited

Definition at line 42 of file output.f90.

map_1d

type(map_1d_t) spatial_average_output::spatial_average_output_t::map_1d

Definition at line 57 of file spatial_average_output.f90.

map_2d

type(map_2d_t) spatial_average_output::spatial_average_output_t::map_2d

Definition at line 59 of file spatial_average_output.f90.

output_dim

integer spatial_average_output::spatial_average_output_t::output_dim = 0

Definition at line 61 of file spatial_average_output.f90.

---

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

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