JPHYSICS::JAbsorptionLength Struct Reference

Auxiliary data structure to customize absorption length. More...

#include <JPDFSupportkit.hh>

Inheritance diagram for JPHYSICS::JAbsorptionLength:

Public Types
typedef double(*)	pF(const double)

Public Member Functions
	JAbsorptionLength ()
	Default constructor.

Static Public Member Functions
static double	getAbsorptionLength (const double lambda)
	Get absorption length.
static double &	get_factor ()
	Get reference to multiplication factor.
static double &	get_offset ()
	Get reference to offset.
static pF &	get_function ()
	Get reference to global functon.

Friends
std::istream &	operator>> (std::istream &in, JAbsorptionLength &absorption)
	Read absorption length from input stream.
std::ostream &	operator<< (std::ostream &out, const JAbsorptionLength &absorption)
	Write absorption length to output stream.

Detailed Description

Auxiliary data structure to customize absorption length.

Definition at line 39 of file JPDFSupportkit.hh.

Member Typedef Documentation

pF

double(*) JPHYSICS::JAbsorptionLength_t::pF(const double)

inherited

Definition at line 32 of file JPDFSupportkit.hh.

Constructor & Destructor Documentation

JAbsorptionLength()

JPHYSICS::JAbsorptionLength::JAbsorptionLength ( )

inline

Default constructor.

Definition at line 46 of file JPDFSupportkit.hh.

    {
      (*this)["default"]        =  NAMESPACE::getAbsorptionLength;
      (*this)["SmithAndBaker"]  =  getAbsorptionLengthSmithAndBaker;
    }

Member Function Documentation

getAbsorptionLength()

static double JPHYSICS::JAbsorptionLength::getAbsorptionLength ( const double lambda )

inlinestatic

Get absorption length.

Parameters

lambda

wavelength of light [nm]

Returns

absorption length [m]

Definition at line 103 of file JPDFSupportkit.hh.

    {
      const double y = 1.0 / (get_factor() * (*get_function())(lambda))  +  1.0 / get_offset();
 
      return 1.0 / y;
    }

get_factor()

static double & JPHYSICS::JAbsorptionLength::get_factor ( )

inlinestatic

Get reference to multiplication factor.

Returns

factor

Definition at line 116 of file JPDFSupportkit.hh.

    {
      static double factor = 1.0;
 
      return factor;
    }

get_offset()

static double & JPHYSICS::JAbsorptionLength::get_offset ( )

inlinestatic

Get reference to offset.

Returns

offset

Definition at line 129 of file JPDFSupportkit.hh.

    {
      static double offset = 1.0e6;
 
      return offset;
    }

get_function()

static pF & JPHYSICS::JAbsorptionLength::get_function ( )

inlinestatic

Get reference to global functon.

Returns

function

Definition at line 142 of file JPDFSupportkit.hh.

    {
      static pF f1 = NAMESPACE::getAbsorptionLength;
 
      return f1;
    }

Friends And Related Symbol Documentation

operator>>

std::istream & operator>> ( std::istream & in, JAbsorptionLength & absorption )

friend

Read absorption length from input stream.

Parameters

in	input stream
absorption	absorption length

Returns

input stream

Definition at line 60 of file JPDFSupportkit.hh.

    {
      using namespace std;
 
      for (string option; in >> option >> JAbsorptionLength::get_factor() >> JAbsorptionLength::get_offset(); ) {
 
        JAbsorptionLength::const_iterator p = absorption.find(option);
 
        if (p != absorption.end())
          JAbsorptionLength::get_function() = p->second;
        else
          in.setstate(ios_base::badbit);
      }
 
      return in;
    }

operator<<

std::ostream & operator<< ( std::ostream & out, const JAbsorptionLength & absorption )

friend

Write absorption length to output stream.

Parameters

out	output stream
absorption	absorption length

Returns

output stream

Definition at line 85 of file JPDFSupportkit.hh.

    {
      for (const_iterator i = absorption.begin(); i != absorption.end(); ++i) {
        if (i->second == JAbsorptionLength::get_function()) {
          out << i->first << ' ';
        }
      }
      
      return out << JAbsorptionLength::get_factor() << ' ' << JAbsorptionLength::get_offset();
    }

---

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

• JPDFSupportkit.hh