mean_sqr_field::mean_sqr_field_t Type Reference

Inheritance diagram for mean_sqr_field::mean_sqr_field_t:

Collaboration diagram for mean_sqr_field::mean_sqr_field_t:

Public Member Functions
procedure, pass(this)	update (this, k)
	Update a mean sqr field.
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(stats_quant_update), deferred, pass	update (this, k)
procedure, pass(this)	reset (this)
	Resets the mean field.

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 44 of file mean_sqr_field.f90.

Member Function/Subroutine Documentation

free()

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

inherited

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  )

inherited

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 )

inherited

Definition at line 60 of file mean_field.f90.

update() [1/3]

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/3]

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

inherited

Parameters

k	Time since last sample.

Definition at line 58 of file mean_field.f90.

update() [3/3]

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

Parameters

[in]

k

Time since last sample

Definition at line 46 of file mean_sqr_field.f90.

Member Data Documentation

f

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

inherited

Definition at line 47 of file mean_field.f90.

mf

type(field_t) mean_field::mean_field_t::mf

inherited

Definition at line 49 of file mean_field.f90.

time

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

inherited

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_sqr_field.f90