volumeType Class Reference

Collaboration diagram for volumeType:

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...
	volumeType (const int t)
	Construct from integer. More...
	operator type () const

Static Public Attributes
static const NamedEnum< volumeType, 4 >	names

Private Attributes
type	t_
	Volume type. More...

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

Detailed Description

Source files

• volumeType.H
• volumeType.C

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/3]

volumeType ( )

inline

Construct null.

Definition at line 86 of file volumeType.H.

volumeType() [2/3]

volumeType ( type  t )

inline

Construct from components.

Definition at line 92 of file volumeType.H.

volumeType() [3/3]

volumeType ( const int  t )

inlineexplicit

Construct from integer.

Definition at line 98 of file volumeType.H.

Member Function Documentation

operator type()

operator type ( ) const

inline

Definition at line 106 of file volumeType.H.

References volumeType::t_.

Friends And Related Function Documentation

operator>>

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

friend

operator<<

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

friend

Field Documentation

t_

type t_

private

Volume type.

Definition at line 73 of file volumeType.H.

Referenced by volumeType::operator type(), Foam::operator<<(), and Foam::operator>>().

names

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

static

Definition at line 80 of file volumeType.H.

Referenced by shellSurfaces::shellSurfaces().

---

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

• src/OpenFOAM/algorithms/indexedOctree/volumeType.H
• src/OpenFOAM/algorithms/indexedOctree/volumeType.C