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

#include <volumeType.H>

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.
	volumeType (type t) noexcept
	Implicit construct from enumeration.
	volumeType (const word &key, const dictionary &dict, const type deflt)
	Construct as getOrDefault by name from dictionary.
	volumeType (const int t)
	Construct from integer.
	operator type () const noexcept
	Implicit cast to the enumeration.
const word &	str () const
	The string representation of the volume type enumeration.

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

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

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]

volumeType ( )

inlineconstexprnoexcept

Default construct as UNKNOWN state.

Definition at line 95 of file volumeType.H.

References Foam::noexcept, and UNKNOWN.

Referenced by operator<<, operator>>, and volumeType().

Here is the caller graph for this function:

◆ volumeType() [2/4]

volumeType ( type t )

inlinenoexcept

Implicit construct from enumeration.

Definition at line 103 of file volumeType.H.

References Foam::noexcept.

◆ volumeType() [3/4]

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

Construct as getOrDefault by name from dictionary.

Definition at line 42 of file volumeType.C.

References dict, and names.

◆ volumeType() [4/4]

volumeType ( const int t )

inlineexplicit

Construct from integer.

Definition at line 116 of file volumeType.H.

References volumeType().

Here is the call graph for this function:

Member Function Documentation

◆ operator type()

operator type ( ) const

inlinenoexcept

Implicit cast to the enumeration.

Definition at line 127 of file volumeType.H.

References Foam::noexcept.

◆ str()

const Foam::word & str ( ) const

The string representation of the volume type enumeration.

Definition at line 55 of file volumeType.C.

References names.

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

Here is the caller graph for this function:

◆ operator>>

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

friend

References volumeType().

◆ operator<<

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

friend

References os(), and volumeType().

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::flip(), triSurfaceMesh::flip(), distributedTriSurfaceMesh::getVolumeType(), volumeCombineOp::operator()(), triSurfaceMesh::outsideVolumeType(), str(), volumeType(), 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

Public Types

Public Member Functions

Static Public Attributes

Friends