Foam::bounds Namespace Reference

Namespace for bounding specifications. At the moment, mostly for tables. More...

Enumerations
enum class	normalBounding { ERROR , WARN , CLAMP }
	Enumeration for handling out-of-bound values. More...
enum class	repeatableBounding { ERROR , WARN , CLAMP , REPEAT }
	Enumeration for handling out-of-bound values that are repeatable. More...

Variables
const Foam::Enum< normalBounding >	normalBoundingNames
	Strings corresponding to the normalBounding.
const Foam::Enum< repeatableBounding >	repeatableBoundingNames
	Strings corresponding to the repeatableBounding.

Detailed Description

Namespace for bounding specifications. At the moment, mostly for tables.

Source files

• tableBounds.H
• tableBounds.cxx

Enumeration Type Documentation

normalBounding

enum class normalBounding

strong

Enumeration for handling out-of-bound values.

Enumerator
ERROR	Exit with a FatalError.
WARN	Issue warning and clamp value (this is a good default).
CLAMP	Clamp value to the start/end value.

Definition at line 51 of file tableBounds.H.

repeatableBounding

enum class repeatableBounding

strong

Enumeration for handling out-of-bound values that are repeatable.

Enumerator
ERROR	Exit with a FatalError.
WARN	Issue warning and clamp value (this is a good default).
CLAMP	Clamp value to the start/end value.
REPEAT	Treat as a repeating list.

Definition at line 61 of file tableBounds.H.

Variable Documentation

normalBoundingNames

const Foam::Enum<normalBounding> normalBoundingNames

extern

Strings corresponding to the normalBounding.

Referenced by interpolation2DTable< Type >::write().

repeatableBoundingNames

const Foam::Enum<repeatableBounding> repeatableBoundingNames

extern

Strings corresponding to the repeatableBounding.

Referenced by interpolationTable< Type >::write(), and TableBase< Type >::writeEntries().