Obstacle definitions for PDR. More...

#include <PDRobstacle.H>

Inheritance diagram for PDRobstacle:

[legend]

Collaboration diagram for PDRobstacle:

[legend]

Public Types
enum	legacyTypes { NONE = 0 , CUBOID_1 = 1 , CYLINDER = 2 , LOUVER_BLOWOFF = 5 , LOUVRE_BLOWOFF = 5 , CUBOID = 6 , WALL_BEAM = 7 , GRATING = 8 , OLD_INLET = 9 , OLD_BLOWOFF = 10 , CIRC_PATCH = 12 , RECT_PATCH = 16 , DIAG_BEAM = 22 , IGNITION = 41 , MESH_PLANE = 46 , IGNORE = 200 }
	Obstacle types (legacy numbering). More...

Public Member Functions
scalar	dia () const
scalar	theta () const
scalar	len () const
scalar &	dia ()
scalar &	theta ()
scalar &	len ()
	PDRobstacle ()
	Construct zero-initialized.
	PDRobstacle (Istream &is)
	Read construct as named dictionary.
	declareMemberFunctionSelectionTable (void, PDRobstacle, read, dictionary,(PDRobstacle &obs, const dictionary &dict),(obs, dict))
bool	read (Istream &is)
	Read name / dictionary.
void	readProperties (const dictionary &dict)
	Read the 'name' identifier if present.
scalar	x () const
	Obstacle position accessors.
scalar	y () const
scalar	z () const
scalar &	x ()
scalar &	y ()
scalar &	z ()
bool	isCylinder () const
	Is obstacle cylinder-like?
void	clear ()
	Reset to a zero obstacle.
void	scale (const scalar factor)
	Scale obstacle dimensions by specified scaling factor.
scalar	volume () const
	Volume of the obstacle.
bool	tooSmall (const scalar minWidth) const
	True if the obstacle is considered to be too small.
bool	setFromLegacy (const int groupTypeId, const string &buffer, const label lineNo=-1, const word &inputFile=word::null)
	Set values from single-line, multi-column format.
volumeType	trim (const boundBox &bb)
	Trim obstacle to ensure it is within the specified bounding box and return the intersection type.
meshedSurface	surface () const
	Surface (points, faces) representation.
InfoProxy< PDRobstacle >	info () const noexcept
	Return info proxy, used to print information to a stream.

Static Public Member Functions
static scalar	legacyReadFiles (const fileName &obsFileDir, const wordList &obsFileNames, const boundBox &meshBb, DynamicList< PDRobstacle > &blocks, DynamicList< PDRobstacle > &cylinders)
	Read obstacle files and add to the lists.
static scalar	readFiles (const fileName &obsFileDir, const wordList &obsFileNames, const boundBox &meshBb, DynamicList< PDRobstacle > &blocks, DynamicList< PDRobstacle > &cylinders)
	Read obstacle files and set the lists.
static bool	isCylinder (const label id)
	Is obstacle type id cylinder-like?
static label	addPieces (vtk::surfaceWriter &surfWriter, const UList< PDRobstacle > &list, label pieceId=0)
	Add pieces to vtp output.
static void	generateVtk (const fileName &outputDir, const UList< PDRobstacle > &obslist, const UList< PDRobstacle > &cyllist)
	Generate multi-piece VTK (vtp) file of obstacles.

Public Attributes
label	groupId
	The group-id.
int	typeId
	The obstacle type-id.
direction	orient
	The x/y/z orientation (0,1,2).
scalar	sortBias
	Bias for position sorting.
point	pt
	The obstacle location.
vector	span
	The obstacle dimensions (for boxes).
union {
scalar wa
scalar slat_width
scalar blowoff_press
};
union {
scalar wb
scalar blowoff_time
};
scalar	vbkge
scalar	xbkge
scalar	ybkge
scalar	zbkge
union {
int blowoff_type
int inlet_dirn
};
string	identifier

Static Public Attributes
static constexpr int	maxBlowoffPressure = 10
	The max blowoff pressure [bar].

Friends
Istream &	operator>> (Istream &is, PDRobstacle &obs)

Detailed Description

Obstacle definitions for PDR.

Source files

Definition at line 70 of file PDRobstacle.H.

Member Enumeration Documentation

◆ legacyTypes

enum legacyTypes

Obstacle types (legacy numbering).

Enumerator
NONE	Placeholder.
CUBOID_1
CYLINDER
LOUVER_BLOWOFF
LOUVRE_BLOWOFF
CUBOID
WALL_BEAM
GRATING
OLD_INLET	ignored (old)
OLD_BLOWOFF	ignored (old)
CIRC_PATCH
RECT_PATCH
DIAG_BEAM
IGNITION	ignored (old)
MESH_PLANE
IGNORE

Definition at line 77 of file PDRobstacle.H.

Constructor & Destructor Documentation

◆ PDRobstacle() [1/2]

PDRobstacle ( )

Construct zero-initialized.

