Conversion between physical and lattice units, as well as discretization specialized for thermal applications with boussinesq approximation. More...

#include <thermalUnitConverter.h>

Inheritance diagram for olb::ThermalUnitConverter< T, DESCRIPTOR, ThermalLattice >:

Collaboration diagram for olb::ThermalUnitConverter< T, DESCRIPTOR, ThermalLattice >:

Public Member Functions
constexpr	ThermalUnitConverter (T physDeltaX, T physDeltaT, T charPhysLength, T charPhysVelocity, T physViscosity, T physDensity, T physThermalConductivity, T physSpecificHeatCapacity, T physThermalExpansionCoefficient, T charPhysLowTemperature, T charPhysHighTemperature, T charPhysPressure=0)
	Documentation of constructor: TODO: Extend constructur documentation.

constexpr T	getLatticeThermalRelaxationTime () const
	return thermal relaxation time in lattice units

constexpr T	getLatticeThermalRelaxationFrequency () const
	return thermal relaxation frequency in lattice units

constexpr T	getCharPhysLowTemperature () const
	return characteristic low temperature in physical units

constexpr T	getCharPhysHighTemperature () const
	return characteristic high temperature in physical units

constexpr T	getCharPhysTemperatureDifference () const
	return characteristic temperature difference in physical units

constexpr T	getPhysThermalExpansionCoefficient () const
	return thermal expansion coefficient in physical units

constexpr T	getPhysThermalDiffusivity () const
	return thermal diffusivity in physical units

constexpr T	getPhysSpecificHeatCapacity () const
	return specific heat capacity in physical units

constexpr T	getThermalConductivity () const
	return thermal conductivity in physical units

constexpr T	getPhysTemperature (T latticeTemperature) const
	conversion from lattice to physical temperature

constexpr T	getLatticeTemperature (T physTemperature) const
	conversion from physical to lattice temperature

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

constexpr T	getPhysThermalDiffusivity (T latticeThermalDiffusivity) const
	conversion from lattice to physical thermal diffusivity

constexpr T	getLatticeThermalDiffusivity (T physThermalDiffusivity) const
	conversion from physical to lattice thermal diffusivity

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

constexpr T	getPhysSpecificHeatCapacity (T latticeSpecificHeatCapacity) const
	conversion from lattice to physical specific heat capacity

constexpr T	getLatticeSpecificHeatCapacity (T physSpecificHeatCapacity) const
	conversion from physical to lattice specific heat capacity

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

constexpr T	getPhysThermalConductivity (T latticeThermalConductivity) const
	conversion from lattice to physical thermal conductivity

constexpr T	getLatticeThermalConductivity (T physThermalConductivity) const
	conversion from physical to lattice thermal conductivity

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

constexpr T	getPhysHeatFlux (T latticeHeatFlux) const
	conversion from lattice to physical heat flux

constexpr T	getLatticeHeatFlux (T physHeatFlux) const
	conversion from physical to lattice heat flux

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

constexpr T	getPrandtlNumber () const

constexpr T	getRayleighNumber () const

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

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	getCharCFLnumber () const
	return characteristic CFL number

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

template<unsigned D>
constexpr Vector< T, D >	getLatticeVelocity (Vector< T, D > physU) 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

template<unsigned D>
constexpr Vector< T, D >	getPhysForce (Vector< T, D > latticeForce) const
	conversion from lattice to physical force vector

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

template<unsigned D>
constexpr Vector< T, D >	getPhysTorque (Vector< T, D > latticeTorque) const
	conversion from lattice to physical force vector

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

Protected Attributes
const T	_conversionTemperature

const T	_conversionThermalDiffusivity

const T	_conversionSpecificHeatCapacity

const T	_conversionThermalConductivity

const T	_conversionHeatFlux

const T	_charPhysLowTemperature

const T	_charPhysHighTemperature

const T	_charPhysTemperatureDifference

const T	_physThermalExpansionCoefficient

const T	_physThermalDiffusivity

const T	_physSpecificHeatCapacity

const T	_physThermalConductivity

const T	_latticeThermalRelaxationTime

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, typename ThermalLattice>
class olb::ThermalUnitConverter< T, DESCRIPTOR, ThermalLattice >

Conversion between physical and lattice units, as well as discretization specialized for thermal applications with boussinesq approximation.

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

