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 => fluid_stats_simcomp_init_from_json
	Constructor from json, wrapping the actual constructor. More...

procedure, pass(this)	init_from_attributes => fluid_stats_simcomp_init_from_attributes
	Actual constructor. More...

procedure, pass(this)	free => fluid_stats_simcomp_free
	Destructor. More...

procedure, pass(this)	compute_ => fluid_stats_simcomp_compute
	Does sampling for statistics. More...

procedure, pass(this)	output_ => fluid_stats_simcomp_compute
	Write the statistics to disk. More...

procedure, pass(this)	restart_ => fluid_stats_simcomp_restart
	Restart the simcomp. More...

procedure, pass(this)	init_base => simulation_component_init_base
	Constructor for the simulation_component_t (base) class. More...

procedure, pass(this)	free_base => simulation_component_free_base
	Destructor for the simulation_component_t (base) class. More...

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

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

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

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

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

type(fluid_stats_output_t)	stats_output
	Output writer. More...

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

real(kind=rp)	time

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

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

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

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

integer	order
	The execution order, lowest excutes first. More...

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 61 of file fluid_stats_simcomp.f90.

Member Function/Subroutine Documentation

◆ compute()

procedure, pass(this) simulation_component::simulation_component_t::compute

inherited

Definition at line 73 of file simulation_component.f90.

◆ compute_()

procedure, pass(this) fluid_stats_simcomp::fluid_stats_simcomp_t::compute_

Definition at line 78 of file fluid_stats_simcomp.f90.

◆ free()

procedure, pass(this) fluid_stats_simcomp::fluid_stats_simcomp_t::free

Definition at line 76 of file fluid_stats_simcomp.f90.

◆ free_base()

procedure, pass(this) simulation_component::simulation_component_t::free_base

inherited

Definition at line 63 of file simulation_component.f90.

◆ init()

procedure, pass(this) fluid_stats_simcomp::fluid_stats_simcomp_t::init

Definition at line 71 of file fluid_stats_simcomp.f90.

◆ init_base()

procedure, pass(this) simulation_component::simulation_component_t::init_base

inherited

Definition at line 61 of file simulation_component.f90.

◆ init_from_attributes()

procedure, pass(this) fluid_stats_simcomp::fluid_stats_simcomp_t::init_from_attributes

Definition at line 73 of file fluid_stats_simcomp.f90.

◆ output_()

procedure, pass(this) fluid_stats_simcomp::fluid_stats_simcomp_t::output_

Definition at line 80 of file fluid_stats_simcomp.f90.

◆ preprocess()

procedure, pass(this) simulation_component::simulation_component_t::preprocess

inherited

Definition at line 69 of file simulation_component.f90.

◆ preprocess_()

procedure, pass(this) simulation_component::simulation_component_t::preprocess_

inherited

Definition at line 79 of file simulation_component.f90.

◆ restart()

procedure, pass(this) simulation_component::simulation_component_t::restart

inherited

Definition at line 66 of file simulation_component.f90.

◆ restart_()

procedure, pass(this) fluid_stats_simcomp::fluid_stats_simcomp_t::restart_

Definition at line 82 of file fluid_stats_simcomp.f90.

Member Data Documentation

◆ case

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

inherited

Definition at line 50 of file simulation_component.f90.

◆ compute_controller

type(time_based_controller_t) simulation_component::simulation_component_t::compute_controller

inherited

Definition at line 54 of file simulation_component.f90.

◆ order

integer simulation_component::simulation_component_t::order

inherited

Definition at line 58 of file simulation_component.f90.

◆ output_controller

type(time_based_controller_t) simulation_component::simulation_component_t::output_controller

inherited

Definition at line 56 of file simulation_component.f90.

◆ preprocess_controller

type(time_based_controller_t) simulation_component::simulation_component_t::preprocess_controller

inherited

Definition at line 52 of file simulation_component.f90.

◆ start_time

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

Definition at line 67 of file fluid_stats_simcomp.f90.

◆ stats

type(fluid_stats_t) fluid_stats_simcomp::fluid_stats_simcomp_t::stats

Definition at line 63 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 65 of file fluid_stats_simcomp.f90.

◆ time

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

Definition at line 68 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_()

◆ free()

◆ free_base()

◆ init()

◆ init_base()

◆ init_from_attributes()

◆ output_()

◆ preprocess()

◆ preprocess_()

◆ restart()

◆ restart_()

Member Data Documentation

◆ case

◆ compute_controller

◆ order

◆ output_controller

◆ preprocess_controller

◆ start_time

◆ stats

◆ stats_output

◆ time