Computes the temporal mean of a field. More...

Inheritance diagram for mean_field::mean_field_t:

[legend]

Collaboration diagram for mean_field::mean_field_t:

[legend]

Public Member Functions
procedure, pass(this)	init (this, f, field_name)
	Constructor.

procedure, pass(this)	free (this)
	Destructor.

procedure, pass(this)	update (this, k)
	Updates the mean value with a new sample.

procedure, pass(this)	reset (this)
	Resets the mean field.

procedure(stats_quant_update), deferred, pass	update (this, k)

Public Attributes
type(field_t), pointer	f => null()
	Pointer to the averaged field.

type(field_t)	mf
	Stores the mean field.

real(kind=rp)	time
	Total time across which the mean has been computed.

Detailed Description

Definition at line 45 of file mean_field.f90.

Member Function/Subroutine Documentation

◆ free()

procedure, pass(this) mean_field::mean_field_t::free ( class(mean_field_t), intent(inout) this )

Definition at line 56 of file mean_field.f90.

◆ init()

procedure, pass(this) mean_field::mean_field_t::init	(	class(mean_field_t), intent(inout)	this,
		type(field_t), intent(in), target	f,
		character(len=*), intent(in), optional	field_name
	)

Parameters

f	The field that will be averaged.
field_name.	Optional name for the mean field. By default the name of `f` prepended with `mean_` is used.

Definition at line 54 of file mean_field.f90.

◆ reset()

procedure, pass(this) mean_field::mean_field_t::reset ( class(mean_field_t), intent(inout) this )

Definition at line 60 of file mean_field.f90.

◆ update() [1/2]

procedure(stats_quant_update), deferred, pass stats_quant::stats_quant_t::update	(	class(stats_quant_t), intent(inout)	this,
		real(kind=rp), intent(in)	k
	)

pure virtualinherited

Definition at line 42 of file stats_quant.f90.

◆ update() [2/2]

procedure, pass(this) mean_field::mean_field_t::update	(	class(mean_field_t), intent(inout)	this,
		real(kind=rp), intent(in)	k
	)

Parameters

k	Time since last sample.

Definition at line 58 of file mean_field.f90.

Member Data Documentation

◆ f

type(field_t), pointer mean_field::mean_field_t::f => null()

Definition at line 47 of file mean_field.f90.

◆ mf

type(field_t) mean_field::mean_field_t::mf

Definition at line 49 of file mean_field.f90.

◆ time

real(kind=rp) mean_field::mean_field_t::time

Definition at line 51 of file mean_field.f90.

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

/home/runner/work/neko/neko/src/field/mean_field.f90

Public Member Functions

Public Attributes