For pressure and temperature we first shift the physical values by a characteristic value to asure a lattice pressure and between 0 and 1, e.g. physPressure - charPhysPressure = conversionPressure * latticePressure. For the temperature we set lattice values between 0.5 and 1.5 by __latticeTemperature = (physTemperature - charPhysLowTemperature) / conversionTemperature + 0.5 with conversionTemperature = charPhysHighTemperature - charPhysLowTemperature = charPhysTemperatureDifference

TODO: Extend documentation for ThermalUnitConverter

Definition at line 54 of file thermalUnitConverter.h.

Constructor & Destructor Documentation

◆ ThermalUnitConverter()

template<typename T , typename DESCRIPTOR , typename ThermalLattice >

olb::ThermalUnitConverter< T, DESCRIPTOR, ThermalLattice >::ThermalUnitConverter	(	T	physDeltaX,
		T	physDeltaT,
		T	charPhysLength,
		T	charPhysVelocity,
		T	physViscosity,
		T	physDensity,
		T	physThermalConductivity,
		T	physSpecificHeatCapacity,
		T	physThermalExpansionCoefficient,
		T	charPhysLowTemperature,
		T	charPhysHighTemperature,
		T	charPhysPressure = 0 )

inlineconstexpr

Documentation of constructor: TODO: Extend constructur documentation.

Definition at line 59 of file thermalUnitConverter.h.

    : UnitConverter<T, DESCRIPTOR>(
        physDeltaX, physDeltaT, charPhysLength, charPhysVelocity,
        physViscosity, physDensity, charPhysPressure),
      _conversionTemperature(charPhysHighTemperature - charPhysLowTemperature),
      _conversionThermalDiffusivity(this->_conversionViscosity),
      _conversionSpecificHeatCapacity(this->_conversionVelocity * this->_conversionVelocity / _conversionTemperature),
      _conversionThermalConductivity(this->_conversionForce / this->_conversionTime / _conversionTemperature),
      _conversionHeatFlux(this->_conversionMass / util::pow(this->_conversionTime, 3)),
      _charPhysLowTemperature(charPhysLowTemperature),
      _charPhysHighTemperature(charPhysHighTemperature),
      _charPhysTemperatureDifference(charPhysHighTemperature - charPhysLowTemperature),
      _physThermalExpansionCoefficient(physThermalExpansionCoefficient),
      _physThermalDiffusivity(physThermalConductivity / (physDensity * physSpecificHeatCapacity)),
      _physSpecificHeatCapacity(physSpecificHeatCapacity),
      _physThermalConductivity(physThermalConductivity),
      _latticeThermalRelaxationTime( (_physThermalDiffusivity / _conversionThermalDiffusivity * descriptors::invCs2<T,ThermalLattice>()) + 0.5 ),
      clout(std::cout,"ThermalUnitConv")
  {
  };

Member Function Documentation

◆ getCharPhysHighTemperature()

template<typename T , typename DESCRIPTOR , typename ThermalLattice >

T olb::ThermalUnitConverter< T, DESCRIPTOR, ThermalLattice >::getCharPhysHighTemperature ( ) const

inlineconstexpr

return characteristic high temperature in physical units

Definition at line 109 of file thermalUnitConverter.h.

  {
    return _charPhysHighTemperature;
  };

References olb::ThermalUnitConverter< T, DESCRIPTOR, ThermalLattice >::_charPhysHighTemperature.

◆ getCharPhysLowTemperature()

template<typename T , typename DESCRIPTOR , typename ThermalLattice >

T olb::ThermalUnitConverter< T, DESCRIPTOR, ThermalLattice >::getCharPhysLowTemperature ( ) const

inlineconstexpr

return characteristic low temperature in physical units

Definition at line 104 of file thermalUnitConverter.h.

  {
    return _charPhysLowTemperature;
  };

References olb::ThermalUnitConverter< T, DESCRIPTOR, ThermalLattice >::_charPhysLowTemperature.

◆ getCharPhysTemperatureDifference()

template<typename T , typename DESCRIPTOR , typename ThermalLattice >

T olb::ThermalUnitConverter< T, DESCRIPTOR, ThermalLattice >::getCharPhysTemperatureDifference ( ) const

