Scrambler  1
TimeStep Module Reference

Provide a set of functions and parameters for timestep and CFL management. More...

+ Collaboration diagram for TimeStep:

List of all members.

Public Member Functions

subroutine, public TimeStepInit ()
 Reads in parameters related to time step control.
subroutine, public GetFirstTimeStep
 Determines first time step from initial_maxspeed.
subroutine, public GetNextTimeStep (maxdt, lasttimestep)
 Gets the next time step up to maxdt.
REAL(KIND=qPrec) function, public RelaxTimeStep ()
 Use the CFL and the current timestep to calculate a new timestep.
subroutine, public TestBadCFL (lSuccess)
 Print an error message and kill the program if the CFL number is irreparably high.
subroutine, public PrintAdvance (n)
 Outputs on the master when the advance has been completed.

Public Attributes

REAL(KIND=qPREC), public maxcfl
REAL(KIND=qPREC), public overall_maxspeed
REAL(KIND=qPREC), public olddt

Private Attributes

REAL, parameter BAD_CFL_THRESHOLD = 1d3
REAL(KIND=qPrec), parameter MIN_TIMESTEP = 1.d-32
INTEGER, parameter MAX_CFL = 1
INTEGER, parameter TARGET_CFL = 2
INTEGER, parameter CFL_RELAXATION = 3

Detailed Description

Provide a set of functions and parameters for timestep and CFL management.

Definition at line 42 of file time_step.f90.


Member Function/Subroutine Documentation

subroutine, public TimeStepInit ( )

Reads in parameters related to time step control.

Definition at line 69 of file time_step.f90.

subroutine, public GetFirstTimeStep ( )

Determines first time step from initial_maxspeed.

Definition at line 88 of file time_step.f90.

subroutine, public GetNextTimeStep ( REAL(KIND=qPREC), optional  maxdt,
LOGICAL  lasttimestep 
)

Gets the next time step up to maxdt.

Parameters:
maxdt- maximum next time step
lasttimestep- logical flag set to true if next time step is maxdt

Definition at line 98 of file time_step.f90.

REAL(KIND=qPrec) function, public RelaxTimeStep ( )

Use the CFL and the current timestep to calculate a new timestep.

Definition at line 135 of file time_step.f90.

subroutine, public TestBadCFL ( LOGICAL  lSuccess)

Print an error message and kill the program if the CFL number is irreparably high.

Author:
20100629 by Brandon D. Shroyer

Definition at line 164 of file time_step.f90.

subroutine, public PrintAdvance ( INTEGER  n)

Outputs on the master when the advance has been completed.

Definition at line 216 of file time_step.f90.


Member Data Documentation

REAL(KIND=qPREC), public maxcfl

Definition at line 57 of file time_step.f90.

REAL, parameter BAD_CFL_THRESHOLD = 1d3 [private]

Definition at line 58 of file time_step.f90.

REAL(KIND=qPrec), parameter MIN_TIMESTEP = 1.d-32 [private]

Definition at line 59 of file time_step.f90.

REAL(KIND=qPREC), public overall_maxspeed

Definition at line 61 of file time_step.f90.

REAL(KIND=qPREC), public olddt

Definition at line 61 of file time_step.f90.

INTEGER, parameter MAX_CFL = 1 [private]

Definition at line 62 of file time_step.f90.

INTEGER, parameter TARGET_CFL = 2 [private]

Definition at line 63 of file time_step.f90.

INTEGER, parameter CFL_RELAXATION = 3 [private]

Definition at line 64 of file time_step.f90.


The documentation for this module was generated from the following file:
 All Classes Files Functions Variables