user_stats Module Reference

Implements the user_stats_t type.

Data Types
type	user_stats_t
	A simulation component that computes the averages of fields in the registry. More...

Functions/Subroutines
subroutine	user_stats_init_from_json (this, json, case)
	Constructor from json.
subroutine	user_stats_restart (this, time)
subroutine	user_stats_init_from_controllers (this, case, order, preprocess_controller, compute_controller, output_controller, start_time, coef, avg_dir, filename, precision)
	Constructor from components, passing controllers.
subroutine	user_stats_init_from_controllers_properties (this, case, order, preprocess_control, preprocess_value, compute_control, compute_value, output_control, output_value, start_time, coef, avg_dir, filename, precision)
	Constructor from components, passing properties to the time_based_controller` components in the base type.
subroutine	user_stats_init_common (this, start_time, coef, avg_dir, filename, precision)
	Common part of constructors.
subroutine	user_stats_free (this)
	Destructor.
subroutine	user_stats_compute (this, time)
	Update the running averages.

Function/Subroutine Documentation

user_stats_compute()

subroutine user_stats::user_stats_compute ( class(user_stats_t), intent(inout)  this, type(time_state_t), intent(in)  time  )

private

Parameters

time	The current time state.

Update the running average of the fields

Definition at line 253 of file user_stats.f90.

user_stats_free()

subroutine user_stats::user_stats_free ( class(user_stats_t), intent(inout)  this )

private

Definition at line 232 of file user_stats.f90.

user_stats_init_common()

subroutine user_stats::user_stats_init_common ( class(user_stats_t), intent(inout)  this, real(kind=rp), intent(in)  start_time, type(coef_t), intent(inout)  coef, character(len=*), intent(in)  avg_dir, character(len=*), intent(in)  filename, integer, intent(in), optional  precision  )

private

Parameters

start_time	The start time for gathering samples for the average.
coef	The SEM coefficients.
avg_dir	The averaging direction.

Allocate and initialize the mean fields

Definition at line 203 of file user_stats.f90.

Here is the caller graph for this function:

user_stats_init_from_controllers()

subroutine user_stats::user_stats_init_from_controllers ( class(user_stats_t), intent(inout)  this, class(case_t), intent(inout), target  case, integer  order, type(time_based_controller_t), intent(in)  preprocess_controller, type(time_based_controller_t), intent(in)  compute_controller, type(time_based_controller_t), intent(in)  output_controller, real(kind=rp), intent(in)  start_time, type(coef_t), intent(inout)  coef, character(len=*), intent(in)  avg_dir, character(len=*), intent(in), optional  filename, integer, intent(in), optional  precision  )

private

Parameters

case	The simulation case object.
order	The execution oder priority of the simcomp.
preprocess_controller	The controller for running preprocessing.
compute_controller	The controller for running compute.
output_controller	The controller for producing output.
start_time	The start time for gathering samples for the average.
coef	The SEM coefficients.
avg_dir	The averaging direction.
filename	The name of the file save the fields to. Optional, if not
precision	The real precision of the output data. Optional, defaults to single precision.

Definition at line 134 of file user_stats.f90.

user_stats_init_from_controllers_properties()

subroutine user_stats::user_stats_init_from_controllers_properties ( class(user_stats_t), intent(inout)  this, class(case_t), intent(inout), target  case, integer  order, character(len=*), intent(in)  preprocess_control, real(kind=rp), intent(in)  preprocess_value, character(len=*), intent(in)  compute_control, real(kind=rp), intent(in)  compute_value, character(len=*), intent(in)  output_control, real(kind=rp), intent(in)  output_value, real(kind=rp), intent(in)  start_time, type(coef_t), intent(inout)  coef, character(len=*), intent(in)  avg_dir, character(len=*), intent(in), optional  filename, integer, intent(in), optional  precision  )

private

Parameters

case	The simulation case object.
order	The execution oder priority of the simcomp.
preprocess_controller	Control mode for preprocessing.
preprocess_value	Value parameter for preprocessing.
compute_controller	Control mode for computing.
compute_value	Value parameter for computing.
output_controller	Control mode for output.
output_value	Value parameter for output.
start_time	The start time for gathering samples for the average.
coef	The SEM coefficients.
avg_dir	The averaging direction.
filename	The name of the file save the fields to. Optional, if not provided, fields are added to the main output file.
precision	The real precision of the output data. Optional, defaults to single precision.

Definition at line 172 of file user_stats.f90.

user_stats_init_from_json()

subroutine user_stats::user_stats_init_from_json	(	class(user_stats_t), intent(inout), target	this,
		type(json_file), intent(inout)	json,
		class(case_t), intent(inout), target	case
	)

Parameters

json	The json paramter dictionary.
case	The neko case object.

Get the number of stat fields and their names

Definition at line 95 of file user_stats.f90.

Here is the call graph for this function:

user_stats_restart()

subroutine user_stats::user_stats_restart ( class(user_stats_t), intent(inout)  this, type(time_state_t), intent(in)  time  )

private

Definition at line 115 of file user_stats.f90.