Loading...
Searching...
No Matches
pTraits< Scalar > Class Reference

#include <scalarImpl.H>

Inheritance diagram for pTraits< Scalar >:
Inheritance graph
[legend]
Collaboration diagram for pTraits< Scalar >:
Collaboration graph
[legend]

Public Types

typedef Scalar cmptType
 Component type.
typedef Scalar magType
 Magnitude type.
typedef label labelType
 Equivalent type of labels used for valid component indexing.

Public Member Functions

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

Static Public Attributes

static constexpr direction dim = 3
 Dimensionality of space.
static constexpr direction rank = 0
 Rank of Scalar is 0.
static constexpr direction nComponents = 1
 Number of components in Scalar is 1.
static constexpr Scalar min_ = -ScalarVGREAT
static constexpr Scalar max_ = ScalarVGREAT
static constexpr Scalar vsmall_ = ScalarVSMALL
static const char *const typeName
static const char *const componentNames []
static const Scalar zero
static const Scalar one
static const Scalar max
static const Scalar min
static const Scalar rootMax
static const Scalar rootMin
static const Scalar vsmall

Detailed Description

Definition at line 69 of file scalarImpl.H.

Member Typedef Documentation

◆ cmptType

typedef Scalar cmptType

Component type.

Definition at line 80 of file scalarImpl.H.

◆ magType

typedef Scalar magType

Magnitude type.

Definition at line 85 of file scalarImpl.H.

◆ labelType

typedef label labelType

Equivalent type of labels used for valid component indexing.

Definition at line 90 of file scalarImpl.H.

Constructor & Destructor Documentation

◆ pTraits() [1/2]

pTraits ( Scalar val)
inlineexplicitnoexcept

Copy construct from primitive.

Definition at line 136 of file scalarImpl.H.

References Foam::noexcept, and Scalar.

◆ pTraits() [2/2]

pTraits ( Istream & is)
explicit

Read construct from Istream (uses tokenizer).

Member Function Documentation

◆ operator Scalar()

operator Scalar ( ) const
inlinenoexcept

Return the value.

Definition at line 149 of file scalarImpl.H.

References Foam::noexcept.

◆ operator Scalar &()

operator Scalar & ( )
inlinenoexcept

Access the value.

Definition at line 154 of file scalarImpl.H.

References Scalar.

Member Data Documentation

◆ dim

direction dim = 3
staticconstexpr

Dimensionality of space.

Definition at line 98 of file scalarImpl.H.

◆ rank

direction rank = 0
staticconstexpr

Rank of Scalar is 0.

Definition at line 103 of file scalarImpl.H.

◆ nComponents

direction nComponents = 1
staticconstexpr

Number of components in Scalar is 1.

Definition at line 108 of file scalarImpl.H.

◆ min_

Scalar min_ = -ScalarVGREAT
staticconstexpr

Definition at line 113 of file scalarImpl.H.

◆ max_

Scalar max_ = ScalarVGREAT
staticconstexpr

Definition at line 114 of file scalarImpl.H.

◆ vsmall_

Scalar vsmall_ = ScalarVSMALL
staticconstexpr

Definition at line 115 of file scalarImpl.H.

◆ typeName

const char* const typeName
static

Definition at line 120 of file scalarImpl.H.

◆ componentNames

const char* const componentNames[]
static

Definition at line 121 of file scalarImpl.H.

◆ zero

const Scalar zero
static

Definition at line 122 of file scalarImpl.H.

◆ one

const Scalar one
static

Definition at line 123 of file scalarImpl.H.

◆ max

const Scalar max
static

Definition at line 124 of file scalarImpl.H.

◆ min

const Scalar min
static

Definition at line 125 of file scalarImpl.H.

◆ rootMax

const Scalar rootMax
static

Definition at line 126 of file scalarImpl.H.

◆ rootMin

const Scalar rootMin
static

Definition at line 127 of file scalarImpl.H.

◆ vsmall

const Scalar vsmall
static

Definition at line 128 of file scalarImpl.H.

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