orientedType Class Reference

Class to determine the 'oriented' status of surface fields. More...

Collaboration diagram for orientedType:

Public Types
enum	orientedOption { UNKNOWN = 0, ORIENTED = 1, UNORIENTED = 2 }

Public Member Functions
	orientedType ()
	orientedType (const orientedType &ot)
	orientedType (const bool oriented)
	orientedType (Istream &is)
orientedOption &	oriented () noexcept
orientedOption	oriented () const noexcept
void	setOriented (const bool oriented=true) noexcept
void	read (const dictionary &dict)
bool	writeEntry (Ostream &os) const
void	operator= (const orientedType &ot)
void	operator+= (const orientedType &ot)
void	operator-= (const orientedType &ot)
void	operator*= (const orientedType &ot)
void	operator/= (const orientedType &ot)
void	operator*= (const scalar s)
void	operator/= (const scalar s)
bool	operator() () const

Static Public Member Functions
static bool	checkType (const orientedType &ot1, const orientedType &ot2)

Static Public Attributes
static const Enum< orientedOption >	orientedOptionNames

Friends
Istream &	operator>> (Istream &is, orientedType &ot)
Ostream &	operator<< (Ostream &os, const orientedType &ot)

Detailed Description

Class to determine the 'oriented' status of surface fields.

Source files

• orientedType.H
• orientedType.C

Definition at line 52 of file orientedType.H.

Member Enumeration Documentation

orientedOption

enum orientedOption

Enumerator
UNKNOWN
ORIENTED
UNORIENTED

Definition at line 59 of file orientedType.H.

Constructor & Destructor Documentation

orientedType() [1/4]

orientedType

(

)

Definition at line 59 of file orientedType.C.

orientedType() [2/4]

orientedType

(

const orientedType &

ot

)

Definition at line 65 of file orientedType.C.

orientedType() [3/4]

orientedType ( const bool  oriented )

explicit

Definition at line 71 of file orientedType.C.

orientedType() [4/4]

orientedType ( Istream &  is )

explicit

Definition at line 77 of file orientedType.C.

References IOstream::check(), and FUNCTION_NAME.

Here is the call graph for this function:

Member Function Documentation

checkType()

bool checkType ( const orientedType &  ot1, const orientedType &  ot2  )

static

Definition at line 43 of file orientedType.C.

References orientedType::oriented().

Referenced by Foam::atan2(), Foam::hypot(), Foam::max(), Foam::min(), Foam::operator+(), and Foam::operator-().

Here is the call graph for this function:

Here is the caller graph for this function:

oriented() [1/2]

Foam::orientedType::orientedOption oriented ( )

noexcept

Definition at line 87 of file orientedType.C.

Referenced by Foam::atan2(), orientedType::checkType(), Foam::hypot(), Foam::max(), Foam::min(), Foam::operator+(), orientedType::operator+=(), Foam::operator-(), orientedType::operator-=(), Foam::operator<<(), and orientedType::operator=().

Here is the caller graph for this function:

oriented() [2/2]

orientedOption oriented ( ) const

noexcept

setOriented()

void setOriented ( const bool  oriented = true )

noexcept

Definition at line 99 of file orientedType.C.

read()

void read

(

const dictionary &

dict

)

Definition at line 105 of file orientedType.C.

References dict.

writeEntry()

bool writeEntry

(

Ostream &

os

)

const

Definition at line 117 of file orientedType.C.

References os(), Foam::output(), and Ostream::writeEntry().

Here is the call graph for this function:

operator=()

void operator=

(

const orientedType &

ot

)

Definition at line 132 of file orientedType.C.

References orientedType::oriented().

Here is the call graph for this function:

operator+=()

void operator+=

(

const orientedType &

ot

)

Definition at line 139 of file orientedType.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, and orientedType::oriented().

Here is the call graph for this function:

operator-=()

void operator-=

(

const orientedType &

ot

)

Definition at line 158 of file orientedType.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, and orientedType::oriented().

Here is the call graph for this function:

operator*=() [1/2]

void operator*=

(

const orientedType &

ot

)

Definition at line 177 of file orientedType.C.

operator/=() [1/2]

void operator/=

(

const orientedType &

ot

)

Definition at line 191 of file orientedType.C.

operator*=() [2/2]

void operator*=

(

const scalar

s

)

Definition at line 205 of file orientedType.C.

operator/=() [2/2]

void operator/=

(

const scalar

s

)

Definition at line 211 of file orientedType.C.

operator()()

bool operator()

(

)

const

Definition at line 217 of file orientedType.C.

Friends And Related Function Documentation

operator>>

Istream& operator>> ( Istream &  is, orientedType &  ot  )

friend

operator<<

Ostream& operator<< ( Ostream &  os, const orientedType &  ot  )

friend

Member Data Documentation

orientedOptionNames

const Foam::Enum< Foam::orientedType::orientedOption > orientedOptionNames

static

Definition at line 67 of file orientedType.H.

Referenced by Foam::atan2(), Foam::hypot(), Foam::max(), Foam::min(), Foam::operator+(), Foam::operator-(), Foam::operator<<(), and Foam::operator>>().

---

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

• src/OpenFOAM/orientedType/orientedType.H
• src/OpenFOAM/orientedType/orientedType.C