A simulation component that computes the velocity and pressure statistics up to 4th order. Can be used to reconstruct the term budget of transport equations for, e.g. the Reynolds stresses and the turbulent kinetic energy. More...

Inheritance diagram for fluid_stats_simcomp::fluid_stats_simcomp_t:

[legend]

Collaboration diagram for fluid_stats_simcomp::fluid_stats_simcomp_t:

[legend]

Public Member Functions
procedure, pass(this)	init (this, json, case)
	Constructor from json, wrapping the actual constructor.

procedure, pass(this)	init_from_components (this, u, v, w, p, coef, start_time, hom_dir, stat_set, fname)
	Actual constructor.

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

procedure, pass(this)	compute_ (this, time)
	Does sampling for statistics.

procedure, pass(this)	output_ (this, time)
	Write the statistics to disk.

procedure, pass(this)	restart_ (this, time)
	Restart the simcomp.

procedure, pass(this)	init_base (this, json, case)
	Constructor for the simulation_component_t (base) class.

generic	init_base_from_components (this, case, order, preprocess_control, preprocess_value, compute_control, compute_value, output_control, output_value)
	Constructor for the simulation_component_t (base) class from components.

generic	init_base_from_components (this, case, order, preprocess_controller, compute_controller, output_controller)
	Constructor for the simulation_component_t (base) class from components.

procedure, pass(this)	init_base_from_controllers (this, case, order, preprocess_controller, compute_controller, output_controller)
	Constructor for the simulation_component_t (base) class from time_based_controllers, essentially directly from all components (we reserve the `_from_components` name for the generic binding).

procedure, pass(this)	init_base_from_controllers_properties (this, case, order, preprocess_control, preprocess_value, compute_control, compute_value, output_control, output_value)
	Constructor for the simulation_component_t (base) class from properties of time_based_controllers, so the latter are constructed instead of assigned.

procedure, pass(this)	free_base (this)
	Destructor for the simulation_component_t (base) class.

procedure, pass(this)	restart (this, time)
	Wrapper for calling `set_counter` for the time based controllers. Serves as the public interface.

procedure, pass(this)	preprocess (this, time)
	Wrapper for calling `preprocess_` based on the `preprocess_controller`. Serves as the public interface.

procedure, pass(this)	compute (this, time)
	Wrapper for calling `compute_` based on the `compute_controller`. Serves as the public interface.

procedure(simulation_component_init), deferred, pass	init (this, json, case)
	The common constructor using a JSON dictionary.

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

procedure, pass(this)	preprocess_ (this, time)
	The preprocessing function to be executed during the run.

procedure, pass(this)	compute_ (this, time)
	The main function to be executed during the run.

procedure, pass(this)	restart_ (this, time)
	The restart function to be called upon restarting simulation.

procedure, pass(this)	parse_json (this, json, case_params, preprocess_control, preprocess_value, compute_control, compute_value, output_control, output_value)
	JSON parameter parser for the time-based controllers.

Public Attributes
type(fluid_stats_t)	stats
	Backbone object computing the satistics.

type(fluid_stats_output_t)	stats_output
	Output writer.

real(kind=rp)	start_time
	Time value at which the sampling of statistics is initiated.

real(kind=rp)	time

logical	default_fname = .true.

type(case_t), pointer	case
	Pointer to the simulation case.

type(time_based_controller_t)	preprocess_controller
	Controller for when to run `preprocess`.

type(time_based_controller_t)	compute_controller
	Controller for when to run `compute`.

type(time_based_controller_t)	output_controller
	Controller for when to do output.

integer	order
	The execution order, lowest excutes first.

Detailed Description

Similar in functionality to the satistics module in the KTH Framework for Nek5000: https://github.com/KTH-Nek5000/KTH_Framework See Turbulence Statistics in a Spectral-Element Code: A Toolbox for High-Fidelity Simulations or the origin KTH Nek5000 framework for details.

For further details see the Neko documentation.

Definition at line 64 of file fluid_stats_simcomp.f90.

Member Function/Subroutine Documentation

◆ compute()

procedure, pass(this) simulation_component::simulation_component_t::compute	(	class(simulation_component_t), intent(inout)	this,
		type(time_state_t), intent(in)	time
	)

inherited

Parameters

time	The current time.

Definition at line 88 of file simulation_component.f90.

◆ compute_() [1/2]

procedure, pass(this) fluid_stats_simcomp::fluid_stats_simcomp_t::compute_	(	class(fluid_stats_simcomp_t), intent(inout)	this,
		type(time_state_t), intent(in)	time
	)

Parameters

t	The time value.
tstep	The current time-step

Definition at line 83 of file fluid_stats_simcomp.f90.

