#include <ConvergenceInfoProbe.hpp>
Protected Member Functions | |
ConvergenceInfoProbe () | |
void | probe () override |
Protected Member Functions inherited from SpecialtyWavelengthProbe | |
SpecialtyWavelengthProbe () | |
Protected Member Functions inherited from SpecialtyWhenProbe | |
SpecialtyWhenProbe () | |
When | when () const override |
Protected Member Functions inherited from SpecialtyProbe | |
SpecialtyProbe () | |
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 () | |
Protected Member Functions inherited from MaterialWavelengthRangeInterface | |
MaterialWavelengthRangeInterface () | |
Protected Member Functions inherited from WavelengthRangeInterface | |
WavelengthRangeInterface () | |
Private Types | |
using | BaseType = SpecialtyWavelengthProbe |
using | ItemType = ConvergenceInfoProbe |
Friends | |
class | ItemRegistry |
Additional Inherited Members | |
Public Types inherited from SpecialtyWhenProbe | |
enum class | ProbeAfter : int { Setup , Run } |
Public Member Functions inherited from SpecialtyWavelengthProbe | |
double | wavelength () const |
Range | wavelengthRange () const override |
Public Member Functions inherited from SpecialtyWhenProbe | |
ProbeAfter | probeAfter () 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 |
Public Member Functions inherited from MaterialWavelengthRangeInterface | |
virtual WavelengthGrid * | materialWavelengthGrid () const |
Public Member Functions inherited from WavelengthRangeInterface | |
virtual | ~WavelengthRangeInterface () |
virtual Range | wavelengthRange () const =0 |
Protected Types inherited from Probe | |
enum class | When { Setup , Run , Primary , Secondary } |
ConvergenceInfoProbe outputs a text file named prefix_probe_convergence.dat
with convergence information on the spatial grid for each material type in the medium system. The file is formatted for human consumption (not in column text format) and is intended as a basic sanity check on the configuration of the simulation.
For each material type, the file lists the total mass and the optical depth along the major coordinate axes at a given wavelength. These numbers can be compared to the values expected for the model.
Furthermore, in each case, the file provides the value as represented by the input model defined by the media system, and also the grid-discretized value as obtained from the finite-resolution spatial grid in the simulation. A comparison of both sets of values offers a first indication of whether the configured spatial grid properly captures the material mass in the simulation (in the ideal case, there would be no difference between both sets of values).
Finally, the file includes some basic statistics on the diagonal optical depths of the spatial grid cells: the largest and average diagonal optical depth, and the 90% percentile.
This item type is displayed only if the Boolean expression "Medium&SpatialGrid" evaluates to true after replacing the names by true or false depending on their presence.
|
inlineprotected |
Default constructor for concrete Item subclass ConvergenceInfoProbe : "convergence: information on the spatial grid" .
|
overrideprotectedvirtual |
This function performs probing.
Implements Probe.