Conversion between physical and lattice units, as well as discretization. More...

#include <radiativeUnitConverter.h>

Inheritance diagram for olb::RadiativeUnitConverter< T, DESCRIPTOR >:

Collaboration diagram for olb::RadiativeUnitConverter< T, DESCRIPTOR >:

Public Member Functions
constexpr	RadiativeUnitConverter (int resolution, T latticeRelaxationTime, T physAbsorption, T physScattering, T anisotropyFactor=0, T charPhysLength=1, T refractiveMedia=1, T refractiveAmbient=1)
	Documentation of constructor:

constexpr T	getPhysAbsorption () const

constexpr T	getPhysScattering () const

constexpr T	getAnisotropyFactor () const

constexpr T	getExtinction () const

constexpr T	getScatteringAlbedo () const

constexpr T	getPhysDiffusion () const

constexpr T	getEffectiveAttenuation () const

constexpr T	getLatticeAbsorption () const

constexpr T	getLatticeScattering () const

constexpr T	getLatticeDiffusion () const

constexpr T	getRefractiveRelative () const

void	print () const override
	nice terminal output for conversion factors, characteristical and physical data

void	print (std::ostream &fout) const

void	write () const

Public Member Functions inherited from olb::UnitConverterFromResolutionAndRelaxationTime< T, DESCRIPTOR >
constexpr	UnitConverterFromResolutionAndRelaxationTime (size_t resolution, T latticeRelaxationTime, T charPhysLength, T charPhysVelocity, T physViscosity, T physDensity, T charPhysPressure=0)

Public Member Functions inherited from olb::UnitConverter< T, DESCRIPTOR >
constexpr	UnitConverter (T physDeltaX, T physDeltaT, T charPhysLength, T charPhysVelocity, T physViscosity, T physDensity, T charPhysPressure=0)
	Documentation of constructor:

virtual	~UnitConverter ()=default

constexpr int	getResolution () const
	return resolution

constexpr T	getLatticeRelaxationTime () const
	return relaxation time in lattice units

constexpr T	getLatticeRelaxationFrequency () const
	return relaxation frequency in lattice units

template<typename DESCRIPTOR_ >
constexpr T	getLatticeRelaxationFrequencyFromDiffusivity (const T physDiffusivity) const
	return relaxation frequency in lattice units computed from given physical diffusivity in m^2 / s

constexpr T	getCharPhysLength () const
	return characteristic length in physical units

constexpr T	getCharPhysVelocity () const
	return characteristic velocity in physical units

constexpr T	getCharLatticeVelocity () const
	return characteristic velocity in lattice units

constexpr T	getPhysViscosity () const
	return viscosity in physical units

constexpr T	getPhysDensity () const
	return density in physical units

constexpr T	getCharPhysPressure () const
	return characteristic pressure in physical units

constexpr T	getReynoldsNumber () const
	return Reynolds number

constexpr T	getMachNumber () const
	return Mach number

constexpr T	getKnudsenNumber () const
	return Knudsen number

constexpr T	getPhysLength (int latticeLength) const
	conversion from lattice to physical length

constexpr int	getLatticeLength (T physLength) const
	conversion from physical to lattice length, returns number of voxels for given physical length

constexpr T	getConversionFactorLength () const
	access (read-only) to private member variable

constexpr T	getPhysDeltaX () const
	returns grid spacing (voxel length) in m

constexpr T	getPhysTime (size_t latticeTime) const
	conversion from lattice to physical time

constexpr size_t	getLatticeTime (T physTime) const
	conversion from physical to lattice time

constexpr T	getConversionFactorTime () const
	access (read-only) to private member variable

constexpr T	getPhysDeltaT () const
	returns time spacing (timestep length) in s

constexpr T	getPhysVelocity (T latticeVelocity) const
	conversion from lattice to physical velocity

constexpr T	getLatticeVelocity (T physVelocity) const
	conversion from physical to lattice velocity

constexpr T	getConversionFactorVelocity () const
	access (read-only) to private member variable

constexpr T	getPhysDensity (T latticeDensity) const
	conversion from lattice to physical density

constexpr T	getLatticeDensity (T physDensity) const
	conversion from physical to lattice density

constexpr T	getLatticeDensityFromPhysPressure (T physPressure) const

constexpr T	getConversionFactorDensity () const
	access (read-only) to private member variable