Referenced by declareMemberFunctionSelectionTable(), operator>>, cuboid::read(), cylinder::read(), diagbeam::read(), grating::read(), louver::read(), patch::read(), and wallbeam::read().

Here is the caller graph for this function:

◆ PDRobstacle() [2/2]

PDRobstacle ( Istream & is )

explicit

Read construct as named dictionary.

Member Function Documentation

◆ dia() [1/2]

scalar dia ( ) const

inline

Definition at line 144 of file PDRobstacle.H.

References span, and Vector< scalar >::X.

◆ theta() [1/2]

scalar theta ( ) const

inline

Definition at line 145 of file PDRobstacle.H.

References span, and Vector< scalar >::Y.

◆ len() [1/2]

scalar len ( ) const

inline

Definition at line 146 of file PDRobstacle.H.

References span, and Vector< scalar >::Z.

◆ dia() [2/2]

scalar & dia ( )

inline

Definition at line 148 of file PDRobstacle.H.

References span, and Vector< scalar >::X.

◆ theta() [2/2]

scalar & theta ( )

inline

Definition at line 149 of file PDRobstacle.H.

References span, and Vector< scalar >::Y.

◆ len() [2/2]

scalar & len ( )

inline

Definition at line 150 of file PDRobstacle.H.

References span, and Vector< scalar >::Z.

◆ declareMemberFunctionSelectionTable()

declareMemberFunctionSelectionTable	(	void	,
		PDRobstacle	,
		read	,
		dictionary	,
		(PDRobstacle &obs, const dictionary &dict)	,
		(obs, dict)	)

References dict, PDRobstacle(), and read().

Here is the call graph for this function:

◆ legacyReadFiles()

scalar legacyReadFiles	(	const fileName &	obsFileDir,
		const wordList &	obsFileNames,
		const boundBox &	meshBb,
		DynamicList< PDRobstacle > &	blocks,
		DynamicList< PDRobstacle > &	cylinders )

static

Read obstacle files and add to the lists.

Returns: the total volume

References meshBb().

Here is the call graph for this function:

◆ readFiles()

scalar readFiles	(	const fileName &	obsFileDir,
		const wordList &	obsFileNames,
		const boundBox &	meshBb,
		DynamicList< PDRobstacle > &	blocks,
		DynamicList< PDRobstacle > &	cylinders )

static

Read obstacle files and set the lists.

Returns: the total volume

References meshBb().

Here is the call graph for this function:

◆ read()

bool read ( Istream & is )

Read name / dictionary.

Referenced by declareMemberFunctionSelectionTable().

Here is the caller graph for this function:

◆ readProperties()

void readProperties ( const dictionary & dict )

Read the 'name' identifier if present.

References dict.

◆ x() [1/2]

scalar x ( ) const

inline

Obstacle position accessors.

Definition at line 255 of file PDRobstacle.H.

References pt.

◆ y() [1/2]

scalar y ( ) const

inline

Definition at line 256 of file PDRobstacle.H.

References pt.

◆ z() [1/2]

scalar z ( ) const

inline

Definition at line 257 of file PDRobstacle.H.

References pt.

◆ x() [2/2]

scalar & x ( )

inline

Definition at line 258 of file PDRobstacle.H.

References pt.

◆ y() [2/2]

scalar & y ( )

inline

Definition at line 259 of file PDRobstacle.H.

References pt.

◆ z() [2/2]

scalar & z ( )

inline

Definition at line 260 of file PDRobstacle.H.

References pt.

◆ isCylinder() [1/2]

bool isCylinder ( const label id )

inlinestatic

Is obstacle type id cylinder-like?

Definition at line 23 of file PDRobstacleI.H.

References CYLINDER, and DIAG_BEAM.

Referenced by isCylinder().

Here is the caller graph for this function:

◆ isCylinder() [2/2]

bool isCylinder ( ) const

inline

Is obstacle cylinder-like?

Definition at line 33 of file PDRobstacleI.H.

References isCylinder(), and typeId.

Here is the call graph for this function:

◆ clear()

void clear ( )

Reset to a zero obstacle.

◆ scale()

void scale ( const scalar factor )

Scale obstacle dimensions by specified scaling factor.

Zero and negative factors are ignored

◆ volume()

scalar volume ( ) const

Volume of the obstacle.

◆ tooSmall()

bool tooSmall ( const scalar minWidth ) const

True if the obstacle is considered to be too small.

◆ setFromLegacy()

bool setFromLegacy	(	const int	groupTypeId,
		const string &	buffer,
		const label	lineNo = -1,
		const word &	inputFile = word::null )

Set values from single-line, multi-column format.

The only input format, but termed 'legacy' since it may be replaced in the near future.

Returns: false if the scanning failed or if the obstacle type is not supported (or no longer supported)

References word::null.

◆ trim()

volumeType trim ( const boundBox & bb )

Trim obstacle to ensure it is within the specified bounding box and return the intersection type.

