grating Struct Reference

A grating, selectable as grate or grating. More...

Inheritance diagram for grating:
[legend]
Collaboration diagram for grating:
[legend]

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. 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...
 

Static Public Attributes

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

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. 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)
 
meshedSurface surface () const
 Surface (points, faces) representation. More...
 
InfoProxy< PDRobstacleinfo () const
 Return info proxy. More...
 
- Public Attributes inherited from PDRobstacle
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
 

Detailed Description

A grating, selectable as grate or grating.

The dimensions must include one component that is zero, which establishes the orientation.

Dictionary controls

Property Description Required Default
point The lower left corner yes
size The (x y z) dimensions yes
slats The slat width no 0

Example,

grating
{
     point       (0 0 0);
     size        (0.1 0.1 0);
     slats       0.005;
}

Definition at line 332 of file PDRobstacleTypes.H.

Member Function Documentation

◆ read()

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

Member Data Documentation

◆ enumTypeId

constexpr int enumTypeId = legacyTypes::GRATING
staticconstexpr

Definition at line 334 of file PDRobstacleTypes.H.


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