inlineconstexpr

return characteristic temperature difference in physical units

Definition at line 114 of file thermalUnitConverter.h.

  {
    return _charPhysTemperatureDifference;
  };

References olb::ThermalUnitConverter< T, DESCRIPTOR, ThermalLattice >::_charPhysTemperatureDifference.

◆ getConversionFactorHeatFlux()

template<typename T , typename DESCRIPTOR , typename ThermalLattice >

T olb::ThermalUnitConverter< T, DESCRIPTOR, ThermalLattice >::getConversionFactorHeatFlux ( ) const

inlineconstexpr

access (read-only) to private member variable

Definition at line 215 of file thermalUnitConverter.h.

  {
    return _conversionHeatFlux;
  };

References olb::ThermalUnitConverter< T, DESCRIPTOR, ThermalLattice >::_conversionHeatFlux.

◆ getConversionFactorSpecificHeatCapacity()

template<typename T , typename DESCRIPTOR , typename ThermalLattice >

T olb::ThermalUnitConverter< T, DESCRIPTOR, ThermalLattice >::getConversionFactorSpecificHeatCapacity ( ) const

inlineconstexpr

access (read-only) to private member variable

Definition at line 183 of file thermalUnitConverter.h.

  {
    return _conversionSpecificHeatCapacity;
  };

References olb::ThermalUnitConverter< T, DESCRIPTOR, ThermalLattice >::_conversionSpecificHeatCapacity.

◆ getConversionFactorTemperature()

template<typename T , typename DESCRIPTOR , typename ThermalLattice >

T olb::ThermalUnitConverter< T, DESCRIPTOR, ThermalLattice >::getConversionFactorTemperature ( ) const

inlineconstexpr

access (read-only) to private member variable

Definition at line 150 of file thermalUnitConverter.h.

  {
    return _conversionTemperature;
  };

References olb::ThermalUnitConverter< T, DESCRIPTOR, ThermalLattice >::_conversionTemperature.

◆ getConversionFactorThermalConductivity()

template<typename T , typename DESCRIPTOR , typename ThermalLattice >

T olb::ThermalUnitConverter< T, DESCRIPTOR, ThermalLattice >::getConversionFactorThermalConductivity ( ) const

inlineconstexpr

access (read-only) to private member variable

Definition at line 199 of file thermalUnitConverter.h.

  {
    return _conversionThermalConductivity;
  };

References olb::ThermalUnitConverter< T, DESCRIPTOR, ThermalLattice >::_conversionThermalConductivity.

◆ getConversionFactorThermalDiffusivity()

template<typename T , typename DESCRIPTOR , typename ThermalLattice >

T olb::ThermalUnitConverter< T, DESCRIPTOR, ThermalLattice >::getConversionFactorThermalDiffusivity ( ) const

inlineconstexpr

access (read-only) to private member variable

Definition at line 166 of file thermalUnitConverter.h.

  {
    return _conversionThermalDiffusivity;
  };

References olb::ThermalUnitConverter< T, DESCRIPTOR, ThermalLattice >::_conversionThermalDiffusivity.

◆ getLatticeHeatFlux()

template<typename T , typename DESCRIPTOR , typename ThermalLattice >

T olb::ThermalUnitConverter< T, DESCRIPTOR, ThermalLattice >::getLatticeHeatFlux ( T physHeatFlux ) const

inlineconstexpr

conversion from physical to lattice heat flux

Definition at line 210 of file thermalUnitConverter.h.

  {
    return physHeatFlux / _conversionHeatFlux;
  };

References olb::ThermalUnitConverter< T, DESCRIPTOR, ThermalLattice >::_conversionHeatFlux.

◆ getLatticeSpecificHeatCapacity()

template<typename T , typename DESCRIPTOR , typename ThermalLattice >

T olb::ThermalUnitConverter< T, DESCRIPTOR, ThermalLattice >::getLatticeSpecificHeatCapacity ( T physSpecificHeatCapacity ) const

inlineconstexpr

conversion from physical to lattice specific heat capacity

Definition at line 178 of file thermalUnitConverter.h.

  {
    return physSpecificHeatCapacity / _conversionSpecificHeatCapacity;
  };

References olb::ThermalUnitConverter< T, DESCRIPTOR, ThermalLattice >::_conversionSpecificHeatCapacity.

