Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Friends | List of all members
orientedType Class Reference

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

Collaboration diagram for orientedType:
[legend]

Public Types

enum  orientedOption { ORIENTED, UNORIENTED, UNKNOWN }
 Enumeration defining the valid oriented flags. More...
 

Public Member Functions

 orientedType ()
 Null constructor - flag initialised to false. More...
 
 orientedType (const orientedType &ot)
 Copy constructor. More...
 
 orientedType (const bool oriented)
 Construct from bool. More...
 
 orientedType (Istream &is)
 Construct from Istream. More...
 
orientedOption & oriented ()
 Return non-const reference to the oriented flag. More...
 
orientedOption oriented () const
 Return const reference to the oriented flag. More...
 
void setOriented (const bool oriented=true)
 Set the oriented flag. More...
 
void read (const dictionary &dict)
 Read the oriented state from dictionary. More...
 
void writeEntry (Ostream &os) const
 Write the oriented flag entry. More...
 
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)
 Return true if can operate on this pair of oriented types. More...
 

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

Definition at line 61 of file orientedType.H.

Member Enumeration Documentation

◆ orientedOption

enum orientedOption

Enumeration defining the valid oriented flags.

Enumerator
ORIENTED 
UNORIENTED 
UNKNOWN 

Definition at line 68 of file orientedType.H.

Constructor & Destructor Documentation

◆ orientedType() [1/4]

orientedType ( )

Null constructor - flag initialised to false.

Definition at line 61 of file orientedType.C.

◆ orientedType() [2/4]

orientedType ( const orientedType &  ot)

Copy constructor.

Definition at line 67 of file orientedType.C.

◆ orientedType() [3/4]

orientedType ( const bool  oriented)

Construct from bool.

Definition at line 73 of file orientedType.C.

◆ orientedType() [4/4]

orientedType ( Istream &  is)

Construct from Istream.

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

Return true if can operate on this pair of oriented types.

Definition at line 45 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 ( )

Return non-const reference to the oriented flag.

Definition at line 89 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]

Foam::orientedType::orientedOption oriented ( ) const

Return const reference to the oriented flag.

Definition at line 95 of file orientedType.C.

◆ setOriented()

void setOriented ( const bool  oriented = true)

Set the oriented flag.

Definition at line 101 of file orientedType.C.

◆ read()

void read ( const dictionary &  dict)

Read the oriented state from dictionary.

Definition at line 107 of file orientedType.C.

References dict.

◆ writeEntry()

void writeEntry ( Ostream &  os) const

Write the oriented flag entry.

Definition at line 119 of file orientedType.C.

References Ostream::writeEntry().

Here is the call graph for this function:

◆ operator=()

void operator= ( const orientedType &  ot)

Definition at line 130 of file orientedType.C.

References orientedType::oriented().

Here is the call graph for this function:

◆ operator+=()

void operator+= ( const orientedType &  ot)

Definition at line 137 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 156 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 175 of file orientedType.C.

◆ operator/=() [1/2]

void operator/= ( const orientedType &  ot)

Definition at line 189 of file orientedType.C.

◆ operator*=() [2/2]

void operator*= ( const scalar  s)

Definition at line 203 of file orientedType.C.

◆ operator/=() [2/2]

void operator/= ( const scalar  s)

Definition at line 209 of file orientedType.C.

◆ operator()()

bool operator() ( ) const

Definition at line 215 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 75 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: