volumeType Class Reference

An enumeration wrapper for classification of a location as being inside/outside of a volume. More...

Collaboration diagram for volumeType:

Public Types
enum	type : char { UNKNOWN = 0, INSIDE = 0x1, OUTSIDE = 0x2, MIXED = 0x3 }
	Volume classification types. More...

Public Member Functions
constexpr	volumeType () noexcept
	Default construct as UNKNOWN state. More...
	volumeType (type t) noexcept
	Implicit construct from enumeration. More...
	volumeType (const word &key, const dictionary &dict, const type deflt)
	Construct as getOrDefault by name from dictionary. More...
	volumeType (const int t)
	Construct from integer. More...
	operator type () const noexcept
	Implicit cast to the enumeration. More...
const word &	str () const
	The string representation of the volume type enumeration. More...

Static Public Attributes
static const Enum< volumeType::type >	names
	Names for the classification enumeration. More...

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

Detailed Description

An enumeration wrapper for classification of a location as being inside/outside of a volume.

Source files

• volumeType.H
• volumeType.C

Definition at line 55 of file volumeType.H.

Member Enumeration Documentation

type

enum type : char

Volume classification types.

Enumerator
UNKNOWN	Unknown state.
INSIDE	A location inside the volume.
OUTSIDE	A location outside the volume.
MIXED	A location that is partly inside and outside.

Definition at line 62 of file volumeType.H.

Constructor & Destructor Documentation

volumeType() [1/4]

constexpr volumeType ( )

inlinenoexcept

Default construct as UNKNOWN state.

Definition at line 95 of file volumeType.H.

volumeType() [2/4]

volumeType ( type  t )

inlinenoexcept

Implicit construct from enumeration.

Definition at line 103 of file volumeType.H.

volumeType() [3/4]

volumeType	(	const word &	key,
		const dictionary &	dict,
		const type	deflt
	)

Construct as getOrDefault by name from dictionary.

Definition at line 43 of file volumeType.C.

volumeType() [4/4]

volumeType ( const int  t )

inlineexplicit

Construct from integer.

Definition at line 116 of file volumeType.H.

Member Function Documentation

operator type()

operator type ( ) const

inlinenoexcept

Implicit cast to the enumeration.

Definition at line 127 of file volumeType.H.

str()

const Foam::word & str

(

)

const

The string representation of the volume type enumeration.

Definition at line 55 of file volumeType.C.

References volumeType::names.

Referenced by refinementSurfaces::refinementSurfaces(), and searchableSurfacesQueries::signedDistance().

Here is the caller graph for this function:

Friends And Related Function Documentation

operator>>

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

friend

operator<<

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

friend

Member Data Documentation

names

const Foam::Enum< Foam::volumeType::type > names

static

Names for the classification enumeration.

Definition at line 75 of file volumeType.H.

Referenced by distributedTriSurfaceMesh::distributedTriSurfaceMesh(), distributedTriSurfaceMesh::getVolumeType(), volumeCombineOp::operator()(), triSurfaceMesh::outsideVolumeType(), volumeType::str(), and distributedTriSurfaceMesh::writeStats().

---

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

• src/OpenFOAM/meshes/primitiveShapes/volumeType/volumeType.H
• src/OpenFOAM/meshes/primitiveShapes/volumeType/volumeType.C