◆ getLatticeTemperature()

template<typename T , typename DESCRIPTOR , typename ThermalLattice >

T olb::ThermalUnitConverter< T, DESCRIPTOR, ThermalLattice >::getLatticeTemperature ( T physTemperature ) const

inlineconstexpr

conversion from physical to lattice temperature

Definition at line 145 of file thermalUnitConverter.h.

  {
    return (physTemperature - _charPhysLowTemperature) / _conversionTemperature + 0.5;
  };

References olb::ThermalUnitConverter< T, DESCRIPTOR, ThermalLattice >::_charPhysLowTemperature, and olb::ThermalUnitConverter< T, DESCRIPTOR, ThermalLattice >::_conversionTemperature.

◆ getLatticeThermalConductivity()

template<typename T , typename DESCRIPTOR , typename ThermalLattice >

T olb::ThermalUnitConverter< T, DESCRIPTOR, ThermalLattice >::getLatticeThermalConductivity ( T physThermalConductivity ) const

inlineconstexpr

conversion from physical to lattice thermal conductivity

Definition at line 194 of file thermalUnitConverter.h.

  {
    return physThermalConductivity / _conversionThermalConductivity;
  };

References olb::ThermalUnitConverter< T, DESCRIPTOR, ThermalLattice >::_conversionThermalConductivity.

◆ getLatticeThermalDiffusivity()

template<typename T , typename DESCRIPTOR , typename ThermalLattice >

T olb::ThermalUnitConverter< T, DESCRIPTOR, ThermalLattice >::getLatticeThermalDiffusivity ( T physThermalDiffusivity ) const

inlineconstexpr

conversion from physical to lattice thermal diffusivity

Definition at line 161 of file thermalUnitConverter.h.

  {
    return physThermalDiffusivity / _conversionThermalDiffusivity;
  };

References olb::ThermalUnitConverter< T, DESCRIPTOR, ThermalLattice >::_conversionThermalDiffusivity.

◆ getLatticeThermalRelaxationFrequency()

template<typename T , typename DESCRIPTOR , typename ThermalLattice >

T olb::ThermalUnitConverter< T, DESCRIPTOR, ThermalLattice >::getLatticeThermalRelaxationFrequency ( ) const

inlineconstexpr

return thermal relaxation frequency in lattice units

Definition at line 98 of file thermalUnitConverter.h.

  {
    return 1.0 / _latticeThermalRelaxationTime;
  };

References olb::ThermalUnitConverter< T, DESCRIPTOR, ThermalLattice >::_latticeThermalRelaxationTime.

◆ getLatticeThermalRelaxationTime()

template<typename T , typename DESCRIPTOR , typename ThermalLattice >

T olb::ThermalUnitConverter< T, DESCRIPTOR, ThermalLattice >::getLatticeThermalRelaxationTime ( ) const

inlineconstexpr

return thermal relaxation time in lattice units

Definition at line 93 of file thermalUnitConverter.h.

  {
    return _latticeThermalRelaxationTime;
  };

References olb::ThermalUnitConverter< T, DESCRIPTOR, ThermalLattice >::_latticeThermalRelaxationTime.

◆ getPhysHeatFlux()

template<typename T , typename DESCRIPTOR , typename ThermalLattice >

T olb::ThermalUnitConverter< T, DESCRIPTOR, ThermalLattice >::getPhysHeatFlux ( T latticeHeatFlux ) const

inlineconstexpr

conversion from lattice to physical heat flux

Definition at line 205 of file thermalUnitConverter.h.

  {
    return _conversionHeatFlux * latticeHeatFlux;
  };

References olb::ThermalUnitConverter< T, DESCRIPTOR, ThermalLattice >::_conversionHeatFlux.

◆ getPhysSpecificHeatCapacity() [1/2]

template<typename T , typename DESCRIPTOR , typename ThermalLattice >

T olb::ThermalUnitConverter< T, DESCRIPTOR, ThermalLattice >::getPhysSpecificHeatCapacity ( ) const

inlineconstexpr

return specific heat capacity in physical units

Definition at line 129 of file thermalUnitConverter.h.

  {
    return _physSpecificHeatCapacity;
  };

