complex Class Reference

Extension to the c++ complex library type. More...

#include <OpenFOAM/complex.H>

---

Detailed Description

Extension to the c++ complex library type.

Source files

• src/OpenFOAM/primitives/complex/complex.H
• src/OpenFOAM/primitives/complex/complexI.H
• src/OpenFOAM/primitives/complex/complex.C

Definition at line 77 of file complex.H.

Collaboration diagram for complex:

List of all members.

Public Types
typedef complex	cmptType
	Component type.
Public Member Functions
	complex ()
	Construct null.
	complex (const scalar Re, const scalar Im)
	Construct given real and imaginary parts.
	complex (Istream &)
	Construct from Istream.
scalar	Re () const
scalar	Im () const
scalar &	Re ()
scalar &	Im ()
complex	conjugate () const
const complex &	operator= (const complex &)
void	operator+= (const complex &)
void	operator-= (const complex &)
void	operator*= (const complex &)
void	operator/= (const complex &)
const complex &	operator= (const scalar)
void	operator+= (const scalar)
void	operator-= (const scalar)
void	operator*= (const scalar)
void	operator/= (const scalar)
complex	operator! () const
bool	operator== (const complex &) const
bool	operator!= (const complex &) const
Static Public Attributes
static const char *const	typeName = "complex"
static const complex	zero
static const complex	one
Friends
scalar	magSqr (const complex &c)
complex	sqr (const complex &c)
scalar	mag (const complex &c)
const complex &	max (const complex &, const complex &)
const complex &	min (const complex &, const complex &)
complex	limit (const complex &, const complex &)
const complex &	sum (const complex &)
complex	operator+ (const complex &, const complex &)
complex	operator- (const complex &)
complex	operator- (const complex &, const complex &)
complex	operator* (const complex &, const complex &)
complex	operator/ (const complex &, const complex &)
complex	operator* (const scalar, const complex &)
complex	operator* (const complex &, const scalar)
complex	operator/ (const complex &, const scalar)
complex	operator/ (const scalar, const complex &)
Istream &	operator>> (Istream &, complex &)
Ostream &	operator<< (Ostream &, const complex &)

---

Member Typedef Documentation

typedef complex cmptType

Component type.

Definition at line 87 of file complex.H.

---

Constructor & Destructor Documentation

complex

(

)

[inline]

Construct null.

Definition at line 33 of file complexI.H.

Referenced by complex::conjugate().

complex	(	const scalar	Re,
		const scalar	Im
	)		[inline]

Construct given real and imaginary parts.

Definition at line 37 of file complexI.H.

complex

(

Istream &

is  )

Construct from Istream.

Definition at line 39 of file complex.C.

---

Member Function Documentation

scalar Re

(

)

const [inline]

Definition at line 46 of file complexI.H.

Referenced by Foam::name().

scalar Im

(

)

const [inline]

Definition at line 52 of file complexI.H.

Referenced by Foam::name().

scalar & Re

(

)

[inline]

Definition at line 58 of file complexI.H.

scalar & Im

(

)

[inline]

Definition at line 64 of file complexI.H.

complex conjugate

(

)

const [inline]

Definition at line 70 of file complexI.H.

References complex::complex().

Referenced by complex::operator!().

const complex & operator=

(

const complex &

c  )

[inline]

Definition at line 78 of file complexI.H.

void operator+=

(

const complex &

c  )

[inline]

Definition at line 86 of file complexI.H.

void operator-=

(

const complex &

c  )

[inline]

Definition at line 93 of file complexI.H.

void operator*=

(

const complex &

c  )

[inline]

Definition at line 100 of file complexI.H.

void operator/=

(

const complex &

c  )

[inline]

Definition at line 106 of file complexI.H.

const complex & operator=

(

const scalar

s  )

[inline]

Definition at line 112 of file complexI.H.

void operator+=

(

const scalar

s  )

[inline]

Definition at line 120 of file complexI.H.

void operator-=

(

const scalar

s  )

[inline]

Definition at line 126 of file complexI.H.

void operator*=

(

const scalar

s  )

[inline]

Definition at line 132 of file complexI.H.

void operator/=

(

const scalar

s  )

[inline]

Definition at line 139 of file complexI.H.

complex operator!

(

)

const [inline]

Definition at line 146 of file complexI.H.

References complex::conjugate().

bool operator==

(

const complex &

c  )

const [inline]

Definition at line 152 of file complexI.H.

References Foam::equal().

Referenced by complex::operator!=().

bool operator!=

(

const complex &

c  )

const [inline]

Definition at line 158 of file complexI.H.

References complex::operator==().

---

Friends And Related Function Documentation

scalar magSqr

(

const complex &

c  )

[friend]

complex sqr

(

const complex &

c  )

[friend]

scalar mag

(

const complex &

c  )

[friend]

const complex& max	(	const complex &	c1,
		const complex &	c2
	)		[friend]

const complex& min	(	const complex &	c1,
		const complex &	c2
	)		[friend]

complex limit	(	const complex &	c1,
		const complex &	c2
	)		[friend]

const complex& sum

(

const complex &

c  )

[friend]

complex operator+	(	const complex &	c1,
		const complex &	c2
	)		[friend]

complex operator-

(

const complex &

c  )

[friend]

complex operator-	(	const complex &	c1,
		const complex &	c2
	)		[friend]

complex operator*	(	const complex &	c1,
		const complex &	c2
	)		[friend]

complex operator/	(	const complex &	c1,
		const complex &	c2
	)		[friend]

complex operator*	(	const scalar	s,
		const complex &	c
	)		[friend]

complex operator*	(	const complex &	c,
		const scalar	s
	)		[friend]

complex operator/	(	const complex &	c,
		const scalar	s
	)		[friend]

complex operator/	(	const scalar	s,
		const complex &	c
	)		[friend]

Istream& operator>>	(	Istream &	,
		complex &
	)		[friend]

Ostream& operator<<	(	Ostream &	,
		const complex &
	)		[friend]

---

Member Data Documentation

const char *const typeName = "complex" [static]

Definition at line 92 of file complex.H.

const Foam::complex zero [static]

Definition at line 94 of file complex.H.

const Foam::complex one [static]

Definition at line 95 of file complex.H.

---

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

• src/OpenFOAM/primitives/complex/complex.H
• src/OpenFOAM/primitives/complex/complex.C
• src/OpenFOAM/primitives/complex/complexI.H