constexpr T	getPhysMass (T latticeMass) const
	conversion from lattice to physical mass

constexpr T	getLatticeMass (T physMass) const
	conversion from physical to lattice mass

constexpr T	getConversionFactorMass () const
	access (read-only) to private member variable

constexpr T	getPhysViscosity (T latticeViscosity) const
	conversion from lattice to physical viscosity

constexpr T	getLatticeViscosity () const
	conversion from physical to lattice viscosity

constexpr T	getConversionFactorViscosity () const
	access (read-only) to private member variable

constexpr T	getPhysForce (T latticeForce) const
	conversion from lattice to physical force

constexpr T	getLatticeForce (T physForce) const
	conversion from physical to lattice force

constexpr T	getConversionFactorForce () const
	access (read-only) to private member variable

constexpr T	getPhysTorque (T latticeTorque) const
	conversion from lattice to physical torque

constexpr T	getLatticeTorque (T physTorque) const
	conversion from physical to lattice torque

constexpr T	getConversionFactorTorque () const
	access (read-only) to private member variable

constexpr T	getPhysPressure (T latticePressure) const
	conversion from lattice to physical pressure

constexpr T	getLatticePressure (T physPressure) const
	conversion from physical to lattice pressure

constexpr T	getConversionFactorPressure () const
	access (read-only) to private member variable

void	print (std::ostream &fout) const

void	write (std::string const &fileName="unitConverter") const

Public Member Functions inherited from olb::UnitConverterBase
virtual	~UnitConverterBase ()=default

Additional Inherited Members
Protected Attributes inherited from olb::UnitConverter< T, DESCRIPTOR >
const T	_conversionLength

const T	_conversionTime

const T	_conversionVelocity

const T	_conversionDensity

const T	_conversionMass

const T	_conversionViscosity

const T	_conversionForce

const T	_conversionTorque

const T	_conversionPressure

const T	_charPhysLength

const T	_charPhysVelocity

const T	_physViscosity

const T	_physDensity

const T	_charPhysPressure

const size_t	_resolution

const T	_latticeRelaxationTime

const T	_charLatticeVelocity

Detailed Description

template<typename T, typename DESCRIPTOR>
class olb::RadiativeUnitConverter< T, DESCRIPTOR >

Conversion between physical and lattice units, as well as discretization.

Be aware of the nomenclature: We distingish between physical (dimensioned) and lattice (dimensionless) values. A specific conversion factor maps the two different scopes, e.g. physLength = conversionLength * latticeLength

Definition at line 75 of file radiativeUnitConverter.h.

Constructor & Destructor Documentation

◆ RadiativeUnitConverter()

template<typename T , typename DESCRIPTOR >

constexpr olb::RadiativeUnitConverter< T, DESCRIPTOR >::RadiativeUnitConverter	(	int	resolution,
		T	latticeRelaxationTime,
		T	physAbsorption,
		T	physScattering,
		T	anisotropyFactor = 0,
		T	charPhysLength = 1,
		T	refractiveMedia = 1,
		T	refractiveAmbient = 1 )

inlineconstexpr

Documentation of constructor:

Parameters

resolution	is number of voxel per 1 meter
latticeRelaxationTime	see class UnitConverterFromResolutionAndRelaxationTime
physAbsorption	physical absorption in 1/meter
physScattering	physical scattering in 1/meter

Definition at line 83 of file radiativeUnitConverter.h.

    : UnitConverterFromResolutionAndRelaxationTime<T, DESCRIPTOR>( resolution, latticeRelaxationTime, charPhysLength, /*visc*/ 1./(3*(physAbsorption+physScattering)), T(1), T(1) ),
      clout(std::cout, "RadiativeUnitConverter"),
      _physAbsorption(physAbsorption),
      _physScattering(physScattering),
      _anisotropyFactor(anisotropyFactor),
      _extinction( physAbsorption+physScattering ),
      _scatteringAlbedo( physScattering/(physAbsorption+physScattering) ),
      _physDiffusion( 1.0 / (3.0*(physAbsorption+physScattering)) ),
      _effectiveAttenuation( util::sqrt(3*physAbsorption*(physAbsorption+physScattering)) ),
      _refractiveRelative(refractiveMedia/refractiveAmbient),
      _latticeAbsorption( physAbsorption*this->getConversionFactorLength() ),
      _latticeScattering( physScattering*this->getConversionFactorLength() ),
      _latticeDiffusion(_physDiffusion/this->getConversionFactorLength())
  { };