References olb::ThermalUnitConverter< T, DESCRIPTOR, ThermalLattice >::_physSpecificHeatCapacity.

◆ getPhysSpecificHeatCapacity() [2/2]

template<typename T , typename DESCRIPTOR , typename ThermalLattice >

T olb::ThermalUnitConverter< T, DESCRIPTOR, ThermalLattice >::getPhysSpecificHeatCapacity ( T latticeSpecificHeatCapacity ) const

inlineconstexpr

conversion from lattice to physical specific heat capacity

Definition at line 173 of file thermalUnitConverter.h.

  {
    return _conversionSpecificHeatCapacity * latticeSpecificHeatCapacity;
  };

References olb::ThermalUnitConverter< T, DESCRIPTOR, ThermalLattice >::_conversionSpecificHeatCapacity.

◆ getPhysTemperature()

template<typename T , typename DESCRIPTOR , typename ThermalLattice >

T olb::ThermalUnitConverter< T, DESCRIPTOR, ThermalLattice >::getPhysTemperature ( T latticeTemperature ) const

inlineconstexpr

conversion from lattice to physical temperature

Definition at line 140 of file thermalUnitConverter.h.

  {
    return _conversionTemperature * (latticeTemperature - 0.5) + _charPhysLowTemperature;
  };

References olb::ThermalUnitConverter< T, DESCRIPTOR, ThermalLattice >::_charPhysLowTemperature, and olb::ThermalUnitConverter< T, DESCRIPTOR, ThermalLattice >::_conversionTemperature.

◆ getPhysThermalConductivity()

template<typename T , typename DESCRIPTOR , typename ThermalLattice >

T olb::ThermalUnitConverter< T, DESCRIPTOR, ThermalLattice >::getPhysThermalConductivity ( T latticeThermalConductivity ) const

inlineconstexpr

conversion from lattice to physical thermal conductivity

Definition at line 189 of file thermalUnitConverter.h.

  {
    return _conversionThermalConductivity * latticeThermalConductivity;
  };

References olb::ThermalUnitConverter< T, DESCRIPTOR, ThermalLattice >::_conversionThermalConductivity.

◆ getPhysThermalDiffusivity() [1/2]

template<typename T , typename DESCRIPTOR , typename ThermalLattice >

T olb::ThermalUnitConverter< T, DESCRIPTOR, ThermalLattice >::getPhysThermalDiffusivity ( ) const

inlineconstexpr

return thermal diffusivity in physical units

Definition at line 124 of file thermalUnitConverter.h.

  {
    return _physThermalDiffusivity;
  };

References olb::ThermalUnitConverter< T, DESCRIPTOR, ThermalLattice >::_physThermalDiffusivity.

◆ getPhysThermalDiffusivity() [2/2]

template<typename T , typename DESCRIPTOR , typename ThermalLattice >

T olb::ThermalUnitConverter< T, DESCRIPTOR, ThermalLattice >::getPhysThermalDiffusivity ( T latticeThermalDiffusivity ) const

inlineconstexpr

conversion from lattice to physical thermal diffusivity

Definition at line 156 of file thermalUnitConverter.h.

  {
    return _conversionThermalDiffusivity * latticeThermalDiffusivity;
  };

References olb::ThermalUnitConverter< T, DESCRIPTOR, ThermalLattice >::_conversionThermalDiffusivity.

◆ getPhysThermalExpansionCoefficient()

template<typename T , typename DESCRIPTOR , typename ThermalLattice >

T olb::ThermalUnitConverter< T, DESCRIPTOR, ThermalLattice >::getPhysThermalExpansionCoefficient ( ) const

inlineconstexpr

return thermal expansion coefficient in physical units

Definition at line 119 of file thermalUnitConverter.h.

  {
    return _physThermalExpansionCoefficient;
  };

References olb::ThermalUnitConverter< T, DESCRIPTOR, ThermalLattice >::_physThermalExpansionCoefficient.

◆ getPrandtlNumber()

template<typename T , typename DESCRIPTOR , typename ThermalLattice >

T olb::ThermalUnitConverter< T, DESCRIPTOR, ThermalLattice >::getPrandtlNumber ( ) const

inlineconstexpr

Definition at line 219 of file thermalUnitConverter.h.

  {
    return this->_physViscosity/_physThermalDiffusivity;
  };

