Auxiliary data structure to customize scattering probability.
More...
#include <JPDFSupportkit.hh>
|
| static constexpr const char *const | default_t = "default" |
| |
| static constexpr const char *const | f4_t = "f4" |
| |
| static constexpr const char *const | p00075_t = "p00075" |
| |
| static constexpr const char *const | petzhold_t = "petzhold" |
| |
Auxiliary data structure to customize scattering probability.
Definition at line 282 of file JPDFSupportkit.hh.
◆ JScatteringProbability()
| JPHYSICS::JScatteringProbability::JScatteringProbability |
( |
| ) |
|
|
inline |
Default constructor.
Definition at line 294 of file JPDFSupportkit.hh.
295 {
300
303 }
double p00075(const double x)
Model specific function to describe light scattering in water (p00075).
double petzhold(const double x)
Model specific function to describe light scattering in water (Petzhold).
double f4(const double x)
Model specific function to describe light scattering in water (f4).
double getScatteringProbability(const double x)
static constexpr const char *const default_t
static constexpr const char *const p00075_t
static double & get_weight()
Get reference to weight.
static constexpr const char *const petzhold_t
static constexpr const char *const f4_t
static mapped_type & get_function()
Get reference to global functon.
◆ getScatteringProbability()
| static double JPHYSICS::JScatteringProbability::getScatteringProbability |
( |
const double | x | ) |
|
|
inlinestatic |
Get scattering probability.
- Parameters
-
- Returns
- probability
Definition at line 351 of file JPDFSupportkit.hh.
352 {
354 }
double rayleigh(const double a, const double x)
Auxiliary method to describe light scattering in water (Rayleigh).
◆ get_weight()
| static double & JPHYSICS::JScatteringProbability::get_weight |
( |
| ) |
|
|
inlinestatic |
Get reference to weight.
- Returns
- weight
Definition at line 362 of file JPDFSupportkit.hh.
363 {
364 static double weight = 1.0;
365
366 return weight;
367 }
◆ get_function()
| static mapped_type & JPHYSICS::JScatteringProbability::get_function |
( |
| ) |
|
|
inlinestatic |
Get reference to global functon.
- Returns
- function
Definition at line 375 of file JPDFSupportkit.hh.
376 {
378
379 return f1;
380 }
◆ operator>>
Read scattering probability from input stream.
- Parameters
-
| in | input stream |
| object | scattering probability |
- Returns
- input stream
Definition at line 313 of file JPDFSupportkit.hh.
314 {
316
318
319 JScatteringProbability::const_iterator p = object.find(option);
320
321 if (p != object.end())
323 else
324 in.setstate(ios_base::badbit);
325 }
326
327 return in;
328 }
◆ operator<<
Write scattering probability to output stream.
- Parameters
-
| out | output stream |
| object | scattering probability |
- Returns
- output stream
Definition at line 338 of file JPDFSupportkit.hh.
339 {
342 }
std::string getKey(const std::map< std::string, T > &map, const std::string &key, const T &value)
Auxiliary method to get preferred key for given value.
◆ default_t
| const char* const JPHYSICS::JScatteringProbability::default_t = "default" |
|
staticconstexpr |
◆ f4_t
| const char* const JPHYSICS::JScatteringProbability::f4_t = "f4" |
|
staticconstexpr |
◆ p00075_t
| const char* const JPHYSICS::JScatteringProbability::p00075_t = "p00075" |
|
staticconstexpr |
◆ petzhold_t
| const char* const JPHYSICS::JScatteringProbability::petzhold_t = "petzhold" |
|
staticconstexpr |
The documentation for this struct was generated from the following file: