stator
A math, geometry, and utility library
Static Public Member Functions | List of all members
stator::constant< Scalar, typename > Struct Template Reference

Physical constants in different floating point representations. More...

#include <constants.hpp>

Static Public Member Functions

static Scalar avogadro ()
 Avogadro's constant $N_A$. More...
 
static Scalar e ()
 The base of the natural logarithm $e$. More...
 
static Scalar k ()
 Boltzmann's constant $k_B$. More...
 
static Scalar pi ()
 $\pi$. More...
 
static Scalar R ()
 The universal gas constant $R$. More...
 

Detailed Description

template<typename Scalar, typename = typename std::is_floating_point<Scalar>::type>
struct stator::constant< Scalar, typename >

This overload is for floating point types. The physical constants are taken from the CODATA 2010 recommended values. These are listed here: http://physics.nist.gov/cuu/index.html

Template Parameters
ScalarThe representation to return the physical constants in.

Definition at line 40 of file constants.hpp.

Member Function Documentation

◆ avogadro()

template<typename Scalar , typename = typename std::is_floating_point<Scalar>::type>
static Scalar stator::constant< Scalar, typename >::avogadro ( )
inlinestatic

Definition at line 53 of file constants.hpp.

◆ e()

template<typename Scalar , typename = typename std::is_floating_point<Scalar>::type>
static Scalar stator::constant< Scalar, typename >::e ( )
inlinestatic

Definition at line 63 of file constants.hpp.

◆ k()

template<typename Scalar , typename = typename std::is_floating_point<Scalar>::type>
static Scalar stator::constant< Scalar, typename >::k ( )
inlinestatic

Definition at line 43 of file constants.hpp.

◆ pi()

template<typename Scalar , typename = typename std::is_floating_point<Scalar>::type>
static Scalar stator::constant< Scalar, typename >::pi ( )
inlinestatic

Definition at line 48 of file constants.hpp.

◆ R()

template<typename Scalar , typename = typename std::is_floating_point<Scalar>::type>
static Scalar stator::constant< Scalar, typename >::R ( )
inlinestatic

Definition at line 58 of file constants.hpp.


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