References olb::ThermalUnitConverter< T, DESCRIPTOR, ThermalLattice >::_physThermalDiffusivity, and olb::UnitConverter< T, DESCRIPTOR >::_physViscosity.

◆ getRayleighNumber()

template<typename T , typename DESCRIPTOR , typename ThermalLattice >

T olb::ThermalUnitConverter< T, DESCRIPTOR, ThermalLattice >::getRayleighNumber ( ) const

inlineconstexpr

Definition at line 223 of file thermalUnitConverter.h.

  {
    return 9.81 * _physThermalExpansionCoefficient/this->_physViscosity/_physThermalDiffusivity * (_charPhysHighTemperature - _charPhysLowTemperature) * util::pow(this->_charPhysLength,3);
  };

References olb::ThermalUnitConverter< T, DESCRIPTOR, ThermalLattice >::_charPhysHighTemperature, olb::UnitConverter< T, DESCRIPTOR >::_charPhysLength, olb::ThermalUnitConverter< T, DESCRIPTOR, ThermalLattice >::_charPhysLowTemperature, olb::ThermalUnitConverter< T, DESCRIPTOR, ThermalLattice >::_physThermalDiffusivity, olb::ThermalUnitConverter< T, DESCRIPTOR, ThermalLattice >::_physThermalExpansionCoefficient, olb::UnitConverter< T, DESCRIPTOR >::_physViscosity, and olb::util::pow().

Here is the call graph for this function:

◆ getThermalConductivity()

template<typename T , typename DESCRIPTOR , typename ThermalLattice >

T olb::ThermalUnitConverter< T, DESCRIPTOR, ThermalLattice >::getThermalConductivity ( ) const

inlineconstexpr

return thermal conductivity in physical units

Definition at line 134 of file thermalUnitConverter.h.

  {
    return _physThermalConductivity;
  };

References olb::ThermalUnitConverter< T, DESCRIPTOR, ThermalLattice >::_physThermalConductivity.

◆ print()

template<typename T , typename DESCRIPTOR , typename ThermalLattice >

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

overridevirtual

nice terminal output for conversion factors, characteristical and physical data

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

Definition at line 38 of file thermalUnitConverter.hh.