Returns UNKNOWN for unknown types and invalid bounding boxes

◆ surface()

meshedSurface surface ( ) const

Surface (points, faces) representation.

◆ addPieces()

label addPieces	(	vtk::surfaceWriter &	surfWriter,
		const UList< PDRobstacle > &	list,
		label	pieceId = 0 )

static

Add pieces to vtp output.

◆ generateVtk()

void generateVtk	(	const fileName &	outputDir,
		const UList< PDRobstacle > &	obslist,
		const UList< PDRobstacle > &	cyllist )

static

Generate multi-piece VTK (vtp) file of obstacles.

◆ info()

InfoProxy< PDRobstacle > info ( ) const

inlinenoexcept

Return info proxy, used to print information to a stream.

Definition at line 351 of file PDRobstacle.H.

References Foam::noexcept.

◆ operator>>

Istream & operator>>	(	Istream &	is,
		PDRobstacle &	obs )

friend

References PDRobstacle().

Member Data Documentation

◆ maxBlowoffPressure

int maxBlowoffPressure = 10

staticconstexpr

The max blowoff pressure [bar].

Primarily to catch accidental input in Pa or mbar

Definition at line 105 of file PDRobstacle.H.

◆ groupId

label groupId

The group-id.

Definition at line 113 of file PDRobstacle.H.

◆ typeId

int typeId

The obstacle type-id.

Definition at line 118 of file PDRobstacle.H.

Referenced by isCylinder().

◆ orient

direction orient

The x/y/z orientation (0,1,2).

Definition at line 123 of file PDRobstacle.H.

◆ sortBias

scalar sortBias

Bias for position sorting.

Definition at line 128 of file PDRobstacle.H.

◆ pt

point pt

The obstacle location.

Lower corner for boxes, end-centre for cylinders

Definition at line 135 of file PDRobstacle.H.

Referenced by x(), x(), y(), y(), z(), and z().

◆ span

vector span

The obstacle dimensions (for boxes).

Definition at line 140 of file PDRobstacle.H.

Referenced by dia(), dia(), len(), len(), theta(), and theta().

◆ wa

scalar wa

Definition at line 154 of file PDRobstacle.H.

◆ slat_width

scalar slat_width

Definition at line 155 of file PDRobstacle.H.

◆ blowoff_press

scalar blowoff_press

Definition at line 156 of file PDRobstacle.H.

◆ [union]

union { ... }

◆ wb

scalar wb

Definition at line 160 of file PDRobstacle.H.

◆ blowoff_time

scalar blowoff_time

Definition at line 161 of file PDRobstacle.H.

◆ [union]

union { ... }

◆ vbkge

scalar vbkge

Definition at line 163 of file PDRobstacle.H.

◆ xbkge

scalar xbkge

Definition at line 164 of file PDRobstacle.H.

◆ ybkge

scalar ybkge

Definition at line 165 of file PDRobstacle.H.

◆ zbkge

scalar zbkge

Definition at line 166 of file PDRobstacle.H.

◆ blowoff_type

int blowoff_type

Definition at line 170 of file PDRobstacle.H.

◆ inlet_dirn

int inlet_dirn

Definition at line 171 of file PDRobstacle.H.

◆ [union]

union { ... }

◆ identifier

string identifier

Definition at line 174 of file PDRobstacle.H.

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

applications/utilities/preProcessing/PDR/pdrFields/obstacles/PDRobstacle.H
applications/utilities/preProcessing/PDR/pdrFields/obstacles/PDRobstacleI.H

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ legacyTypes

Constructor & Destructor Documentation

◆ PDRobstacle() [1/2]

◆ PDRobstacle() [2/2]

Member Function Documentation

◆ dia() [1/2]

◆ theta() [1/2]

◆ len() [1/2]

◆ dia() [2/2]

◆ theta() [2/2]

◆ len() [2/2]

◆ declareMemberFunctionSelectionTable()

◆ legacyReadFiles()

◆ readFiles()

◆ read()

◆ readProperties()

◆ x() [1/2]

◆ y() [1/2]

◆ z() [1/2]

◆ x() [2/2]

◆ y() [2/2]

◆ z() [2/2]

◆ isCylinder() [1/2]

◆ isCylinder() [2/2]

◆ clear()

◆ scale()

◆ volume()

◆ tooSmall()

◆ setFromLegacy()

◆ trim()

◆ surface()

◆ addPieces()

◆ generateVtk()

◆ info()

Friends And Related Symbol Documentation

◆ operator>>

Member Data Documentation

◆ maxBlowoffPressure

◆ groupId

◆ typeId

◆ orient

◆ sortBias

◆ pt

◆ span

◆ wa

◆ slat_width

◆ blowoff_press

◆ [union]

◆ wb

◆ blowoff_time

◆ [union]

◆ vbkge

◆ xbkge

◆ ybkge

◆ zbkge

◆ blowoff_type

◆ inlet_dirn

◆ [union]

◆ identifier