pTraits< bool > Class Reference

Template specialisation for pTraits<bool>. More...

#include <bool.H>

Inheritance diagram for pTraits< bool >:

Collaboration diagram for pTraits< bool >:

Public Types
typedef bool	cmptType
	Component type.
typedef bool	magType
	Magnitude type.

Public Member Functions
	pTraits (bool val) noexcept
	Copy construct from primitive.
	pTraits (Istream &is)
	Read construct from Istream.
	operator bool () const noexcept
	Return the value.
	operator bool & () noexcept
	Access the value.

Static Public Member Functions
static const bool &	null () noexcept
	Return reference to a (false) dummy value.

Static Public Attributes
static constexpr direction	dim = 3
	Dimensionality of space.
static constexpr direction	rank = 0
	Rank of bool is 0.
static constexpr direction	nComponents = 1
	Number of components in bool is 1.
static const char *const	typeName = "bool"
static const char *const	componentNames [] = { "" }
static const bool	zero = false
static const bool	one = true
static bool	dummy = false
	Dummy for return reference.

Detailed Description

Template specialisation for pTraits<bool>.

Definition at line 71 of file bool.H.

Member Typedef Documentation

cmptType

typedef bool cmptType

Component type.

Definition at line 82 of file bool.H.

magType

typedef bool magType

Magnitude type.

Definition at line 87 of file bool.H.

Constructor & Destructor Documentation

pTraits() [1/2]

pTraits ( bool val )

inlineexplicitnoexcept

Copy construct from primitive.

Definition at line 127 of file bool.H.

References Foam::noexcept, and pTraits().

Referenced by pTraits().

Here is the call graph for this function:

Here is the caller graph for this function:

pTraits() [2/2]

pTraits ( Istream & is )

explicit

Read construct from Istream.

Definition at line 48 of file bool.C.

Member Function Documentation

null()

const bool & null ( )

staticnoexcept

Return reference to a (false) dummy value.

Definition at line 39 of file bool.C.

References dummy, and Foam::noexcept.

operator bool()

operator bool ( ) const

inlinenoexcept

Return the value.

Definition at line 140 of file bool.H.

References Foam::noexcept.

operator bool &()

operator bool & ( )

inlinenoexcept

Access the value.

Definition at line 145 of file bool.H.

Member Data Documentation

dim

direction dim = 3

staticconstexpr

Dimensionality of space.

Definition at line 95 of file bool.H.

rank

direction rank = 0

staticconstexpr

Rank of bool is 0.

Definition at line 100 of file bool.H.

nComponents

direction nComponents = 1

staticconstexpr

Number of components in bool is 1.

Definition at line 105 of file bool.H.

typeName

const char *const typeName = "bool"

static

Definition at line 110 of file bool.H.

componentNames

const char *const componentNames = { "" }

static

Definition at line 30 of file bool.H.

zero

const bool zero = false

static

Definition at line 112 of file bool.H.

one

const bool one = true

static

Definition at line 113 of file bool.H.

dummy

bool dummy = false

static

Dummy for return reference.

Definition at line 114 of file bool.H.

Referenced by null().

---

The documentation for this class was generated from the following files:

• src/OpenFOAM/primitives/bools/bool/bool.H
• src/OpenFOAM/primitives/bools/bool/bool.C
• src/OpenFOAM/primitives/complex/complex.C