◆ compute_() [2/2]

procedure, pass(this) simulation_component::simulation_component_t::compute_	(	class(simulation_component_t), intent(inout)	this,
		type(time_state_t), intent(in)	time
	)

inherited

Parameters

time	The current time.

Definition at line 96 of file simulation_component.f90.

◆ free() [1/2]

procedure, pass(this) fluid_stats_simcomp::fluid_stats_simcomp_t::free ( class(fluid_stats_simcomp_t), intent(inout) this )

Definition at line 81 of file fluid_stats_simcomp.f90.

◆ free() [2/2]

procedure(simulation_component_free), deferred, pass simulation_component::simulation_component_t::free ( class(simulation_component_t), intent(inout) this )

pure virtualinherited

Definition at line 92 of file simulation_component.f90.

◆ free_base()

procedure, pass(this) simulation_component::simulation_component_t::free_base ( class(simulation_component_t), intent(inout) this )

inherited

Definition at line 78 of file simulation_component.f90.

◆ init() [1/2]

procedure, pass(this) fluid_stats_simcomp::fluid_stats_simcomp_t::init	(	class(fluid_stats_simcomp_t), intent(inout), target	this,
		type(json_file), intent(inout)	json,
		class(case_t), intent(inout), target	case
	)

Parameters

json	JSON object with the parameters.
case	The case object.

Definition at line 76 of file fluid_stats_simcomp.f90.

◆ init() [2/2]

procedure(simulation_component_init), deferred, pass simulation_component::simulation_component_t::init	(	class(simulation_component_t), intent(inout), target	this,
		type(json_file), intent(inout)	json,
		class(case_t), intent(inout), target	case
	)

pure virtualinherited

Definition at line 90 of file simulation_component.f90.

◆ init_base()

procedure, pass(this) simulation_component::simulation_component_t::init_base	(	class(simulation_component_t), intent(inout)	this,
		type(json_file), intent(inout)	json,
		class(case_t), intent(inout), target	case
	)

inherited

Definition at line 62 of file simulation_component.f90.

◆ init_base_from_components() [1/2]

