patch Struct Reference

Rectangular patch, selectable as patch. More...

#include <PDRobstacleTypes.H>

Inheritance diagram for patch:

Collaboration diagram for patch:

Static Public Member Functions
static void	read (PDRobstacle &obs, const dictionary &dict)
Static Public Member Functions inherited from PDRobstacle
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.

Static Public Attributes
static constexpr int	enumTypeId = legacyTypes::RECT_PATCH
Static Public Attributes inherited from PDRobstacle
static constexpr int	maxBlowoffPressure = 10
	The max blowoff pressure [bar].

Additional Inherited Members
Public Types inherited from PDRobstacle
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 inherited from PDRobstacle
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.
Public Attributes inherited from PDRobstacle
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

Detailed Description

Rectangular patch, selectable as patch.

Dictionary controls

Property	Description	Required	Default
name	The patch name corner	yes
point	The lower left corner	yes
size	The (x y z) dimensions	yes
direction	The direction (x/y/z, _x/_y/_z or "-x"/"-y"/"-z"	yes

Example,

patch
{
     name        inlet;
     direction   _x;
     point       (0 0 0);
     size        (0 0.05 1.0);
}

Definition at line 450 of file PDRobstacleTypes.H.

Member Function Documentation

read()

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

static

References dict, and PDRobstacle::PDRobstacle().

Here is the call graph for this function:

Member Data Documentation

enumTypeId

int enumTypeId = legacyTypes::RECT_PATCH

staticconstexpr

Definition at line 452 of file PDRobstacleTypes.H.

---

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

• applications/utilities/preProcessing/PDR/pdrFields/obstacles/PDRobstacleTypes.H