{
  clout << "----------------- UnitConverter information -----------------" << std::endl;
  clout << "-- Parameters:" << std::endl;
  clout << "Resolution:                                 N=                              " << this->getResolution() << std::endl;
  clout << "Lattice velocity:                           latticeU=                       " << this->getCharLatticeVelocity() << std::endl;
  clout << "Lattice relaxation frequency:               omega=                          " << this->getLatticeRelaxationFrequency() << std::endl;
  clout << "Lattice relaxation time:                    tau=                            " << this->getLatticeRelaxationTime() << std::endl;
  clout << "Thermal Lattice relaxation frequency:       omega_AD=                       " << this->getLatticeThermalRelaxationFrequency() << std::endl;
  clout << "Thermal Lattice relaxation time:            tau_AD=                         " << this->getLatticeThermalRelaxationTime() << std::endl;
  clout << "Characteristical length(m):                 charL=                          " << this->getCharPhysLength() << std::endl;
  clout << "Characteristical speed(m/s):                charU=                          " << this->getCharPhysVelocity() << std::endl;
  clout << "Phys. kinematic viscosity(m^2/s):           charNu=                         " << this->getPhysViscosity() << std::endl;
  clout << "Phys. density(kg/m^d):                      charRho=                        " << this->getPhysDensity() << std::endl;
  clout << "Characteristical pressure(N/m^2):           charPressure=                   " << this->getCharPhysPressure() << std::endl;
  clout << "Reynolds number:                            reynoldsNumber=                 " << this->getReynoldsNumber() << std::endl;
 
  clout << "-------------------------------------------------------------" << std::endl;
 
  clout << "----------------- ThermalUnitConverter information -----------------" << std::endl;
  clout << "-- Parameters:" << std::endl;
  clout << "Phys. Delta X(m):                           physDeltaX=                     " << this->getPhysDeltaX() << std::endl;
  clout << "Phys. Delta T(s):                           physDeltaT=                     " << this->getPhysDeltaT() << std::endl;
  clout << "Characteristical pressure(N/m^2):           charPressure=                   " << this->getCharPhysPressure() << std::endl;
  clout << "Phys. Thermal Conductivity(W/m/K):          physThermalCondcticity=         " << getThermalConductivity() << std::endl;
  clout << "Phys. specific Heat Capacity(J/kg/K):       physSpecificHeatCapacity=       " << getPhysSpecificHeatCapacity() << std::endl;
  clout << "Phys. Thermal Expasion Coefficent(K^-1):    physThermalExpansionCoefficent= " << getPhysThermalExpansionCoefficient() << std::endl;
  clout << "Characteristical Phys. low Temperature(K):  charPhysLowTemperature=         " << getCharPhysLowTemperature() << std::endl;
  clout << "Characteristical Phys. high Temperature(K): charPhysHighTemperature=        " << getCharPhysHighTemperature() << std::endl;
  clout << "Prandtl number:                             prandtlNumber=                  " << getPrandtlNumber() << std::endl;
  clout << "Rayleigh number:                            rayleighNumber=                 " << getRayleighNumber() << 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 << "Velocity factor(m/s):                       physVelocity=                   " << this->getConversionFactorVelocity() << std::endl;
  clout << "Density factor(kg/m^3):                     physDensity=                    " << this->getConversionFactorDensity() <<  std::endl;
  clout << "Mass factor(kg):                            physMass=                       " << this->getConversionFactorMass() << std::endl;
  clout << "Viscosity factor(m^2/s):                    physViscosity=                  " << this->getConversionFactorViscosity() << std::endl;
  clout << "Force factor(N):                            physForce=                      " << this->getConversionFactorForce() << std::endl;
  clout << "Pressure factor(N/m^2):                     physPressure=                   " << this->getConversionFactorPressure() << std::endl;
 
  clout << "-------------------------------------------------------------" << std::endl;
 
  clout << "----------------- ThermalConversion factors:-----------------" << std::endl;
  clout << "Temperature(K):                             temperature=                    " << getConversionFactorTemperature() << std::endl;
  clout << "Thermal Diffusity(m^2/s):                   physThermalDiffusity=           " << getConversionFactorThermalDiffusivity() << std::endl;
  clout << "specific Heat Capacity(J/kg):               physSpecificHeatCapacity=       " << getConversionFactorSpecificHeatCapacity() << std::endl;
  clout << "Thermal Coductivity(W/m/K):                 physThermalCondcticity=         " << getConversionFactorThermalConductivity() <<  std::endl;
  clout << "HeatFlux(W):                                physHeatFlux=                   " << getConversionFactorHeatFlux() << std::endl;
 
  clout << "-------------------------------------------------------------" << std::endl;
 
}

Member Data Documentation

◆ _charPhysHighTemperature

template<typename T , typename DESCRIPTOR , typename ThermalLattice >

const T olb::ThermalUnitConverter< T, DESCRIPTOR, ThermalLattice >::_charPhysHighTemperature

protected

Definition at line 242 of file thermalUnitConverter.h.

◆ _charPhysLowTemperature

template<typename T , typename DESCRIPTOR , typename ThermalLattice >

const T olb::ThermalUnitConverter< T, DESCRIPTOR, ThermalLattice >::_charPhysLowTemperature

protected

Definition at line 241 of file thermalUnitConverter.h.

◆ _charPhysTemperatureDifference

template<typename T , typename DESCRIPTOR , typename ThermalLattice >

const T olb::ThermalUnitConverter< T, DESCRIPTOR, ThermalLattice >::_charPhysTemperatureDifference

protected

Definition at line 243 of file thermalUnitConverter.h.

◆ _conversionHeatFlux

template<typename T , typename DESCRIPTOR , typename ThermalLattice >

const T olb::ThermalUnitConverter< T, DESCRIPTOR, ThermalLattice >::_conversionHeatFlux

protected

Definition at line 238 of file thermalUnitConverter.h.

◆ _conversionSpecificHeatCapacity

template<typename T , typename DESCRIPTOR , typename ThermalLattice >

const T olb::ThermalUnitConverter< T, DESCRIPTOR, ThermalLattice >::_conversionSpecificHeatCapacity

protected

Definition at line 236 of file thermalUnitConverter.h.

◆ _conversionTemperature

template<typename T , typename DESCRIPTOR , typename ThermalLattice >

