meshingSurface Class Reference

Attributes of a surface geometry file (e.g. OBJ, STL) that are used in the configuration of mesh input files, (e.g. blockMeshDict, snappyHexMeshDict). More...

Collaboration diagram for meshingSurface:

Public Types
enum class	surfaceType {   wall , external , cellZone , rotatingZone ,   baffle }
	Type of surface. More...

Public Member Functions
	meshingSurface ()
	Construct null. More...
	meshingSurface (const fileName &file, const Time &time)
	Construct from components. More...
	meshingSurface (const meshingSurface &)=delete
	Disallow default bitwise copy construction. More...
	~meshingSurface ()
	Destructor. More...
const fileName &	path () const
	Path to the surface file. More...
const fileName &	file () const
	Surface file name. More...
const word &	name () const
	Surface name, without file extension. More...
const surfaceType &	type () const
	Surface type. More...
surfaceType &	type ()
	Return non-const access to the surface type. More...
const boundBox &	bb () const
	Surface bounding box. More...
bool	closed () const
	Is the surface closed? More...
label	nParts () const
	Return the number of disconnected surfaces. More...
const List< word > &	regions () const
	Surface geometry regions. More...
const List< word > &	inletRegions () const
	Inlet regions. More...
List< word > &	inletRegions ()
	Inlet regions. More...
const List< word > &	outletRegions () const
	Outlet regions. More...
List< word > &	outletRegions ()
	Outlet regions. More...
void	operator= (const meshingSurface &)=delete
	Disallow default bitwise assignment. More...

Static Public Member Functions
static bool	isSurfaceExt (const fileName &file)

Static Public Attributes
static const NamedEnum< surfaceType, 5 >	surfaceTypeNames
	Enumeration names for surfaceTypes. More...

Detailed Description

Attributes of a surface geometry file (e.g. OBJ, STL) that are used in the configuration of mesh input files, (e.g. blockMeshDict, snappyHexMeshDict).

Source files

• meshingSurface.H
• meshingSurface.C

Definition at line 53 of file meshingSurface.H.

Member Enumeration Documentation

surfaceType

enum surfaceType

strong

Type of surface.

Enumerator
wall
external
cellZone
rotatingZone
baffle

Definition at line 60 of file meshingSurface.H.

Constructor & Destructor Documentation

meshingSurface() [1/3]

meshingSurface

(

)

Construct null.

meshingSurface() [2/3]

meshingSurface	(	const fileName &	file,
		const Time &	time
	)

Construct from components.

meshingSurface() [3/3]

meshingSurface ( const meshingSurface &  )

delete

Disallow default bitwise copy construction.

~meshingSurface()

~meshingSurface

(

)

Destructor.

Member Function Documentation

path()

const fileName& path ( ) const

inline

Path to the surface file.

Definition at line 138 of file meshingSurface.H.

file()

const fileName& file ( ) const

inline

Surface file name.

Definition at line 144 of file meshingSurface.H.

name()

const word& name ( ) const

inline

Surface name, without file extension.

Definition at line 150 of file meshingSurface.H.

type() [1/2]

const surfaceType& type ( ) const

inline

Surface type.

Definition at line 156 of file meshingSurface.H.

type() [2/2]

surfaceType& type ( )

inline

Return non-const access to the surface type.

Definition at line 162 of file meshingSurface.H.

bb()

const boundBox& bb ( ) const

inline

Surface bounding box.

Definition at line 168 of file meshingSurface.H.

closed()

bool closed ( ) const

inline

Is the surface closed?

Definition at line 174 of file meshingSurface.H.

nParts()

label nParts ( ) const

inline

Return the number of disconnected surfaces.

Definition at line 180 of file meshingSurface.H.

regions()

const List<word>& regions ( ) const

inline

Surface geometry regions.

Definition at line 186 of file meshingSurface.H.

inletRegions() [1/2]

const List<word>& inletRegions ( ) const

inline

Inlet regions.

Definition at line 192 of file meshingSurface.H.

inletRegions() [2/2]

List<word>& inletRegions ( )

inline

Inlet regions.

Definition at line 198 of file meshingSurface.H.

outletRegions() [1/2]

const List<word>& outletRegions ( ) const

inline

Outlet regions.

Definition at line 204 of file meshingSurface.H.

outletRegions() [2/2]

List<word>& outletRegions ( )

inline

Outlet regions.

Definition at line 210 of file meshingSurface.H.

isSurfaceExt()

static bool isSurfaceExt ( const fileName &  file )

static

operator=()

void operator= ( const meshingSurface &  )

delete

Disallow default bitwise assignment.

Member Data Documentation

surfaceTypeNames

const NamedEnum<surfaceType, 5> surfaceTypeNames

static

Enumeration names for surfaceTypes.

Definition at line 116 of file meshingSurface.H.

---

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

• applications/utilities/preProcessing/snappyHexMeshConfig/meshingSurface.H