Obstacle definitions for PDR. More...
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. More... | |
PDRobstacle (Istream &is) | |
Read construct as named dictionary. More... | |
declareMemberFunctionSelectionTable (void, PDRobstacle, read, dictionary,(PDRobstacle &obs, const dictionary &dict),(obs, dict)) | |
bool | read (Istream &is) |
Read name / dictionary. More... | |
void | readProperties (const dictionary &dict) |
Read the 'name' identifier if present. More... | |
scalar | x () const |
Obstacle position accessors. More... | |
scalar | y () const |
scalar | z () const |
scalar & | x () |
scalar & | y () |
scalar & | z () |
bool | isCylinder () const |
Is obstacle cylinder-like? More... | |
void | clear () |
Reset to a zero obstacle. More... | |
void | scale (const scalar factor) |
Scale obstacle dimensions by specified scaling factor. More... | |
scalar | volume () const |
Volume of the obstacle. More... | |
bool | tooSmall (const scalar minWidth) const |
True if the obstacle is considered to be too small. More... | |
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. More... | |
volumeType | trim (const boundBox &bb) |
Trim obstacle to ensure it is within the specified bounding box and return the intersection type. More... | |
meshedSurface | surface () const |
Surface (points, faces) representation. More... | |
InfoProxy< PDRobstacle > | info () const noexcept |
Return info proxy, used to print information to a stream. More... | |
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. More... | |
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. More... | |
static bool | isCylinder (const label id) |
Is obstacle type id cylinder-like? More... | |
static label | addPieces (vtk::surfaceWriter &surfWriter, const UList< PDRobstacle > &list, label pieceId=0) |
Add pieces to vtp output. More... | |
static void | generateVtk (const fileName &outputDir, const UList< PDRobstacle > &obslist, const UList< PDRobstacle > &cyllist) |
Generate multi-piece VTK (vtp) file of obstacles. More... | |
Public Attributes | |
label | groupId |
The group-id. More... | |
int | typeId |
The obstacle type-id. More... | |
direction | orient |
The x/y/z orientation (0,1,2) More... | |
scalar | sortBias |
Bias for position sorting. More... | |
point | pt |
The obstacle location. More... | |
vector | span |
The obstacle dimensions (for boxes) More... | |
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]. More... | |
Friends | |
Istream & | operator>> (Istream &is, PDRobstacle &obs) |
enum legacyTypes |
Obstacle types (legacy numbering)
Definition at line 77 of file PDRobstacle.H.
PDRobstacle | ( | ) |
Construct zero-initialized.
|
explicit |
Read construct as named dictionary.
|
inline |
Definition at line 144 of file PDRobstacle.H.
References PDRobstacle::span.
|
inline |
Definition at line 145 of file PDRobstacle.H.
References PDRobstacle::span, and Y.
|
inline |
Definition at line 146 of file PDRobstacle.H.
References PDRobstacle::span.
|
inline |
Definition at line 148 of file PDRobstacle.H.
References PDRobstacle::span.
|
inline |
Definition at line 149 of file PDRobstacle.H.
References PDRobstacle::span, and Y.
|
inline |
Definition at line 150 of file PDRobstacle.H.
References PDRobstacle::span.
declareMemberFunctionSelectionTable | ( | void | , |
PDRobstacle | , | ||
read | , | ||
dictionary | , | ||
(PDRobstacle &obs, const dictionary &dict) | , | ||
(obs, dict) | |||
) |
|
static |
Read obstacle files and add to the lists.
|
static |
Read obstacle files and set the lists.
bool read | ( | Istream & | is | ) |
Read name / dictionary.
void readProperties | ( | const dictionary & | dict | ) |
Read the 'name' identifier if present.
|
inline |
Obstacle position accessors.
Definition at line 255 of file PDRobstacle.H.
References PDRobstacle::pt.
|
inline |
Definition at line 256 of file PDRobstacle.H.
References PDRobstacle::pt.
|
inline |
Definition at line 257 of file PDRobstacle.H.
References PDRobstacle::pt.
|
inline |
Definition at line 258 of file PDRobstacle.H.
References PDRobstacle::pt.
|
inline |
Definition at line 259 of file PDRobstacle.H.
References PDRobstacle::pt.
|
inline |
Definition at line 260 of file PDRobstacle.H.
References PDRobstacle::pt.
|
inlinestatic |
Is obstacle type id cylinder-like?
Definition at line 23 of file PDRobstacleI.H.
References PDRobstacle::CYLINDER, and PDRobstacle::DIAG_BEAM.
|
inline |
Is obstacle cylinder-like?
Definition at line 33 of file PDRobstacleI.H.
void clear | ( | ) |
Reset to a zero obstacle.
void scale | ( | const scalar | factor | ) |
Scale obstacle dimensions by specified scaling factor.
Zero and negative factors are ignored
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.
The only input format, but termed 'legacy' since it may be replaced in the near future.
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
meshedSurface surface | ( | ) | const |
Surface (points, faces) representation.
|
static |
Add pieces to vtp output.
|
static |
Generate multi-piece VTK (vtp) file of obstacles.
|
inlinenoexcept |
Return info proxy, used to print information to a stream.
Definition at line 351 of file PDRobstacle.H.
|
friend |
|
static |
The max blowoff pressure [bar].
Primarily to catch accidental input in Pa or mbar
Definition at line 105 of file PDRobstacle.H.
label groupId |
The group-id.
Definition at line 113 of file PDRobstacle.H.
int typeId |
The obstacle type-id.
Definition at line 118 of file PDRobstacle.H.
direction orient |
The x/y/z orientation (0,1,2)
Definition at line 123 of file PDRobstacle.H.
scalar sortBias |
Bias for position sorting.
Definition at line 128 of file PDRobstacle.H.
point pt |
The obstacle location.
Lower corner for boxes, end-centre for cylinders
Definition at line 135 of file PDRobstacle.H.
Referenced by PDRobstacle::x(), PDRobstacle::y(), and PDRobstacle::z().
vector span |
The obstacle dimensions (for boxes)
Definition at line 140 of file PDRobstacle.H.
Referenced by PDRobstacle::dia(), PDRobstacle::len(), and PDRobstacle::theta().
scalar wa |
Definition at line 154 of file PDRobstacle.H.
scalar slat_width |
Definition at line 155 of file PDRobstacle.H.
scalar blowoff_press |
Definition at line 156 of file PDRobstacle.H.
union { ... } |
scalar wb |
Definition at line 160 of file PDRobstacle.H.
scalar blowoff_time |
Definition at line 161 of file PDRobstacle.H.
union { ... } |
scalar vbkge |
Definition at line 163 of file PDRobstacle.H.
scalar xbkge |
Definition at line 164 of file PDRobstacle.H.
scalar ybkge |
Definition at line 165 of file PDRobstacle.H.
scalar zbkge |
Definition at line 166 of file PDRobstacle.H.
int blowoff_type |
Definition at line 170 of file PDRobstacle.H.
int inlet_dirn |
Definition at line 171 of file PDRobstacle.H.
union { ... } |
string identifier |
Definition at line 174 of file PDRobstacle.H.