Cardinal
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
NekTimeStepper Class Reference

Time stepper that reads time step information directly from nekRS. More...

#include <NekTimeStepper.h>

Inheritance diagram for NekTimeStepper:
[legend]

Public Member Functions

 NekTimeStepper (const InputParameters &parameters)
 
virtual Real minDT () const
 
virtual void setReferenceTime (const Real &L, const Real &U)
 
virtual Real nondimensionalDT (const Real &dimensional_dt) const
 

Static Public Member Functions

static InputParameters validParams ()
 

Protected Member Functions

virtual Real computeInitialDT () override
 
virtual Real computeDT () override
 

Protected Attributes

Real _min_dt
 Minimum allowable time step (dimensional) that MOOSE can set in NekRS. More...
 
Real _nek_dt
 
Real _t_ref
 Reference time scale. More...
 

Detailed Description

Time stepper that reads time step information directly from nekRS.

This time stepper performs the very simple action of reading stepping information from nekRS. This is necessary for the correct simulation time and time step size to be reflected through the Moose App running nekRS. This class will ignore any constantDT-type time stepping parameters set directly within the [Executioner] block, instead reading all stepping information (start time, end time, number of time steps, and time step size) directly from nekRS data structures. The only situation for which some control can be exerted from the MOOSE side is if Nek is run as a sub-application, in which case the simulation end time is controlled from the master application.

Constructor & Destructor Documentation

◆ NekTimeStepper()

NekTimeStepper::NekTimeStepper ( const InputParameters &  parameters)

Member Function Documentation

◆ computeDT()

virtual Real NekTimeStepper::computeDT ( )
overrideprotectedvirtual

◆ computeInitialDT()

virtual Real NekTimeStepper::computeInitialDT ( )
overrideprotectedvirtual

◆ minDT()

virtual Real NekTimeStepper::minDT ( ) const
virtual

◆ nondimensionalDT()

virtual Real NekTimeStepper::nondimensionalDT ( const Real &  dimensional_dt) const
virtual

Compute the nondimensional version of a dt

Parameters
[in]dimensional_dttime step in dimensional form
Returns
non-dimensional version of time step

◆ setReferenceTime()

virtual void NekTimeStepper::setReferenceTime ( const Real &  L,
const Real &  U 
)
virtual

Set the reference time scale that nekRS's nondimensional form is based on

Parameters
[in]Lcharacteristic length
[in]Ucharacteristic velocity

◆ validParams()

static InputParameters NekTimeStepper::validParams ( )
static

Member Data Documentation

◆ _min_dt

Real NekTimeStepper::_min_dt
protected

Minimum allowable time step (dimensional) that MOOSE can set in NekRS.

◆ _nek_dt

Real NekTimeStepper::_nek_dt
protected

The initial time step size in NekRS, in non-dimensional form. This does not reflect the time step as it changes adaptively.

◆ _t_ref

Real NekTimeStepper::_t_ref
protected

Reference time scale.


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