pTraits< Scalar > Class Reference

Collaboration diagram for pTraits< Scalar >:

Public Types
enum	{ dim = 3, rank = 0, nComponents = 1 }
typedef Scalar	cmptType
	Component type. More...
typedef label	labelType
	Equivalent type of labels used for valid component indexing. More...

Public Member Functions
	pTraits (const Scalar &)
	Construct from primitive. More...
	pTraits (Istream &)
	Construct from Istream. More...
	operator Scalar () const
	Access to the Scalar value. More...
	operator Scalar & ()
	Access to the Scalar value. More...

Static Public Attributes
static const char *const	typeName = "scalar"
static const char *	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

Private Attributes
Scalar	p_

Detailed Description

Definition at line 44 of file Scalar.H.

Member Typedef Documentation

cmptType

typedef Scalar cmptType

Component type.

Definition at line 51 of file Scalar.H.

labelType

typedef label labelType

Equivalent type of labels used for valid component indexing.

Definition at line 54 of file Scalar.H.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
dim	Dimensionality of space.
rank	Rank of Scalar is 0.
nComponents	Number of components in Scalar is 1.

Definition at line 58 of file Scalar.H.

Constructor & Destructor Documentation

pTraits() [1/2]

pTraits ( const Scalar &  p )

explicit

Construct from primitive.

Definition at line 43 of file Scalar.C.

pTraits() [2/2]

pTraits

(

Istream &

is

)

Construct from Istream.

Definition at line 49 of file Scalar.C.

Member Function Documentation

operator Scalar()

operator Scalar ( ) const

inline

Access to the Scalar value.

Definition at line 88 of file Scalar.H.

operator Scalar &()

operator Scalar & ( )

inline

Access to the Scalar value.

Definition at line 94 of file Scalar.H.

Field Documentation

p_

Scalar p_

private

Definition at line 46 of file Scalar.H.

typeName

const char *const typeName = "scalar"

static

Definition at line 67 of file Scalar.H.

componentNames

const char * componentNames = { "" }

static

Definition at line 68 of file Scalar.H.

zero

const Scalar zero = 0.0

static

Definition at line 69 of file Scalar.H.

one

const Scalar one = 1.0

static

Definition at line 70 of file Scalar.H.

max

const Scalar max = ScalarVGREAT

static

Definition at line 71 of file Scalar.H.

min

const Scalar min = -ScalarVGREAT

static

Definition at line 72 of file Scalar.H.

rootMax

const Scalar rootMax = ScalarROOTVGREAT

static

Definition at line 73 of file Scalar.H.

rootMin

const Scalar rootMin = -ScalarROOTVGREAT

static

Definition at line 74 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