Public Types | Public Member Functions | Static Public Attributes | List of all members
pTraits< bool > Class Template Reference

Template specialisation for pTraits<bool> More...

Public Types

typedef bool cmptType
 Component type. More...
 
typedef bool magType
 Magnitude type. More...
 

Public Member Functions

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

Static Public Attributes

static constexpr direction dim = 3
 Dimensionality of space. More...
 
static constexpr direction rank = 0
 Rank of bool is 0. More...
 
static constexpr direction nComponents = 1
 Number of components in bool is 1. More...
 
static const char *const typeName = "bool"
 
static const char *const componentNames [] = { "" }
 
static const bool zero = false
 
static const bool one = true
 

Detailed Description

template<>
class Foam::pTraits< bool >

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 121 of file bool.H.

◆ pTraits() [2/2]

pTraits ( Istream &  is)
explicit

Read construct from Istream.

Definition at line 38 of file bool.C.

Member Function Documentation

◆ operator bool()

operator bool ( ) const
inlinenoexcept

Return the value.

Definition at line 137 of file bool.H.

◆ operator bool &()

operator bool & ( )
inlinenoexcept

Access the value.

Definition at line 142 of file bool.H.

Member Data Documentation

◆ dim

constexpr direction dim = 3
static

Dimensionality of space.

Definition at line 95 of file bool.H.

◆ rank

constexpr direction rank = 0
static

Rank of bool is 0.

Definition at line 100 of file bool.H.

◆ nComponents

constexpr direction nComponents = 1
static

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 111 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.

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