AMReX_BLassert.H File Reference

Assertion macros used across AMReX for runtime consistency checks. More...

#include <AMReX_Config.H>
#include <AMReX.H>

Go to the source code of this file.

Macros
#define	AMREX_ASSERT_WITH_MESSAGE(EX, MSG)
#define	AMREX_ASSERT(EX)
#define	BL_ASSERT(EX)
#define	AMREX_ALWAYS_ASSERT_WITH_MESSAGE(EX, MSG)
#define	AMREX_ALWAYS_ASSERT(EX)
#define	AMREX_GPU_ASSERT(EX)

Detailed Description

Assertion macros used across AMReX for runtime consistency checks.

In debug builds (or when AMREX_USE_ASSERTION is defined) the macros expand to runtime checks that call amrex::Assert if they fail. In release builds without assertion support, the non-*_ALWAYS variants become no-ops.

• AMREX_ASSERT(expr) evaluates expr and aborts on failure, emitting the expression, file, and line number.
• AMREX_ASSERT_WITH_MESSAGE(expr,msg) behaves the same but also forwards the user-provided msg to amrex::Assert, allowing custom diagnostics.
• The _ALWAYS_ variants (AMREX_ALWAYS_ASSERT, etc.) remain active even in non-debug builds.
• AMREX_GPU_ASSERT provides the same semantics inside GPU code paths when AMREX_USE_GPU is defined and either AMREX_DEBUG or AMREX_USE_ASSERTION is enabled; otherwise it is a no-op.

Macro Definition Documentation

AMREX_ALWAYS_ASSERT

#define AMREX_ALWAYS_ASSERT

(

EX

)

Value:

(EX)?((void)0):amrex::Assert( # EX , __FILE__, __LINE__)

AMREX_ALWAYS_ASSERT_WITH_MESSAGE

#define AMREX_ALWAYS_ASSERT_WITH_MESSAGE	(		EX,
			MSG )

Value:

(EX)?((void)0):amrex::Assert( # EX , __FILE__, __LINE__ , MSG)

AMREX_ASSERT

#define AMREX_ASSERT

(

EX

)

Value:

((void)0)

AMREX_ASSERT_WITH_MESSAGE

#define AMREX_ASSERT_WITH_MESSAGE	(		EX,
			MSG )

Value:

((void)0)

AMREX_GPU_ASSERT

#define AMREX_GPU_ASSERT

(

EX

)

Value:

((void)0)

BL_ASSERT

#define BL_ASSERT

(

EX

)

Value:

((void)0)