Class to determine the 'oriented' status of surface fields. More...
Public Types | |
enum | orientedOption : unsigned char { UNKNOWN = 0, ORIENTED = 1, UNORIENTED = 2 } |
Enumeration defining oriented flags. More... | |
Public Member Functions | |
orientedType (const orientedType &) noexcept=default | |
Copy construct. More... | |
orientedType & | operator= (const orientedType &) noexcept=default |
Copy assignment. More... | |
constexpr | orientedType () noexcept |
Default construct as UNKNOWN . More... | |
orientedType (orientedOption opt) noexcept | |
Implicit construct from enumeration. More... | |
constexpr | orientedType (const bool isOriented) noexcept |
Construct from bool. More... | |
orientedType (Istream &is) | |
Construct from Istream. More... | |
orientedOption | oriented () const noexcept |
Return the oriented flag. More... | |
orientedOption & | oriented () noexcept |
Return non-const reference to the oriented flag. More... | |
bool | is_oriented () const noexcept |
True if ORIENTED . More... | |
void | setOriented (bool on=true) noexcept |
Set the oriented flag: on/off. More... | |
void | read (const dictionary &dict) |
Read the "oriented" state from dictionary. More... | |
bool | writeEntry (Ostream &os) const |
Write the "oriented" flag entry (if ORIENTED ) More... | |
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 noexcept |
Convert to bool. Same as is_oriented() More... | |
Static Public Member Functions | |
static bool | checkType (const orientedType &a, const orientedType &b) noexcept |
True if can operate on this combination of oriented types. More... | |
Static Public Attributes | |
static const Enum< orientedOption > | orientedOptionNames |
Named enumerations for oriented flags. More... | |
Friends | |
Istream & | operator>> (Istream &is, orientedType &ot) |
Ostream & | operator<< (Ostream &os, const orientedType &ot) |
Class to determine the 'oriented' status of surface fields.
Definition at line 52 of file orientedType.H.
enum orientedOption : unsigned char |
Enumeration defining oriented flags.
Enumerator | |
---|---|
UNKNOWN | Unknown/undefined orientation. |
ORIENTED | Is oriented. |
UNORIENTED | Is unoriented. |
Definition at line 61 of file orientedType.H.
|
defaultnoexcept |
Copy construct.
|
inlinenoexcept |
Default construct as UNKNOWN
.
Definition at line 107 of file orientedType.H.
|
inlinenoexcept |
Implicit construct from enumeration.
Definition at line 115 of file orientedType.H.
|
inlineexplicitnoexcept |
Construct from bool.
Definition at line 123 of file orientedType.H.
|
explicit |
Construct from Istream.
Definition at line 94 of file orientedType.C.
References IOstream::check(), and FUNCTION_NAME.
|
defaultnoexcept |
Copy assignment.
|
staticnoexcept |
True if can operate on this combination of oriented types.
Definition at line 43 of file orientedType.C.
References Foam::constant::physicoChemical::b, and orientedType::oriented().
|
inlinenoexcept |
Return the oriented flag.
Definition at line 148 of file orientedType.H.
Referenced by orientedType::checkType(), Foam::checkTypes(), orientedType::operator+=(), orientedType::operator-=(), and Foam::operator<<().
|
inlinenoexcept |
Return non-const reference to the oriented flag.
Definition at line 153 of file orientedType.H.
|
inlinenoexcept |
True if ORIENTED
.
Definition at line 158 of file orientedType.H.
References orientedType::ORIENTED.
Referenced by Foam::lerp(), orientedType::operator()(), orientedType::operator*=(), Foam::operator+(), Foam::operator-(), orientedType::operator/=(), and Foam::operator^().
|
inlinenoexcept |
Set the oriented flag: on/off.
Definition at line 163 of file orientedType.H.
References orientedType::ORIENTED, and orientedType::UNORIENTED.
void read | ( | const dictionary & | dict | ) |
Read the "oriented" state from dictionary.
Definition at line 104 of file orientedType.C.
References dict.
bool writeEntry | ( | Ostream & | os | ) | const |
Write the "oriented" flag entry (if ORIENTED
)
Definition at line 116 of file orientedType.C.
References os(), Foam::output(), and Ostream::writeEntry().
void operator+= | ( | const orientedType & | ot | ) |
Definition at line 131 of file orientedType.C.
References Foam::checkTypes(), and orientedType::oriented().
void operator-= | ( | const orientedType & | ot | ) |
Definition at line 143 of file orientedType.C.
References Foam::checkTypes(), and orientedType::oriented().
void operator*= | ( | const orientedType & | ot | ) |
Definition at line 155 of file orientedType.C.
References orientedType::is_oriented(), and setOriented().
void operator/= | ( | const orientedType & | ot | ) |
Definition at line 161 of file orientedType.C.
References orientedType::is_oriented(), and setOriented().
void operator*= | ( | const scalar | s | ) |
Definition at line 167 of file orientedType.C.
void operator/= | ( | const scalar | s | ) |
Definition at line 173 of file orientedType.C.
|
inlinenoexcept |
Convert to bool. Same as is_oriented()
Definition at line 193 of file orientedType.H.
References orientedType::is_oriented().
|
friend |
|
friend |
|
static |
Named enumerations for oriented flags.
Definition at line 74 of file orientedType.H.
Referenced by Foam::checkTypes(), Foam::operator<<(), and Foam::operator>>().