pTraits< Scalar > Class Template Reference

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

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

Static Public Attributes
static constexpr direction	dim = 3
	Dimensionality of space. More...
static constexpr direction	rank = 0
	Rank of Scalar is 0. More...
static constexpr direction	nComponents = 1
	Number of components in Scalar is 1. More...
static const char *const	typeName = "scalar"
static const char *const	componentNames [] = { "" }
static const Scalar	zero = 0.0
static const Scalar	one = 1.0
static const Scalar	max = ScalarVGREAT
static const Scalar	min = -ScalarVGREAT
static const Scalar	rootMax = ScalarROOTVGREAT
static const Scalar	rootMin = -ScalarROOTVGREAT
static const Scalar	vsmall = ScalarVSMALL

Detailed Description

template<>
class Foam::pTraits< Scalar >

Definition at line 63 of file Scalar.H.

Member Typedef Documentation

cmptType

typedef Scalar cmptType

Component type.

Definition at line 74 of file Scalar.H.

magType

typedef Scalar magType

Magnitude type.

Definition at line 79 of file Scalar.H.

labelType

typedef label labelType

Equivalent type of labels used for valid component indexing.

Definition at line 84 of file Scalar.H.

Constructor & Destructor Documentation

pTraits() [1/2]

pTraits ( Scalar  val )

inlineexplicitnoexcept

Copy construct from primitive.

Definition at line 123 of file Scalar.H.

pTraits() [2/2]

pTraits ( Istream &  is )

explicit

Read construct from Istream.

Definition at line 43 of file Scalar.C.

Member Function Documentation

operator Scalar()

operator Scalar ( ) const

inlinenoexcept

Return the value.

Definition at line 139 of file Scalar.H.

operator Scalar &()

operator Scalar & ( )

inlinenoexcept

Access the value.

Definition at line 147 of file Scalar.H.

Member Data Documentation

dim

constexpr direction dim = 3

static

Dimensionality of space.

Definition at line 92 of file Scalar.H.

rank

constexpr direction rank = 0

static

Rank of Scalar is 0.

Definition at line 97 of file Scalar.H.

nComponents

constexpr direction nComponents = 1

static

Number of components in Scalar is 1.

Definition at line 102 of file Scalar.H.

typeName

const char *const typeName = "scalar"

static

Definition at line 107 of file Scalar.H.

componentNames

const char *const componentNames = { "" }

static

Definition at line 108 of file Scalar.H.

zero

const Scalar zero = 0.0

static

Definition at line 109 of file Scalar.H.

one

const Scalar one = 1.0

static

Definition at line 110 of file Scalar.H.

max

const Scalar max = ScalarVGREAT

static

Definition at line 111 of file Scalar.H.

min

const Scalar min = -ScalarVGREAT

static

Definition at line 112 of file Scalar.H.

rootMax

const Scalar rootMax = ScalarROOTVGREAT

static

Definition at line 113 of file Scalar.H.

rootMin

const Scalar rootMin = -ScalarROOTVGREAT

static

Definition at line 114 of file Scalar.H.

vsmall

const Scalar vsmall = ScalarVSMALL

static

Definition at line 115 of file Scalar.H.

---

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

• src/OpenFOAM/primitives/Scalar/Scalar.H
• src/OpenFOAM/primitives/Scalar/Scalar.C