Member Function Documentation

◆ getAnisotropyFactor()

template<typename T , typename DESCRIPTOR >

constexpr T olb::RadiativeUnitConverter< T, DESCRIPTOR >::getAnisotropyFactor ( ) const

inlineconstexpr

Definition at line 109 of file radiativeUnitConverter.h.

  {
    return _anisotropyFactor;
  };

◆ getEffectiveAttenuation()

template<typename T , typename DESCRIPTOR >

constexpr T olb::RadiativeUnitConverter< T, DESCRIPTOR >::getEffectiveAttenuation ( ) const

inlineconstexpr

Definition at line 129 of file radiativeUnitConverter.h.

  {
    return _effectiveAttenuation;
  };

◆ getExtinction()

template<typename T , typename DESCRIPTOR >

constexpr T olb::RadiativeUnitConverter< T, DESCRIPTOR >::getExtinction ( ) const

inlineconstexpr

Definition at line 114 of file radiativeUnitConverter.h.

  {
    return _extinction;
  };

◆ getLatticeAbsorption()

template<typename T , typename DESCRIPTOR >

constexpr T olb::RadiativeUnitConverter< T, DESCRIPTOR >::getLatticeAbsorption ( ) const

inlineconstexpr

Definition at line 134 of file radiativeUnitConverter.h.

  {
    return _latticeAbsorption;
  };

◆ getLatticeDiffusion()

template<typename T , typename DESCRIPTOR >

constexpr T olb::RadiativeUnitConverter< T, DESCRIPTOR >::getLatticeDiffusion ( ) const

inlineconstexpr

Definition at line 144 of file radiativeUnitConverter.h.

  {
    return _latticeDiffusion;
  };

Here is the caller graph for this function:

◆ getLatticeScattering()

template<typename T , typename DESCRIPTOR >

constexpr T olb::RadiativeUnitConverter< T, DESCRIPTOR >::getLatticeScattering ( ) const

inlineconstexpr

Definition at line 139 of file radiativeUnitConverter.h.

  {
    return _latticeScattering;
  };

◆ getPhysAbsorption()

template<typename T , typename DESCRIPTOR >

constexpr T olb::RadiativeUnitConverter< T, DESCRIPTOR >::getPhysAbsorption ( ) const

inlineconstexpr

Definition at line 99 of file radiativeUnitConverter.h.

  {
    return _physAbsorption;
  };

◆ getPhysDiffusion()

template<typename T , typename DESCRIPTOR >

constexpr T olb::RadiativeUnitConverter< T, DESCRIPTOR >::getPhysDiffusion ( ) const

inlineconstexpr

Definition at line 124 of file radiativeUnitConverter.h.

  {
    return _physDiffusion;
  };

◆ getPhysScattering()

template<typename T , typename DESCRIPTOR >

constexpr T olb::RadiativeUnitConverter< T, DESCRIPTOR >::getPhysScattering ( ) const

inlineconstexpr

Definition at line 104 of file radiativeUnitConverter.h.

  {
    return _physScattering;
  };

◆ getRefractiveRelative()

template<typename T , typename DESCRIPTOR >

constexpr T olb::RadiativeUnitConverter< T, DESCRIPTOR >::getRefractiveRelative ( ) const

inlineconstexpr

Definition at line 149 of file radiativeUnitConverter.h.

  {
    return _refractiveRelative;
  };

Here is the caller graph for this function:

◆ getScatteringAlbedo()

template<typename T , typename DESCRIPTOR >

constexpr T olb::RadiativeUnitConverter< T, DESCRIPTOR >::getScatteringAlbedo ( ) const

inlineconstexpr

Definition at line 119 of file radiativeUnitConverter.h.

  {
    return _scatteringAlbedo;
  };

◆ print() [1/2]

template<typename T , class DESCRIPTOR >

void olb::RadiativeUnitConverter< T, DESCRIPTOR >::print ( ) const

overridevirtual

nice terminal output for conversion factors, characteristical and physical data

Reimplemented from olb::UnitConverter< T, DESCRIPTOR >.

Definition at line 211 of file radiativeUnitConverter.h.

