FLASH-X
Doxygen Generated Documentation From Interface Source Code
Functions/Subroutines
RuntimeParameters_setPrev.F90 File Reference

Go to the source code of this file.

Functions/Subroutines

subroutine RuntimeParameters_setPrevReal (name, value)
 
subroutine RuntimeParameters_setPrevInt (name, value)
 
subroutine RuntimeParameters_setPrevStr (name, value)
 
subroutine RuntimeParameters_setPrevLog (name, value)
 

Function/Subroutine Documentation

◆ RuntimeParameters_setPrevInt()

subroutine RuntimeParameters_setPrevInt ( character(len=*), intent(in)  name,
integer, intent(in)  value 
)

Definition at line 69 of file RuntimeParameters_setPrev.F90.

◆ RuntimeParameters_setPrevLog()

subroutine RuntimeParameters_setPrevLog ( character(len=*), intent(in)  name,
logical, intent(in)  value 
)

Definition at line 82 of file RuntimeParameters_setPrev.F90.

◆ RuntimeParameters_setPrevReal()

subroutine RuntimeParameters_setPrevReal ( character(len=*), intent(in)  name,
real, intent(in)  value 
)

This is an overloaded function. RuntimeParameters_setPrev under the hood implements RuntimeParameters_setPrevReal RuntimeParameters_setPrevInt, RuntimeParameters_setPrevStr RuntimeParameters_setPrevLog

This routine allows the user to keep track of a value from a restart run. The linked List holding the runtime parameters can hold 2 values, a current value, and an "initial" or "previous" value. The routine sets the value of the latter.

EXAMPLE

Take a run using Paramesh with a refinement level of 4. The user runs the simulation for some time then writes a checkpoint. After examining the checkpoint data the user wants to increase the maximum resolution in the simulation and sets the refinement level to 6. Upon restart the grid may need to compare the values 4 and 6 and refine the grid further. The value '4' would be read in from the checkpoint file and stored in the 'previous', while the value '6' would be stored in the 'current' slot. We imagine there are only a few runtime parameters in which this routine would be relevant.

use RuntimeParameters, ONLY : RuntimeParameters_set

integer :: lrefine_max

lrefine_max = 4 call RuntimeParameters_setPrev('lrefine_max', lrefine_max)

name: name value: name value

NOTES

Because RuntimeParameters_setPrev is an overloaded function, a user calling the routine must USE the interface RuntimeParameters_interface.

Definition at line 62 of file RuntimeParameters_setPrev.F90.

◆ RuntimeParameters_setPrevStr()

subroutine RuntimeParameters_setPrevStr ( character(len=*), intent(in)  name,
character(len=*), intent(in)  value 
)

Definition at line 76 of file RuntimeParameters_setPrev.F90.