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...
Public Member Functions | |
| procedure, pass(this) | init (this, json, case) |
| Constructor from json, wrapping the actual constructor. | |
| procedure, pass(this) | init_from_attributes (this, u, v, w, p, coef, start_time, hom_dir, stat_set) |
| Actual constructor. | |
| procedure, pass(this) | free (this) |
| Destructor. | |
| procedure, pass(this) | compute_ (this, t, tstep) |
| Does sampling for statistics. | |
| procedure, pass(this) | output_ (this, t, tstep) |
| Write the statistics to disk. | |
| procedure, pass(this) | restart_ (this, t) |
| Restart the simcomp. | |
| procedure, pass(this) | init_base (this, json, case) |
| Constructor for the simulation_component_t (base) class. | |
| procedure, pass(this) | free_base (this) |
| Destructor for the simulation_component_t (base) class. | |
| procedure, pass(this) | restart (this, t) |
Wrapper for calling set_counter for the time based controllers. Serves as the public interface. | |
| procedure, pass(this) | preprocess (this, t, tstep) |
Wrapper for calling preprocess_ based on the preprocess_controller. Serves as the public interface. | |
| procedure, pass(this) | compute (this, t, tstep) |
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, t, tstep) |
| The preprocessing function to be executed during the run. | |
| procedure, pass(this) | compute_ (this, t, tstep) |
| The main function to be executed during the run. | |
| procedure, pass(this) | restart_ (this, t) |
| The restart function to be called upon restarting simulation. | |
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 |
| 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 61 of file fluid_stats_simcomp.f90.
Member Function/Subroutine Documentation
◆ compute()
|
inherited |
- Parameters
-
t The time value. tstep The current time-step
Definition at line 73 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, |
| real(kind=rp), intent(in) | t, | ||
| integer, intent(in) | tstep | ||
| ) |
- Parameters
-
t The time value. tstep The current time-step
Definition at line 78 of file fluid_stats_simcomp.f90.
◆ compute_() [2/2]
|
inherited |
- Parameters
-
t The time value. tstep The current time-step
Definition at line 81 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 76 of file fluid_stats_simcomp.f90.
◆ free() [2/2]
|
pure virtualinherited |
Definition at line 77 of file simulation_component.f90.
◆ free_base()
|
inherited |
Definition at line 63 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) | 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 71 of file fluid_stats_simcomp.f90.
◆ init() [2/2]
|
pure virtualinherited |
Definition at line 75 of file simulation_component.f90.
◆ init_base()
|
inherited |
- Parameters
-
object The object to be created and initialized. json JSON object initializing the simulation component. case The simulation case. Constructor for the simulation_component_t(base) class.
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 | ( | class(fluid_stats_simcomp_t), intent(inout) | this, |
| type(field_t), intent(inout) | u, | ||
| type(field_t), intent(inout) | v, | ||
| type(field_t), intent(inout) | w, | ||
| type(field_t), intent(inout) | p, | ||
| type(coef_t), intent(in) | coef, | ||
| real(kind=rp), intent(in) | start_time, | ||
| character(len=*), intent(in) | hom_dir, | ||
| character(len=*), intent(in) | stat_set | ||
| ) |
- 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 73 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, |
| real(kind=rp), intent(in) | t, | ||
| integer, intent(in) | tstep | ||
| ) |
- Parameters
-
t The time value. tstep The current time-step
Definition at line 80 of file fluid_stats_simcomp.f90.
◆ preprocess()
|
inherited |
- Parameters
-
t The time value. tstep The current time-step
Definition at line 69 of file simulation_component.f90.
◆ preprocess_()
|
inherited |
- Parameters
-
t The time value. tstep The current time-step
Definition at line 79 of file simulation_component.f90.
◆ restart()
|
inherited |
- Parameters
-
t The time value.
Definition at line 66 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, |
| real(kind=rp), intent(in) | t | ||
| ) |
Definition at line 82 of file fluid_stats_simcomp.f90.
◆ restart_() [2/2]
|
inherited |
- Parameters
-
t The time value.
Definition at line 83 of file simulation_component.f90.
Member Data Documentation
◆ case
Definition at line 50 of file simulation_component.f90.
◆ compute_controller
|
inherited |
Definition at line 54 of file simulation_component.f90.
◆ order
|
inherited |
Definition at line 58 of file simulation_component.f90.
◆ output_controller
|
inherited |
Definition at line 56 of file simulation_component.f90.
◆ preprocess_controller
|
inherited |
Definition at line 52 of file simulation_component.f90.
◆ 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
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
