Neko  0.9.0
A portable framework for high-order spectral element flow simulations
output_controller Module Reference

Implements output_controller_t

Data Types

type  output_controller_t
 Centralized controller for a list of outputs. More...
 

Functions/Subroutines

subroutine output_controller_init (this, time_end, size)
 Constructor. More...
 
subroutine output_controller_free (this)
 Destructor. More...
 
subroutine output_controller_add (this, out, write_par, write_control)
 Add an output out to the controller. More...
 
subroutine output_controller_execute (this, t, tstep, ifforce)
 Query each of the controllers whether it is time to write, and if so, do so for the corresponding output. More...
 
subroutine output_controller_set_counter (this, t)
 Set write counter based on time (after restart) More...
 
subroutine output_controller_set_write_count (this, counter)
 Set write counter (after restart) explicitly. More...
 

Function/Subroutine Documentation

◆ output_controller_add()

subroutine output_controller::output_controller_add ( class(output_controller_t), intent(inout)  this,
class(output_t), intent(inout), target  out,
real(kind=rp), intent(in)  write_par,
character(len=*), intent(in)  write_control 
)
private
Parameters
outThe output to add.
write_parThe output frequency value, in accordance with write_control.
write_controlDetermines the meaning of write_par. Accepts the usual list of control options.

Definition at line 131 of file output_controller.f90.

◆ output_controller_execute()

subroutine output_controller::output_controller_execute ( class(output_controller_t), intent(inout)  this,
real(kind=rp), intent(in)  t,
integer, intent(in)  tstep,
logical, intent(in), optional  ifforce 
)
private
Parameters
tThe time value.
tstepThe current time-stepper iteration.
ifforceWhether to force a write. Optional, defaults to 0.

Definition at line 213 of file output_controller.f90.

Here is the call graph for this function:

◆ output_controller_free()

subroutine output_controller::output_controller_free ( class(output_controller_t), intent(inout)  this)
private

Definition at line 110 of file output_controller.f90.

◆ output_controller_init()

subroutine output_controller::output_controller_init ( class(output_controller_t), intent(inout)  this,
real(kind=rp), intent(in)  time_end,
integer, intent(in), optional  size 
)
Parameters
time_endThe end time of thesimulation.
sizeThe number of controllers to allocate for. Optional, defaults to 1.

Definition at line 81 of file output_controller.f90.

◆ output_controller_set_counter()

subroutine output_controller::output_controller_set_counter ( class(output_controller_t), intent(inout)  this,
real(kind=rp), intent(in)  t 
)
private
Parameters
tTime value.

Definition at line 293 of file output_controller.f90.

◆ output_controller_set_write_count()

subroutine output_controller::output_controller_set_write_count ( class(output_controller_t), intent(inout)  this,
integer, intent(in)  counter 
)
private
Parameters
counterThe value of the write coutner to be set.

Definition at line 313 of file output_controller.f90.