Loading...
Searching...
No Matches
orientedType Class Reference

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

#include <orientedType.H>

Collaboration diagram for orientedType:
Collaboration graph
[legend]

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.
orientedType & operator= (const orientedType &) noexcept=default
 Copy assignment.
constexpr orientedType () noexcept
 Default construct as UNKNOWN.
 orientedType (orientedOption opt) noexcept
 Implicit construct from enumeration.
constexpr orientedType (const bool isOriented) noexcept
 Construct from bool.
 orientedType (Istream &is)
 Construct from Istream.
orientedOption oriented () const noexcept
 Return the oriented flag.
orientedOption & oriented () noexcept
 Return non-const reference to the oriented flag.
bool is_oriented () const noexcept
 True if ORIENTED.
void setOriented (bool on=true) noexcept
 Set the oriented flag: on/off.
void read (const dictionary &dict)
 Read the "oriented" state from dictionary.
bool writeEntry (Ostream &os) const
 Write the "oriented" flag entry (if ORIENTED).
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().

Static Public Member Functions

static bool checkType (const orientedType &a, const orientedType &b) noexcept
 True if can operate on this combination of oriented types.

Static Public Attributes

static const Enum< orientedOption > orientedOptionNames
 Named enumerations for oriented flags.

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 52 of file orientedType.H.

Member Enumeration Documentation

◆ orientedOption

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.

Constructor & Destructor Documentation

◆ orientedType() [1/5]

orientedType ( const orientedType & )
defaultnoexcept

Copy construct.

References orientedType().

Referenced by checkType(), operator*=(), operator+=(), operator-=(), operator/=(), operator<<, operator=(), operator>>, and orientedType().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ orientedType() [2/5]

orientedType ( )
inlineconstexprnoexcept

Default construct as UNKNOWN.

Definition at line 107 of file orientedType.H.

References Foam::noexcept, and UNKNOWN.

◆ orientedType() [3/5]

orientedType ( orientedOption opt)
inlinenoexcept

Implicit construct from enumeration.

Definition at line 115 of file orientedType.H.

References Foam::noexcept.

◆ orientedType() [4/5]

orientedType ( const bool isOriented)
inlineexplicitconstexprnoexcept

Construct from bool.

Definition at line 123 of file orientedType.H.

References Foam::noexcept, ORIENTED, and UNORIENTED.

◆ orientedType() [5/5]

orientedType ( Istream & is)
explicit

Construct from Istream.

Definition at line 94 of file orientedType.C.

References IOstream::check(), FUNCTION_NAME, orientedOptionNames, and read().

Here is the call graph for this function:

Member Function Documentation

◆ operator=()

orientedType & operator= ( const orientedType & )
defaultnoexcept

Copy assignment.

References orientedType().

Here is the call graph for this function:

◆ checkType()

bool checkType ( const orientedType & a,
const orientedType & b )
staticnoexcept

True if can operate on this combination of oriented types.

Definition at line 42 of file orientedType.C.

References b, orientedType(), and UNKNOWN.

Here is the call graph for this function:

◆ oriented() [1/2]

orientedOption oriented ( ) const
inlinenoexcept

Return the oriented flag.

Definition at line 148 of file orientedType.H.

References Foam::noexcept.

Referenced by Foam::checkTypes(), operator+=(), operator-=(), and Foam::operator<<().

Here is the caller graph for this function:

◆ oriented() [2/2]

orientedOption & oriented ( )
inlinenoexcept

Return non-const reference to the oriented flag.

Definition at line 153 of file orientedType.H.

References Foam::noexcept.

◆ is_oriented()

bool is_oriented ( ) const
inlinenoexcept

True if ORIENTED.

Definition at line 158 of file orientedType.H.

References Foam::noexcept, and ORIENTED.

Referenced by Foam::lerp(), operator()(), operator*=(), and operator/=().

Here is the caller graph for this function:

◆ setOriented()

void setOriented ( bool on = true)
inlinenoexcept

Set the oriented flag: on/off.

Definition at line 163 of file orientedType.H.

References Foam::noexcept, ORIENTED, and UNORIENTED.

◆ read()

void read ( const dictionary & dict)

Read the "oriented" state from dictionary.

Definition at line 104 of file orientedType.C.

References dict, orientedOptionNames, and UNKNOWN.

Referenced by orientedType().

Here is the caller graph for this function:

◆ writeEntry()

bool writeEntry ( Ostream & os) const

Write the "oriented" flag entry (if ORIENTED).

Returns
True if entry was written

Definition at line 116 of file orientedType.C.

References ORIENTED, orientedOptionNames, and os().

Here is the call graph for this function:

◆ operator+=()

void operator+= ( const orientedType & ot)

Definition at line 131 of file orientedType.C.

References Foam::checkTypes(), oriented(), orientedType(), and UNKNOWN.

Here is the call graph for this function:

◆ operator-=()

void operator-= ( const orientedType & ot)

Definition at line 143 of file orientedType.C.

References Foam::checkTypes(), oriented(), orientedType(), and UNKNOWN.

Here is the call graph for this function:

◆ operator*=() [1/2]

void operator*= ( const orientedType & ot)

Definition at line 155 of file orientedType.C.

References is_oriented(), orientedType(), and setOriented().

Here is the call graph for this function:

◆ operator/=() [1/2]

void operator/= ( const orientedType & ot)

Definition at line 161 of file orientedType.C.

References is_oriented(), orientedType(), and setOriented().

Here is the call graph for this function:

◆ operator*=() [2/2]

void operator*= ( const scalar s)

Definition at line 167 of file orientedType.C.

References s().

Here is the call graph for this function:

◆ operator/=() [2/2]

void operator/= ( const scalar s)

Definition at line 173 of file orientedType.C.

References s().

Here is the call graph for this function:

◆ operator()()

bool operator() ( ) const
inlinenoexcept

Convert to bool. Same as is_oriented().

Definition at line 193 of file orientedType.H.

References is_oriented(), and Foam::noexcept.

Here is the call graph for this function:

◆ operator>>

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

References orientedType().

◆ operator<<

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

References orientedType(), and os().

Member Data Documentation

◆ orientedOptionNames

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

Named enumerations for oriented flags.

Definition at line 74 of file orientedType.H.

Referenced by Foam::checkTypes(), Foam::operator<<(), Foam::operator>>(), orientedType(), read(), and writeEntry().

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