mean_field::mean_field_t Type Reference

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

Inheritance diagram for mean_field::mean_field_t:

Collaboration diagram for mean_field::mean_field_t:

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)	update_col3 (this, k, a, b)
	Updates the mean value with the product of two fields as the sample.
procedure, pass(this)	update_dot3 (this, k, a1, a2, a3, b1, b2, b3)
	Updates the mean value with the sum of three products as the 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. Only used by update. When the mean is updated with update_col3 or update_dot3, f only provides the dofmap at initialization, and update must not be called.
type(field_t), pointer	mf => null()
	Stores the mean field.
real(kind=rp)	time
	Total time across which the mean has been computed.

Detailed Description

Definition at line 47 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 60 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 58 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 68 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 62 of file mean_field.f90.

update_col3()

procedure, pass(this) mean_field::mean_field_t::update_col3	(	class(mean_field_t), intent(inout)	this,
		real(kind=rp), intent(in)	k,
		type(field_t), intent(in)	a,
		type(field_t), intent(in)	b
	)

Parameters

k	Time since last sample.
a	First factor of the sample.
b	Second factor of the sample.

Definition at line 64 of file mean_field.f90.

update_dot3()

procedure, pass(this) mean_field::mean_field_t::update_dot3	(	class(mean_field_t), intent(inout)	this,
		real(kind=rp), intent(in)	k,
		type(field_t), intent(in)	a1,
		type(field_t), intent(in)	a2,
		type(field_t), intent(in)	a3,
		type(field_t), intent(in)	b1,
		type(field_t), intent(in)	b2,
		type(field_t), intent(in)	b3
	)

Parameters

k	Time since last sample.
a1,a2,a3	First factors of the products.
b1,b2,b3	Second factors of the products.

Definition at line 66 of file mean_field.f90.

Member Data Documentation

f

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

Definition at line 51 of file mean_field.f90.

mf

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

Definition at line 53 of file mean_field.f90.

time

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

Definition at line 55 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