const T olb::ThermalUnitConverter< T, DESCRIPTOR, ThermalLattice >::_conversionTemperature

protected

Definition at line 234 of file thermalUnitConverter.h.

◆ _conversionThermalConductivity

template<typename T , typename DESCRIPTOR , typename ThermalLattice >

const T olb::ThermalUnitConverter< T, DESCRIPTOR, ThermalLattice >::_conversionThermalConductivity

protected

Definition at line 237 of file thermalUnitConverter.h.

◆ _conversionThermalDiffusivity

template<typename T , typename DESCRIPTOR , typename ThermalLattice >

const T olb::ThermalUnitConverter< T, DESCRIPTOR, ThermalLattice >::_conversionThermalDiffusivity

protected

Definition at line 235 of file thermalUnitConverter.h.

◆ _latticeThermalRelaxationTime

template<typename T , typename DESCRIPTOR , typename ThermalLattice >

const T olb::ThermalUnitConverter< T, DESCRIPTOR, ThermalLattice >::_latticeThermalRelaxationTime

protected

Definition at line 250 of file thermalUnitConverter.h.

◆ _physSpecificHeatCapacity

template<typename T , typename DESCRIPTOR , typename ThermalLattice >

const T olb::ThermalUnitConverter< T, DESCRIPTOR, ThermalLattice >::_physSpecificHeatCapacity

protected

Definition at line 246 of file thermalUnitConverter.h.

◆ _physThermalConductivity

template<typename T , typename DESCRIPTOR , typename ThermalLattice >

const T olb::ThermalUnitConverter< T, DESCRIPTOR, ThermalLattice >::_physThermalConductivity

protected

Definition at line 247 of file thermalUnitConverter.h.

◆ _physThermalDiffusivity

template<typename T , typename DESCRIPTOR , typename ThermalLattice >

const T olb::ThermalUnitConverter< T, DESCRIPTOR, ThermalLattice >::_physThermalDiffusivity

protected

Definition at line 245 of file thermalUnitConverter.h.

◆ _physThermalExpansionCoefficient

template<typename T , typename DESCRIPTOR , typename ThermalLattice >

const T olb::ThermalUnitConverter< T, DESCRIPTOR, ThermalLattice >::_physThermalExpansionCoefficient

protected

Definition at line 244 of file thermalUnitConverter.h.

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

src/core/thermalUnitConverter.h
src/core/thermalUnitConverter.hh

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ThermalUnitConverter()

Member Function Documentation

◆ getCharPhysHighTemperature()

◆ getCharPhysLowTemperature()

◆ getCharPhysTemperatureDifference()

◆ getConversionFactorHeatFlux()

◆ getConversionFactorSpecificHeatCapacity()

◆ getConversionFactorTemperature()

◆ getConversionFactorThermalConductivity()

◆ getConversionFactorThermalDiffusivity()

◆ getLatticeHeatFlux()

◆ getLatticeSpecificHeatCapacity()

◆ getLatticeTemperature()

◆ getLatticeThermalConductivity()

◆ getLatticeThermalDiffusivity()

◆ getLatticeThermalRelaxationFrequency()

◆ getLatticeThermalRelaxationTime()

◆ getPhysHeatFlux()

◆ getPhysSpecificHeatCapacity() [1/2]

◆ getPhysSpecificHeatCapacity() [2/2]

◆ getPhysTemperature()

◆ getPhysThermalConductivity()

◆ getPhysThermalDiffusivity() [1/2]

◆ getPhysThermalDiffusivity() [2/2]

◆ getPhysThermalExpansionCoefficient()

◆ getPrandtlNumber()

◆ getRayleighNumber()

◆ getThermalConductivity()

◆ print()

Member Data Documentation

◆ _charPhysHighTemperature

◆ _charPhysLowTemperature

◆ _charPhysTemperatureDifference

◆ _conversionHeatFlux

◆ _conversionSpecificHeatCapacity

◆ _conversionTemperature

◆ _conversionThermalConductivity

◆ _conversionThermalDiffusivity

◆ _latticeThermalRelaxationTime

◆ _physSpecificHeatCapacity

◆ _physThermalConductivity

◆ _physThermalDiffusivity

◆ _physThermalExpansionCoefficient