mean_field Module Reference

Implements mean_field_t.

Data Types
type	mean_field_t
	Computes the temporal mean of a field. More...

Functions/Subroutines
subroutine	mean_field_init (this, f, field_name)
	Constructor.
subroutine	mean_field_free (this)
	Destructor.
subroutine	mean_field_reset (this)
	Resets a the mean field and the averaging time value to zero.
subroutine	mean_field_update (this, k)
	Update the mean field with a new sample.
subroutine	mean_field_update_col3 (this, k, a, b)
	Update the mean field using the pointwise product \( a b \) as the sample, without the need for a work field holding the product.
subroutine	mean_field_update_dot3 (this, k, a1, a2, a3, b1, b2, b3)
	Update the mean field using \( a_1 b_1 + a_2 b_2 + a_3 b_3 \) as the sample, without the need for a work field holding the sum.

Function/Subroutine Documentation

mean_field_free()

subroutine mean_field::mean_field_free ( class(mean_field_t), intent(inout)  this )

private

Definition at line 100 of file mean_field.f90.

mean_field_init()

subroutine mean_field::mean_field_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 77 of file mean_field.f90.

mean_field_reset()

subroutine mean_field::mean_field_reset ( class(mean_field_t), intent(inout)  this )

private

Definition at line 114 of file mean_field.f90.

mean_field_update()

subroutine mean_field::mean_field_update ( class(mean_field_t), intent(inout)  this, real(kind=rp), intent(in)  k  )

private

Parameters

k	Time since last sample.

Definition at line 124 of file mean_field.f90.

Here is the call graph for this function:

mean_field_update_col3()

subroutine mean_field::mean_field_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  )

private

Parameters

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

Definition at line 140 of file mean_field.f90.

Here is the call graph for this function:

mean_field_update_dot3()

subroutine mean_field::mean_field_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  )

private

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 157 of file mean_field.f90.

Here is the call graph for this function: