Public Member Functions | Static Public Member Functions | List of all members
faceShading Class Reference

Helper class to calculate visible faces for global, sun-like illumination. More...

Public Member Functions

 ClassName ("faceShading")
 
 faceShading (const fvMesh &mesh, const vector &dir)
 Construct from mesh and vector to 'sun'. All uncoupled patches. More...
 
 faceShading (const fvMesh &mesh, const labelList &patchIDs, const labelList &zoneIDs, const vector &dir)
 Construct from mesh and vector to 'sun' and selected patches. More...
 
 ~faceShading ()=default
 Destructor. More...
 
const vector direction () const
 Const access to direction. More...
 
vector & direction ()
 Non-const access to direction. More...
 
const labelList & rayStartFaces () const
 Const access to rayStartFaces. More...
 
void correct ()
 Recalculate rayStartFaces using direction vector. More...
 

Static Public Member Functions

static labelList nonCoupledPatches (const polyMesh &mesh)
 Helper: return all uncoupled patches. More...
 

Detailed Description

Helper class to calculate visible faces for global, sun-like illumination.

faceShading uses the transmissivity value in the boundaryRadiationProperties in order to evaluate which faces are "hit" by the "direction" vector. NOTE: Only transmissivity values of zero are considered for opaque walls.

Source files

Definition at line 57 of file faceShading.H.

Constructor & Destructor Documentation

◆ faceShading() [1/2]

faceShading ( const fvMesh &  mesh,
const vector &  dir 
)

Construct from mesh and vector to 'sun'. All uncoupled patches.

are checked for visibility. faceZones are ignored.

Definition at line 510 of file faceShading.C.

◆ faceShading() [2/2]

faceShading ( const fvMesh &  mesh,
const labelList &  patchIDs,
const labelList &  zoneIDs,
const vector &  dir 
)

Construct from mesh and vector to 'sun' and selected patches.

and faceZones.

Definition at line 526 of file faceShading.C.

◆ ~faceShading()

~faceShading ( )
default

Destructor.

Member Function Documentation

◆ ClassName()

ClassName ( "faceShading"  )

◆ nonCoupledPatches()

Foam::labelList nonCoupledPatches ( const polyMesh &  mesh)
static

Helper: return all uncoupled patches.

Definition at line 545 of file faceShading.C.

References DynamicList< T, SizeMin >::append(), polyMesh::boundaryMesh(), forAll, mesh, pbm, and pp().

Here is the call graph for this function:

◆ direction() [1/2]

const vector direction ( ) const
inline

Const access to direction.

Definition at line 206 of file faceShading.H.

◆ direction() [2/2]

vector& direction ( )
inline

Non-const access to direction.

Definition at line 214 of file faceShading.H.

◆ rayStartFaces()

const labelList& rayStartFaces ( ) const
inline

Const access to rayStartFaces.

Definition at line 222 of file faceShading.H.

◆ correct()

void correct ( )

Recalculate rayStartFaces using direction vector.

Definition at line 562 of file faceShading.C.

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