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

Template specialisation for pTraits<complex> More...

Collaboration diagram for pTraits< complex >:
Collaboration graph
[legend]

Public Types

typedef complex 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 (const complex &val) noexcept
 Copy construct from primitive. More...
 
 pTraits (Istream &is)
 Read construct from Istream. More...
 
 operator complex () const noexcept
 Return the value. More...
 
 operator complex & () noexcept
 Access the value. More...
 

Static Public Attributes

static constexpr direction dim = 3
 Dimensionality of space. More...
 
static constexpr direction rank = 0
 Rank of complex is 0. More...
 
static constexpr direction nComponents = 2
 Number of components in complex is 2. More...
 
static const char *const typeName
 
static const char *const componentNames []
 
static const complex zero
 complex (0,0) More...
 
static const complex one
 complex (1,0) More...
 
static const complex min
 complex (-VGREAT,-VGREAT) More...
 
static const complex max
 complex (VGREAT,VGREAT) More...
 
static const complex rootMin
 complex (-ROOTVGREAT, -ROOTVGREAT) More...
 
static const complex rootMax
 complex (ROOTVGREAT, ROOTVGREAT) More...
 

Detailed Description

template<>
class Foam::pTraits< complex >

Template specialisation for pTraits<complex>

Definition at line 301 of file complex.H.

Member Typedef Documentation

◆ cmptType

typedef complex cmptType

Component type.

Definition at line 312 of file complex.H.

◆ magType

typedef scalar magType

Magnitude type.

Definition at line 317 of file complex.H.

◆ labelType

typedef label labelType

Equivalent type of labels used for valid component indexing.

Definition at line 322 of file complex.H.

Constructor & Destructor Documentation

◆ pTraits() [1/2]

pTraits ( const complex &  val)
inlineexplicitnoexcept

Copy construct from primitive.

Definition at line 361 of file complex.H.

◆ pTraits() [2/2]

pTraits ( Istream &  is)
explicit

Read construct from Istream.

Member Function Documentation

◆ operator complex()

operator complex ( ) const
inlinenoexcept

Return the value.

Definition at line 378 of file complex.H.

◆ operator complex &()

operator complex & ( )
inlinenoexcept

Access the value.

Definition at line 383 of file complex.H.

Member Data Documentation

◆ dim

constexpr direction dim = 3
static

Dimensionality of space.

Definition at line 330 of file complex.H.

◆ rank

constexpr direction rank = 0
static

Rank of complex is 0.

Definition at line 335 of file complex.H.

◆ nComponents

constexpr direction nComponents = 2
static

Number of components in complex is 2.

Definition at line 340 of file complex.H.

◆ typeName

const char* const typeName
static

Definition at line 345 of file complex.H.

◆ componentNames

const char* const componentNames[]
static

Definition at line 346 of file complex.H.

◆ zero

const complex zero
static

complex (0,0)

Definition at line 348 of file complex.H.

◆ one

const complex one
static

complex (1,0)

Definition at line 349 of file complex.H.

◆ min

const complex min
static

complex (-VGREAT,-VGREAT)

Definition at line 350 of file complex.H.

◆ max

const complex max
static

complex (VGREAT,VGREAT)

Definition at line 351 of file complex.H.

◆ rootMin

const complex rootMin
static

complex (-ROOTVGREAT, -ROOTVGREAT)

Definition at line 352 of file complex.H.

◆ rootMax

const complex rootMax
static

complex (ROOTVGREAT, ROOTVGREAT)

Definition at line 353 of file complex.H.

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