#include <RadiationFieldProbe.hpp>
Public Types | |
enum class | ProbeAfter : int { Run , Primary , Secondary } |
Public Member Functions | |
void | probe () override |
ProbeAfter | probeAfter () const |
bool | writeWavelengthGrid () const |
Public Member Functions inherited from SpatialGridFormProbe | |
Form * | form () const |
Public Member Functions inherited from Probe | |
string | itemName () const override |
int | iter () const |
string | probeName () const |
void | probePrimary (int iter) |
void | probeRun () |
void | probeSecondary (int iter) |
void | probeSetup () |
Public Member Functions inherited from SimulationItem | |
template<class T > | |
T * | find (bool setup=true) const |
template<class T > | |
T * | interface (int levels=-999999, bool setup=true) const |
virtual string | itemName () const |
void | setup () |
string | typeAndName () const |
Public Member Functions inherited from Item | |
Item (const Item &)=delete | |
virtual | ~Item () |
void | addChild (Item *child) |
const vector< Item * > & | children () const |
virtual void | clearItemListProperty (const PropertyDef *property) |
void | destroyChild (Item *child) |
virtual bool | getBoolProperty (const PropertyDef *property) const |
virtual vector< double > | getDoubleListProperty (const PropertyDef *property) const |
virtual double | getDoubleProperty (const PropertyDef *property) const |
virtual string | getEnumProperty (const PropertyDef *property) const |
virtual int | getIntProperty (const PropertyDef *property) const |
virtual vector< Item * > | getItemListProperty (const PropertyDef *property) const |
virtual Item * | getItemProperty (const PropertyDef *property) const |
virtual string | getStringProperty (const PropertyDef *property) const |
int | getUtilityProperty (string name) const |
virtual void | insertIntoItemListProperty (const PropertyDef *property, int index, Item *item) |
Item & | operator= (const Item &)=delete |
Item * | parent () const |
virtual void | removeFromItemListProperty (const PropertyDef *property, int index) |
virtual void | setBoolProperty (const PropertyDef *property, bool value) |
virtual void | setDoubleListProperty (const PropertyDef *property, vector< double > value) |
virtual void | setDoubleProperty (const PropertyDef *property, double value) |
virtual void | setEnumProperty (const PropertyDef *property, string value) |
virtual void | setIntProperty (const PropertyDef *property, int value) |
virtual void | setItemProperty (const PropertyDef *property, Item *item) |
virtual void | setStringProperty (const PropertyDef *property, string value) |
void | setUtilityProperty (string name, int value) |
virtual string | type () const |
Protected Member Functions | |
RadiationFieldProbe () | |
When | when () const override |
Protected Member Functions inherited from SpatialGridFormProbe | |
SpatialGridFormProbe () | |
Protected Member Functions inherited from Probe | |
Probe () | |
virtual void | initialize () |
virtual void | probe ()=0 |
virtual When | when () const |
Protected Member Functions inherited from SimulationItem | |
SimulationItem () | |
virtual bool | offersInterface (const std::type_info &interfaceTypeInfo) const |
virtual void | setupSelfAfter () |
virtual void | setupSelfBefore () |
Protected Member Functions inherited from Item | |
Item () | |
Private Types | |
using | BaseType = SpatialGridFormProbe |
using | ItemType = RadiationFieldProbe |
Private Attributes | |
ProbeAfter | _probeAfter |
bool | _writeWavelengthGrid |
Friends | |
class | ItemRegistry |
Additional Inherited Members | |
Protected Types inherited from Probe | |
enum class | When { Setup , Run , Primary , Secondary } |
RadiationFieldProbe probes the mean radiation field intensity as calculated by the simulation and discretized on the spatial grid of the simulation. The probe outputs a compound quantity, \(J_\ell\), with \(\ell=1 \ldots N_\mathrm{rf}\), i.e. a value for each of the wavelength bins in the radiation field wavelength grid configured for the simulation. The spectral flavor and ordering of the components and the output units conform to the wavelengthOutputStyle, fluxOutputStyle, and unit system configured for the simulation.
The probe can be used with any Form subclass. When associated with a form that projects the quantity along a path, the value is density-weighted.
The probe offers an option to output a separate text column file with details on the radiation field wavelength grid. For each wavelength bin, the file lists the characteristic wavelength, the wavelength bin width, and the left and right borders of the bin.
This item type is displayed only if the Boolean expression "Level2&SpatialGrid&RadiationField" evaluates to true after replacing the names by true or false depending on their presence.
|
strong |
The enumeration type indicating when probing occurs.
Run : "after the complete simulation run" .
Primary : "after each iteration over primary emission" .
Secondary : "after each iteration over secondary emission" .
|
inlineprotected |
Default constructor for concrete Item subclass RadiationFieldProbe : "internal spatial grid: the mean radiation field intensity" .
|
overridevirtual |
This function performs probing.
Implements Probe.
|
inline |
This function returns the value of the discoverable ProbeAfter enumeration property probeAfter : "perform the probe after" .
The default value for this property is given by the conditional value expression "Run" .
This property is displayed only if the Boolean expression "DynamicState|IterateSecondary" evaluates to true after replacing the names by true or false depending on their presence.
|
overrideprotectedvirtual |
This function returns an enumeration indicating when probing for this probe should be performed corresponding to the configured value of the probeAfter property.
Reimplemented from Probe.
|
inline |
This function returns the value of the discoverable Boolean property writeWavelengthGrid : "output a text file with the radiation field wavelength grid" .
The default value for this property is given by the conditional value expression "false" .