Public Types | Public Member Functions | Static Public Attributes | Friends | List of all members
volumeType Class Reference
Collaboration diagram for volumeType:
Collaboration graph
[legend]

Public Types

enum  type { unknown = 0, mixed = 1, inside = 2, outside = 3 }
 Volume types. More...
 

Public Member Functions

 volumeType ()
 Construct null. More...
 
 volumeType (type t)
 Construct from components. More...
 
 operator type () const
 

Static Public Attributes

static const NamedEnum< volumeType, 4 > names
 

Friends

Istream & operator>> (Istream &is, volumeType &vt)
 
Ostream & operator<< (Ostream &os, const volumeType &vt)
 

Detailed Description

Source files

Definition at line 54 of file volumeType.H.

Member Enumeration Documentation

◆ type

enum type

Volume types.

Enumerator
unknown 
mixed 
inside 
outside 

Definition at line 59 of file volumeType.H.

Constructor & Destructor Documentation

◆ volumeType() [1/2]

volumeType ( )
inline

Construct null.

Definition at line 86 of file volumeType.H.

◆ volumeType() [2/2]

volumeType ( type  t)
inline

Construct from components.

Definition at line 92 of file volumeType.H.

Member Function Documentation

◆ operator type()

operator type ( ) const
inline

Definition at line 100 of file volumeType.H.

References volumeType::operator<<, and volumeType::operator>>.

Friends And Related Function Documentation

◆ operator>>

Istream& operator>> ( Istream &  is,
volumeType &  vt 
)
friend

Referenced by volumeType::operator type().

◆ operator<<

Ostream& operator<< ( Ostream &  os,
const volumeType &  vt 
)
friend

Referenced by volumeType::operator type().

Member Data Documentation

◆ names

const Foam::NamedEnum< Foam::volumeType, 4 > names
static

Definition at line 80 of file volumeType.H.

Referenced by NamedEnum< compressibleField, 8 >::names(), and searchableSurfacesQueries::signedDistance().

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