generic simulation_component::simulation_component_t::init_base_from_components	(	class(simulation_component_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
	)

inherited

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.

Definition at line 64 of file simulation_component.f90.

◆ init_base_from_components() [2/2]

generic simulation_component::simulation_component_t::init_base_from_components	(	class(simulation_component_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
	)

inherited

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.

Definition at line 64 of file simulation_component.f90.

◆ init_base_from_controllers()

procedure, pass(this) simulation_component::simulation_component_t::init_base_from_controllers	(	class(simulation_component_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
	)

inherited

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.

Definition at line 70 of file simulation_component.f90.

◆ init_base_from_controllers_properties()

procedure, pass(this) simulation_component::simulation_component_t::init_base_from_controllers_properties	(	class(simulation_component_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
	)

inherited

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.

Definition at line 75 of file simulation_component.f90.

◆ init_from_components()

procedure, pass(this) fluid_stats_simcomp::fluid_stats_simcomp_t::init_from_components	(	class(fluid_stats_simcomp_t), intent(inout), target	this,
		type(field_t), intent(in), target	u,
		type(field_t), intent(in), target	v,
		type(field_t), intent(in), target	w,
		type(field_t), intent(in), target	p,
		type(coef_t), intent(in), target	coef,
		real(kind=rp), intent(in)	start_time,
		character(len=*), intent(in)	hom_dir,
		character(len=*), intent(in)	stat_set,
		character(len=*), intent(in), optional	fname
	)

Parameters

u	x-velocity
v	x-velocity
w	x-velocity
coef	sem coefs
start_time	time to start sampling stats
hom_dir	directions to average in
stat_set	Set of statistics to compute (basic/full)

Definition at line 78 of file fluid_stats_simcomp.f90.

◆ output_()

procedure, pass(this) fluid_stats_simcomp::fluid_stats_simcomp_t::output_	(	class(fluid_stats_simcomp_t), intent(inout)	this,
		type(time_state_t), intent(in)	time
	)

Parameters

t	The time value.
tstep	The current time-step

Definition at line 85 of file fluid_stats_simcomp.f90.

◆ parse_json()

procedure, pass(this) simulation_component::simulation_component_t::parse_json	(	class(simulation_component_t), intent(inout)	this,
		type(json_file), intent(inout)	json,
		type(json_file), intent(inout)	case_params,
		character(len=:), intent(inout), allocatable	preprocess_control,
		real(kind=rp), intent(out)	preprocess_value,
		character(len=:), intent(inout), allocatable	compute_control,
		real(kind=rp), intent(out)	compute_value,
		character(len=:), intent(inout), allocatable	output_control,
		real(kind=rp), intent(out)	output_value
	)

inherited

Parameters

json	The JSON dictionary of the simcomp.
case_params	The entire case configuration JSON.
preprocess_value	Control mode for preprocessing.
preprocess_controller	Value parameter for preprocessing.
compute_controller	Control mode for computing.
compute_controller	Value parameter for computing.
output_controller	Control mode for output.
output_controller	Value parameter for output.

Definition at line 100 of file simulation_component.f90.

◆ preprocess()

procedure, pass(this) simulation_component::simulation_component_t::preprocess	(	class(simulation_component_t), intent(inout)	this,
		type(time_state_t), intent(in)	time
	)

inherited

Parameters

time	The current time.

Definition at line 84 of file simulation_component.f90.

◆ preprocess_()

procedure, pass(this) simulation_component::simulation_component_t::preprocess_	(	class(simulation_component_t), intent(inout)	this,
		type(time_state_t), intent(in)	time
	)

inherited

Parameters

time	The current time.

Definition at line 94 of file simulation_component.f90.

◆ restart()

procedure, pass(this) simulation_component::simulation_component_t::restart	(	class(simulation_component_t), intent(inout)	this,
		type(time_state_t), intent(in)	time
	)

inherited

Parameters

time	The current time.

Definition at line 81 of file simulation_component.f90.

◆ restart_() [1/2]

procedure, pass(this) fluid_stats_simcomp::fluid_stats_simcomp_t::restart_	(	class(fluid_stats_simcomp_t), intent(inout)	this,
		type(time_state_t), intent(in)	time
	)

Definition at line 87 of file fluid_stats_simcomp.f90.

◆ restart_() [2/2]

procedure, pass(this) simulation_component::simulation_component_t::restart_	(	class(simulation_component_t), intent(inout)	this,
		type(time_state_t), intent(in)	time
	)

inherited

Parameters

time	The current time.

Definition at line 98 of file simulation_component.f90.

Member Data Documentation

◆ case

type(case_t), pointer simulation_component::simulation_component_t::case

inherited

Definition at line 51 of file simulation_component.f90.

◆ compute_controller

type(time_based_controller_t) simulation_component::simulation_component_t::compute_controller

inherited

Definition at line 55 of file simulation_component.f90.

◆ default_fname

logical fluid_stats_simcomp::fluid_stats_simcomp_t::default_fname = .true.

Definition at line 72 of file fluid_stats_simcomp.f90.

◆ order

integer simulation_component::simulation_component_t::order

inherited

Definition at line 59 of file simulation_component.f90.

◆ output_controller

type(time_based_controller_t) simulation_component::simulation_component_t::output_controller

inherited

Definition at line 57 of file simulation_component.f90.

◆ preprocess_controller

type(time_based_controller_t) simulation_component::simulation_component_t::preprocess_controller

inherited

Definition at line 53 of file simulation_component.f90.

◆ start_time

real(kind=rp) fluid_stats_simcomp::fluid_stats_simcomp_t::start_time

Definition at line 70 of file fluid_stats_simcomp.f90.

◆ stats

type(fluid_stats_t) fluid_stats_simcomp::fluid_stats_simcomp_t::stats

Definition at line 66 of file fluid_stats_simcomp.f90.

◆ stats_output

type(fluid_stats_output_t) fluid_stats_simcomp::fluid_stats_simcomp_t::stats_output

Definition at line 68 of file fluid_stats_simcomp.f90.

◆ time

real(kind=rp) fluid_stats_simcomp::fluid_stats_simcomp_t::time

Definition at line 71 of file fluid_stats_simcomp.f90.

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

/home/runner/work/neko/neko/src/simulation_components/fluid_stats_simcomp.f90

Public Member Functions

Public Attributes

Detailed Description

Member Function/Subroutine Documentation

◆ compute()

◆ compute_() [1/2]

◆ compute_() [2/2]

◆ free() [1/2]

◆ free() [2/2]

◆ free_base()

◆ init() [1/2]

◆ init() [2/2]

◆ init_base()

◆ init_base_from_components() [1/2]

◆ init_base_from_components() [2/2]

◆ init_base_from_controllers()

◆ init_base_from_controllers_properties()

◆ init_from_components()

◆ output_()

◆ parse_json()

◆ preprocess()

◆ preprocess_()

◆ restart()

◆ restart_() [1/2]

◆ restart_() [2/2]

Member Data Documentation

◆ case

◆ compute_controller

◆ default_fname

◆ order

◆ output_controller

◆ preprocess_controller

◆ start_time

◆ stats

◆ stats_output

◆ time