Public Member Functions
subroutine, public	assertsetstopmode (doStop)
	Set the default assertion stop behaviour.
subroutine, public	assertsetmsgprefix (prefix)
	Set a prefix for the assertion fail message.
subroutine, public	assertreset ()
	Reset the assertion module to its default state.
subroutine, public	assertstoponfailed (failmsg, doStop)
	Stop if a previously called assertion failed (delayed stop).
subroutine, public	assert (test, failmsg, doStop)
	A generic assertion, tests a given logical expression.
subroutine, public	assertequal (x1, x2, failmsg, doStop)
	Test double precision floating point numbers for equality.

Detailed Description

Definition at line 1 of file itm_assert.f90.

Member Function/Subroutine Documentation

subroutine, public itm_assert::assert	(	logical, intent(in)	test,
		character(*), intent(in), optional	failmsg,
		logical, intent(in), optional	doStop
	)

A generic assertion, tests a given logical expression.

If it evaluates to .false., print the fail message and possibly stop execution.

Parameters

test	The logical expression to test.
failmsg	The message to print on fail. If omitted, a generic message is printed. Can be modified with a prefix (see assertSetMsgPrefix)
doStop	Controls whether to stop execution. If doStop .true., the program is stopped. If .false., only the fail message is printed and bookkeeping is done for delayed stopping (see assertStopOnFailed). If given, overrides the default behaviour set by assertSetStopMode.

Definition at line 161 of file itm_assert.f90.

subroutine, public itm_assert::assertequal	(	real(itm_r8), intent(in)	x1,
		real(itm_r8), intent(in)	x2,
		character(*), intent(in), optional	failmsg,
		logical, intent(in), optional	doStop
	)

Test double precision floating point numbers for equality.

Parameters

Definition at line 180 of file itm_assert.f90.

subroutine, public itm_assert::assertreset ( )

Reset the assertion module to its default state.

Reset stop mode and message prefix to their default values. Also resets the fail counter, i.e. any previous failed assertions are forgotton.

Definition at line 103 of file itm_assert.f90.

subroutine, public itm_assert::assertsetmsgprefix ( character(len=*), intent(in), optional prefix )

Set a prefix for the assertion fail message.

Parameters

prefix The prefix string for the fail messages. Optional. If omitted, clear the prefix string (i.e. no prefix is used anymore)

Definition at line 86 of file itm_assert.f90.

subroutine, public itm_assert::assertsetstopmode ( logical, intent(in), optional doStop )

Set the default assertion stop behaviour.

Parameters

doStop .true. means immediate stop on fail, .false. means don't stop on fail (for use with delayed stopping,

See Also: assertStopOnFailed). The default value is .true., it is set if doStop is omitted.

Definition at line 70 of file itm_assert.f90.

subroutine, public itm_assert::assertstoponfailed	(	character(*), intent(in), optional	failmsg,
		logical, intent(in), optional	doStop
	)

Stop if a previously called assertion failed (delayed stop).

This is useful if the default stop mode is set to continue on failed assertions (which can be enabled by call assertSetStopMode( .false. ).

Parameters

failmsg	Message to print if assertion(s) failed.
doStop	Controls stop behaviour,

Definition at line 120 of file itm_assert.f90.

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