OpenLB 1.7
Loading...
Searching...
No Matches
Public Member Functions | List of all members
olb::LightSourceCylindrical3D< T, S, DESCRIPTOR > Class Template Reference

light source as a cylinder along z-axis More...

#include <analyticalF.h>

+ Inheritance diagram for olb::LightSourceCylindrical3D< T, S, DESCRIPTOR >:
+ Collaboration diagram for olb::LightSourceCylindrical3D< T, S, DESCRIPTOR >:

Public Member Functions

 LightSourceCylindrical3D (RadiativeUnitConverter< T, DESCRIPTOR > const &converter, Vector< T, 3 > center={T(0), T(0), T(0)})
 
bool operator() (T output[1], const S x[3]) override
 
- Public Member Functions inherited from olb::AnalyticalF< D, T, S >
AnalyticalF< D, T, S > & operator- (AnalyticalF< D, T, S > &rhs)
 
AnalyticalF< D, T, S > & operator+ (AnalyticalF< D, T, S > &rhs)
 
AnalyticalF< D, T, S > & operator* (AnalyticalF< D, T, S > &rhs)
 
AnalyticalF< D, T, S > & operator/ (AnalyticalF< D, T, S > &rhs)
 
- Public Member Functions inherited from olb::GenericF< T, S >
virtual ~GenericF ()=default
 
int getSourceDim () const
 read only access to member variable _m
 
int getTargetDim () const
 read only access to member variable _n
 
std::string & getName ()
 read and write access to name
 
std::string const & getName () const
 read only access to name
 
virtual bool operator() (T output[], const S input[])=0
 has to be implemented for 'every' derived class
 
bool operator() (T output[])
 wrapper that call the pure virtual operator() (T output[], const S input[]) from above
 
bool operator() (T output[], S input0)
 
bool operator() (T output[], S input0, S input1)
 
bool operator() (T output[], S input0, S input1, S input2)
 
bool operator() (T output[], S input0, S input1, S input2, S input3)
 

Additional Inherited Members

- Public Types inherited from olb::AnalyticalF< D, T, S >
using identity_functor_type = AnalyticalIdentity<D,T,S>
 
- Public Types inherited from olb::GenericF< T, S >
using targetType = T
 
using sourceType = S
 
- Public Attributes inherited from olb::GenericF< T, S >
std::shared_ptr< GenericF< T, S > > _ptrCalcC
 memory management, frees resouces (calcClass)
 
- Static Public Attributes inherited from olb::AnalyticalF< D, T, S >
static constexpr unsigned dim = D
 
- Protected Member Functions inherited from olb::AnalyticalF< D, T, S >
 AnalyticalF (int n)
 
- Protected Member Functions inherited from olb::GenericF< T, S >
 GenericF (int targetDim, int sourceDim)
 

Detailed Description

template<typename T, typename S, typename DESCRIPTOR>
class olb::LightSourceCylindrical3D< T, S, DESCRIPTOR >

light source as a cylinder along z-axis

Definition at line 568 of file analyticalF.h.

Constructor & Destructor Documentation

◆ LightSourceCylindrical3D()

template<typename T , typename S , typename DESCRIPTOR >
olb::LightSourceCylindrical3D< T, S, DESCRIPTOR >::LightSourceCylindrical3D ( RadiativeUnitConverter< T, DESCRIPTOR > const & converter,
Vector< T, 3 > center = {T(0), T(0), T(0)} )

Definition at line 653 of file analyticalF.hh.

654 : AnalyticalF3D<T,S>(1),
655 _physSigmaEff(util::sqrt( converter.getPhysAbsorption() / converter.getPhysDiffusion() )),
656 _physDiffusionCoefficient(converter.getPhysDiffusion()),
657 _center(center)
658{
659 this->getName() = "LightSourceCylindrical3D";
660}
std::string & getName()
read and write access to name
Definition genericF.hh:51
cpu::simd::Pack< T > sqrt(cpu::simd::Pack< T > value)
Definition pack.h:100

References olb::GenericF< T, S >::getName().

+ Here is the call graph for this function:

Member Function Documentation

◆ operator()()

template<typename T , typename S , typename DESCRIPTOR >
bool olb::LightSourceCylindrical3D< T, S, DESCRIPTOR >::operator() ( T output[1],
const S x[3] )
override

Definition at line 663 of file analyticalF.hh.

664{
665 double r = util::sqrt( (x[0]-_center[0])*(x[0]-_center[0]) + (x[1]-_center[1])*(x[1]-_center[1]) );
666 if ( util::nearZero(r) ) {
667 std::cout << "Warning: evaluation of \"LightSourceCylindrical3D\" functor close to singularity." << std::endl;
668 }
669 output[0] = 1. / (4.0*M_PI*_physDiffusionCoefficient*r) *util::exp(-_physSigmaEff * r);
670 return true;
671}
#define M_PI
bool nearZero(const ADf< T, DIM > &a)
Definition aDiff.h:1087
ADf< T, DIM > exp(const ADf< T, DIM > &a)
Definition aDiff.h:455

References olb::util::exp(), M_PI, olb::util::nearZero(), and olb::util::sqrt().

+ Here is the call graph for this function:

The documentation for this class was generated from the following files: