IO_setScalar.F90 File Reference

Go to the source code of this file.

Functions/Subroutines
subroutine	IO_setScalarReal (name, value)
subroutine	IO_setScalarInt (name, value)
subroutine	IO_setScalarStr (name, value)
subroutine	IO_setScalarLog (name, value)

Function/Subroutine Documentation

IO_setScalarInt()

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

Definition at line 74 of file IO_setScalar.F90.

IO_setScalarLog()

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

Definition at line 100 of file IO_setScalar.F90.

IO_setScalarReal()

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

Accessor routine that sets a scalar value to a scalar list which will then be checkpointed or written to a plotfile.

In FLASH3 what we mean by scalars are single value variables associated with an entire flash run. These scalars are in contrast to Grid scope variables which need to be stored at each zone of each block in the simulation. Density, pressure and temperature are examples of Grid scope variables while simTime, dt, globalNumBlocks are single quantities associated with the entire run.

Scalars of this type can be integers, reals, strings or logical values. An example of a string scalar might be the FLASH3 run comment, name of the logfile or setup line

IO_setScalar is typically called by each Unit's outputScalar (ie Driver_outputScalars, Grid_outputScalars) routines right before checkpointing or writing a plotfile. A user wishing to write a new scalar to a checkpoint file would need to call this routine

name: name value: name value

NOTES

Because IO_setScalar is an overloaded function a user calling the routine must USE the interface IO_interface.

(Under the hood, IO_setScalar calls IO_setScalarReal, IO_setScalarInt, IO_setScalarStr, or IO_setScalarLog and keeps a separate list for each type.)

EXAMPLE

To checkpoint the simulation time, Driver_sendOutputData does call IO_setScalar("time", dr_simTime)

Definition at line 60 of file IO_setScalar.F90.

IO_setScalarStr()

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

Definition at line 86 of file IO_setScalar.F90.