Foam::bounds Namespace Reference

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

Enumerations
enum	normalBounding { ERROR, WARN, CLAMP }
	Enumeration for handling out-of-bound values. More...
enum	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. More...
const Foam::Enum< repeatableBounding >	repeatableBoundingNames
	Strings corresponding to the repeatableBounding. More...

Detailed Description

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

Source files

• tableBounds.H
• tableBounds.C

Enumeration Type Documentation

normalBounding

enum 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 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< Foam::bounds::normalBounding > normalBoundingNames

Strings corresponding to the normalBounding.

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

repeatableBoundingNames

const Foam::Enum< Foam::bounds::repeatableBounding > repeatableBoundingNames

Strings corresponding to the repeatableBounding.

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