{
  print(clout);
}

◆ print() [2/2]

template<typename T , class DESCRIPTOR >

void olb::RadiativeUnitConverter< T, DESCRIPTOR >::print ( std::ostream & fout ) const

virtual

Implements olb::UnitConverterBase.

Definition at line 177 of file radiativeUnitConverter.h.

{
  clout << "----------------- UnitConverter information -----------------" << std::endl;
  clout << "-- Parameters:" << std::endl;
  clout << "Resolution:                       N=              " << this->getResolution() << std::endl;
  clout << "Lattice relaxation frequency:     omega=          " << this->getLatticeRelaxationFrequency() << std::endl;
  clout << "Lattice relaxation time:          tau=            " << this->getLatticeRelaxationTime() << std::endl;
  clout << "Characteristical length(m):       charL=          " << this->getCharPhysLength() << std::endl;
  clout << "Phys. density(kg/m^d):            charRho=        " << this->getPhysDensity() << std::endl;
  clout << "Phys. absorption(1/m):            mu_a=           " << getPhysAbsorption() << std::endl;
  clout << "Phys. scattering(1/m):            mu_s=           " << getPhysScattering() << std::endl;
  clout << "Extinction(1/m):                  mu_t=           " << getExtinction() << std::endl;
  clout << "Effective attenuation(1/m):       mu_eff=         " << getEffectiveAttenuation() << std::endl;
  clout << "Phys. diffusion(m):               D=              " << getPhysDiffusion() << std::endl;
  clout << "Single scattering albedo:         albedo=         " << getScatteringAlbedo() << std::endl;
  clout << "Anisotropy factor:                g=              " << getAnisotropyFactor() << std::endl;
 
  clout << std::endl;
  clout << "Lattice diffusion:                D^*=            " << getLatticeDiffusion() << std::endl;
  clout << "Lattice absorption:               absorption=     " << getLatticeAbsorption() << std::endl;
  clout << "Lattice scattering:               scattering=     " << getLatticeScattering() << std::endl;
  clout << "Lattice sink:                     sink=           " << 3./8.*getLatticeAbsorption()*(getLatticeScattering()+getLatticeAbsorption()) << std::endl;
  clout << "C_R: " << getRefractionFunction(getRefractiveRelative()) << std::endl;
  clout << "r_F: " << getPartialBBCoefficient(getLatticeDiffusion(),getRefractiveRelative()) << std::endl;
 
  clout << std::endl;
  clout << "-- Conversion factors:" << std::endl;
  clout << "Voxel length(m):                  physDeltaX=     " << this->getConversionFactorLength() << std::endl;
  clout << "Time step(s):                     physDeltaT=     " << this->getConversionFactorTime() << std::endl;
  clout << "Density factor(kg/m^3):           physDensity=    " << this->getConversionFactorDensity() <<  std::endl;
  clout << "-------------------------------------------------------------" << std::endl;
}

References olb::getPartialBBCoefficient(), and olb::getRefractionFunction().

Here is the call graph for this function:

◆ write()

template<typename T , class DESCRIPTOR >

void olb::RadiativeUnitConverter< T, DESCRIPTOR >::write ( ) const

Definition at line 217 of file radiativeUnitConverter.h.

{
  std::string dataFile = singleton::directories().getLogOutDir() + "radiativeUnitConverter.dat";
  if (singleton::mpi().isMainProcessor()) {
    std::ofstream fout(dataFile.c_str(), std::ios::trunc);
    if (!fout) {
      clout << "error write() function: can not open std::ofstream" << std::endl;
    }
    else {
      print( fout );
      fout.close();
    }
  }
 
}

References olb::singleton::directories(), olb::singleton::Directories::getLogOutDir(), and olb::singleton::mpi().

Here is the call graph for this function:

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

src/core/radiativeUnitConverter.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ RadiativeUnitConverter()

Member Function Documentation

◆ getAnisotropyFactor()

◆ getEffectiveAttenuation()

◆ getExtinction()

◆ getLatticeAbsorption()

◆ getLatticeDiffusion()

◆ getLatticeScattering()

◆ getPhysAbsorption()

◆ getPhysDiffusion()

◆ getPhysScattering()

◆ getRefractiveRelative()

◆ getScatteringAlbedo()

◆ print() [1/2]

◆ print() [2/2]

◆ write()