Celeritas 0.7.0-dev.127+develop.e63889793
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
celeritas::optical::SurfaceInteraction Struct Reference

Result of a surface physics interaction. More...

#include <SurfaceInteraction.hh>

Public Types

enum class  Action { absorbed , reflected , refracted }
 Interaction result category.
 

Public Member Functions

CELER_FUNCTION bool is_valid () const
 Whether data is assigned and valid.
 

Static Public Member Functions

static CELER_FUNCTION SurfaceInteraction from_absorption ()
 Return an interaction representing an absorbed photon.
 

Public Attributes

Action action {Action::absorbed}
 Flags for interaction result.
 
Real3 direction
 
Real3 polarization
 

Detailed Description

Result of a surface physics interaction.

Member Function Documentation

◆ from_absorption()

CELER_FUNCTION SurfaceInteraction celeritas::optical::SurfaceInteraction::from_absorption ( )
inlinestatic

Return an interaction representing an absorbed photon.

Construct a surface interaction for an optical photon absorbed on the surface.


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