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

#include <unitConverter.h>

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

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

Public Member Functions
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

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

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	_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::UnitConverter< 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

For pressure and temperature we first shift the physical values by a characteristic value to asure a lattice pressure and lattice temperature between 0 and 1, e.g. physPressure - charPhysPressure = conversionPressure * latticePressure

Parameters

latticeRelaxationTime	relaxation time, have to be greater than 0.5!
physViscosity	physical kinematic viscosity in m^2 / s
physDensity	physical density in kg / m^3
conversionLength	conversion factor for length m
conversionTime	conversion factor for time s
conversionMass	conversion factor for mass kg
conversionVelocity	conversion velocity m / s
conversionViscosity	conversion kinematic viscosity m^2 / s
conversionDensity	conversion density kg / m^3
conversionForce	conversion force kg m / s^2
conversionPressure	conversion pressure kg / m s^2
resolution	number of grid points per charPhysLength
charLatticeVelocity

Definition at line 85 of file unitConverter.h.

Constructor & Destructor Documentation

◆ UnitConverter()

template<typename T , typename DESCRIPTOR >

constexpr olb::UnitConverter< T, DESCRIPTOR >::UnitConverter	(	T	physDeltaX,
		T	physDeltaT,
		T	charPhysLength,
		T	charPhysVelocity,
		T	physViscosity,
		T	physDensity,
		T	charPhysPressure = 0 )

inlineconstexpr

Documentation of constructor:

Parameters

physDeltaX	spacing between two lattice cells in m
physDeltaT	time step in s
charPhysLength	reference/characteristic length of simulation geometry in m
charPhysVelocity	maximal or highest expected velocity during simulation in m / s
physViscosity	physical kinematic viscosity in m^2 / s
physDensity	physical density in kg / m^3
charPhysPressure	reference/characteristic physical pressure in Pa = kg / m s^2

Definition at line 96 of file unitConverter.h.

    : _conversionLength(physDeltaX),
      _conversionTime(physDeltaT),
      _conversionVelocity(_conversionLength / _conversionTime),
      _conversionDensity(physDensity),
      _conversionMass( _conversionDensity * util::pow(_conversionLength, 3) ),
      _conversionViscosity(_conversionLength * _conversionLength / _conversionTime),
      _conversionForce( _conversionMass * _conversionLength / (_conversionTime * _conversionTime) ),
      _conversionTorque( _conversionMass * _conversionLength * _conversionLength / (_conversionTime * _conversionTime) ),
      _conversionPressure( _conversionForce / util::pow(_conversionLength, 2) ),
      _charPhysLength(charPhysLength),
      _charPhysVelocity(charPhysVelocity),
      _physViscosity(physViscosity),
      _physDensity(physDensity),
      _charPhysPressure(charPhysPressure),
      _resolution((size_t)(_charPhysLength / _conversionLength + 0.5)),
      _latticeRelaxationTime( (_physViscosity / _conversionViscosity * descriptors::invCs2<T,DESCRIPTOR>()) + 0.5 ),
      _charLatticeVelocity( _charPhysVelocity / _conversionVelocity ),
      clout(std::cout,"UnitConverter")
  {
  }

◆ ~UnitConverter()

template<typename T , typename DESCRIPTOR >

virtual olb::UnitConverter< T, DESCRIPTOR >::~UnitConverter ( )

virtualdefault

Member Function Documentation

◆ getCharLatticeVelocity()

template<typename T , typename DESCRIPTOR >

constexpr T olb::UnitConverter< T, DESCRIPTOR >::getCharLatticeVelocity ( ) const

inlineconstexpr

return characteristic velocity in lattice units

Definition at line 153 of file unitConverter.h.

  {
    return _charLatticeVelocity;
  }

References olb::UnitConverter< T, DESCRIPTOR >::_charLatticeVelocity.

Here is the caller graph for this function:

◆ getCharPhysLength()

template<typename T , typename DESCRIPTOR >

constexpr T olb::UnitConverter< T, DESCRIPTOR >::getCharPhysLength ( ) const

inlineconstexpr

return characteristic length in physical units

Definition at line 143 of file unitConverter.h.

  {
    return _charPhysLength;
  }

References olb::UnitConverter< T, DESCRIPTOR >::_charPhysLength.

Here is the caller graph for this function:

◆ getCharPhysPressure()

template<typename T , typename DESCRIPTOR >

constexpr T olb::UnitConverter< T, DESCRIPTOR >::getCharPhysPressure ( ) const

inlineconstexpr

return characteristic pressure in physical units

Definition at line 168 of file unitConverter.h.

  {
    return _charPhysPressure;
  }

References olb::UnitConverter< T, DESCRIPTOR >::_charPhysPressure.

Here is the caller graph for this function:

◆ getCharPhysVelocity()

template<typename T , typename DESCRIPTOR >

constexpr T olb::UnitConverter< T, DESCRIPTOR >::getCharPhysVelocity ( ) const

inlineconstexpr

return characteristic velocity in physical units

Definition at line 148 of file unitConverter.h.

  {
    return _charPhysVelocity;
  }

References olb::UnitConverter< T, DESCRIPTOR >::_charPhysVelocity.

Here is the caller graph for this function:

◆ getConversionFactorDensity()

template<typename T , typename DESCRIPTOR >

constexpr T olb::UnitConverter< T, DESCRIPTOR >::getConversionFactorDensity ( ) const

inlineconstexpr

access (read-only) to private member variable

Definition at line 262 of file unitConverter.h.

  {
    return _conversionDensity;
  }

References olb::UnitConverter< T, DESCRIPTOR >::_conversionDensity.

Here is the caller graph for this function:

◆ getConversionFactorForce()

template<typename T , typename DESCRIPTOR >

constexpr T olb::UnitConverter< T, DESCRIPTOR >::getConversionFactorForce ( ) const

inlineconstexpr

access (read-only) to private member variable

Definition at line 310 of file unitConverter.h.

  {
    return _conversionForce;
  }

References olb::UnitConverter< T, DESCRIPTOR >::_conversionForce.

Here is the caller graph for this function:

◆ getConversionFactorLength()

template<typename T , typename DESCRIPTOR >

constexpr T olb::UnitConverter< T, DESCRIPTOR >::getConversionFactorLength ( ) const

inlineconstexpr

access (read-only) to private member variable

Definition at line 200 of file unitConverter.h.

  {
    return _conversionLength;
  }

References olb::UnitConverter< T, DESCRIPTOR >::_conversionLength.

Here is the caller graph for this function:

◆ getConversionFactorMass()

template<typename T , typename DESCRIPTOR >

constexpr T olb::UnitConverter< T, DESCRIPTOR >::getConversionFactorMass ( ) const

inlineconstexpr

access (read-only) to private member variable

Definition at line 278 of file unitConverter.h.

  {
    return _conversionMass;
  }

References olb::UnitConverter< T, DESCRIPTOR >::_conversionMass.

Here is the caller graph for this function:

◆ getConversionFactorPressure()

template<typename T , typename DESCRIPTOR >

constexpr T olb::UnitConverter< T, DESCRIPTOR >::getConversionFactorPressure ( ) const

inlineconstexpr

access (read-only) to private member variable

Definition at line 342 of file unitConverter.h.

  {
    return _conversionPressure;
  }

References olb::UnitConverter< T, DESCRIPTOR >::_conversionPressure.

Here is the caller graph for this function:

◆ getConversionFactorTime()

template<typename T , typename DESCRIPTOR >

constexpr T olb::UnitConverter< T, DESCRIPTOR >::getConversionFactorTime ( ) const

inlineconstexpr

access (read-only) to private member variable

Definition at line 221 of file unitConverter.h.

  {
    return _conversionTime;
  }

References olb::UnitConverter< T, DESCRIPTOR >::_conversionTime.

Here is the caller graph for this function:

◆ getConversionFactorTorque()

template<typename T , typename DESCRIPTOR >

constexpr T olb::UnitConverter< T, DESCRIPTOR >::getConversionFactorTorque ( ) const

inlineconstexpr

access (read-only) to private member variable

Definition at line 326 of file unitConverter.h.

  {
    return _conversionTorque;
  }

References olb::UnitConverter< T, DESCRIPTOR >::_conversionTorque.

◆ getConversionFactorVelocity()

template<typename T , typename DESCRIPTOR >

constexpr T olb::UnitConverter< T, DESCRIPTOR >::getConversionFactorVelocity ( ) const

inlineconstexpr

access (read-only) to private member variable

Definition at line 242 of file unitConverter.h.

  {
    return _conversionVelocity;
  }

References olb::UnitConverter< T, DESCRIPTOR >::_conversionVelocity.

Here is the caller graph for this function:

◆ getConversionFactorViscosity()

template<typename T , typename DESCRIPTOR >

constexpr T olb::UnitConverter< T, DESCRIPTOR >::getConversionFactorViscosity ( ) const

inlineconstexpr

access (read-only) to private member variable

Definition at line 294 of file unitConverter.h.

  {
    return _conversionViscosity;
  }

References olb::UnitConverter< T, DESCRIPTOR >::_conversionViscosity.

Here is the caller graph for this function:

◆ getKnudsenNumber()

template<typename T , typename DESCRIPTOR >

constexpr T olb::UnitConverter< T, DESCRIPTOR >::getKnudsenNumber ( ) const

inlineconstexpr

return Knudsen number

Definition at line 183 of file unitConverter.h.

  {
    // This calculates the lattice Knudsen number.
    // See e.g. (7.22) in "The Lattice Boltzmann Method: Principles and Practice" [kruger2017lattice].
    return getMachNumber() / getReynoldsNumber();
  }

References olb::UnitConverter< T, DESCRIPTOR >::getMachNumber(), and olb::UnitConverter< T, DESCRIPTOR >::getReynoldsNumber().

Here is the call graph for this function:

◆ getLatticeDensity()

template<typename T , typename DESCRIPTOR >

constexpr T olb::UnitConverter< T, DESCRIPTOR >::getLatticeDensity ( T physDensity ) const

inlineconstexpr

conversion from physical to lattice density

Definition at line 253 of file unitConverter.h.

  {
    return physDensity / _conversionDensity;
  }

References olb::UnitConverter< T, DESCRIPTOR >::_conversionDensity.

◆ getLatticeDensityFromPhysPressure()

template<typename T , typename DESCRIPTOR >

constexpr T olb::UnitConverter< T, DESCRIPTOR >::getLatticeDensityFromPhysPressure ( T physPressure ) const

inlineconstexpr

Definition at line 257 of file unitConverter.h.

  {
    return util::densityFromPressure<T,DESCRIPTOR>( getLatticePressure( physPressure ) );
  }

References olb::UnitConverter< T, DESCRIPTOR >::getLatticePressure().

Here is the call graph for this function:

◆ getLatticeForce()

template<typename T , typename DESCRIPTOR >

constexpr T olb::UnitConverter< T, DESCRIPTOR >::getLatticeForce ( T physForce ) const

inlineconstexpr

conversion from physical to lattice force

Definition at line 305 of file unitConverter.h.

  {
    return physForce / _conversionForce;
  }

References olb::UnitConverter< T, DESCRIPTOR >::_conversionForce.

◆ getLatticeLength()

template<typename T , typename DESCRIPTOR >

constexpr int olb::UnitConverter< T, DESCRIPTOR >::getLatticeLength ( T physLength ) const

inlineconstexpr

conversion from physical to lattice length, returns number of voxels for given physical length

Definition at line 195 of file unitConverter.h.

  {
    return int( physLength / _conversionLength + 0.5 );
  }

References olb::UnitConverter< T, DESCRIPTOR >::_conversionLength.

◆ getLatticeMass()

template<typename T , typename DESCRIPTOR >

constexpr T olb::UnitConverter< T, DESCRIPTOR >::getLatticeMass ( T physMass ) const

inlineconstexpr

conversion from physical to lattice mass

Definition at line 273 of file unitConverter.h.

  {
    return physMass / _conversionMass;
  }

References olb::UnitConverter< T, DESCRIPTOR >::_conversionMass.

◆ getLatticePressure()

template<typename T , typename DESCRIPTOR >

constexpr T olb::UnitConverter< T, DESCRIPTOR >::getLatticePressure ( T physPressure ) const

inlineconstexpr

conversion from physical to lattice pressure

Definition at line 337 of file unitConverter.h.

  {
    return ( physPressure - _charPhysPressure ) / _conversionPressure;
  }

References olb::UnitConverter< T, DESCRIPTOR >::_charPhysPressure, and olb::UnitConverter< T, DESCRIPTOR >::_conversionPressure.

Here is the caller graph for this function:

◆ getLatticeRelaxationFrequency()

template<typename T , typename DESCRIPTOR >

constexpr T olb::UnitConverter< T, DESCRIPTOR >::getLatticeRelaxationFrequency ( ) const

inlineconstexpr

return relaxation frequency in lattice units

Definition at line 132 of file unitConverter.h.

  {
    return 1./_latticeRelaxationTime;
  }

References olb::UnitConverter< T, DESCRIPTOR >::_latticeRelaxationTime.

Here is the caller graph for this function:

◆ getLatticeRelaxationFrequencyFromDiffusivity()

template<typename T , typename DESCRIPTOR >

template<typename DESCRIPTOR_ >

constexpr T olb::UnitConverter< T, DESCRIPTOR >::getLatticeRelaxationFrequencyFromDiffusivity ( const T physDiffusivity ) const

inlineconstexpr

return relaxation frequency in lattice units computed from given physical diffusivity in m^2 / s

Definition at line 138 of file unitConverter.h.

  {
    return 1.0 / ( physDiffusivity / _conversionViscosity * descriptors::invCs2<T,DESCRIPTOR_>() + 0.5 );
  }

References olb::UnitConverter< T, DESCRIPTOR >::_conversionViscosity.

◆ getLatticeRelaxationTime()

template<typename T , typename DESCRIPTOR >

constexpr T olb::UnitConverter< T, DESCRIPTOR >::getLatticeRelaxationTime ( ) const

inlineconstexpr

return relaxation time in lattice units

Definition at line 127 of file unitConverter.h.

  {
    return _latticeRelaxationTime;
  }

References olb::UnitConverter< T, DESCRIPTOR >::_latticeRelaxationTime.

Here is the caller graph for this function:

◆ getLatticeTime()

template<typename T , typename DESCRIPTOR >

constexpr size_t olb::UnitConverter< T, DESCRIPTOR >::getLatticeTime ( T physTime ) const

inlineconstexpr

conversion from physical to lattice time

Definition at line 216 of file unitConverter.h.

  {
    return size_t(physTime / _conversionTime + 0.5);
  }

References olb::UnitConverter< T, DESCRIPTOR >::_conversionTime.

Here is the caller graph for this function:

◆ getLatticeTorque()

template<typename T , typename DESCRIPTOR >

constexpr T olb::UnitConverter< T, DESCRIPTOR >::getLatticeTorque ( T physTorque ) const

inlineconstexpr

conversion from physical to lattice torque

Definition at line 321 of file unitConverter.h.

  {
    return physTorque / _conversionTorque;
  }

References olb::UnitConverter< T, DESCRIPTOR >::_conversionTorque.

◆ getLatticeVelocity()

template<typename T , typename DESCRIPTOR >

constexpr T olb::UnitConverter< T, DESCRIPTOR >::getLatticeVelocity ( T physVelocity ) const

inlineconstexpr

conversion from physical to lattice velocity

Definition at line 237 of file unitConverter.h.

  {
    return physVelocity / _conversionVelocity;
  }

References olb::UnitConverter< T, DESCRIPTOR >::_conversionVelocity.

Here is the caller graph for this function:

◆ getLatticeViscosity()

template<typename T , typename DESCRIPTOR >

constexpr T olb::UnitConverter< T, DESCRIPTOR >::getLatticeViscosity ( ) const

inlineconstexpr

conversion from physical to lattice viscosity

Definition at line 289 of file unitConverter.h.

  {
    return _physViscosity / _conversionViscosity;
  }

References olb::UnitConverter< T, DESCRIPTOR >::_conversionViscosity, and olb::UnitConverter< T, DESCRIPTOR >::_physViscosity.

Here is the caller graph for this function:

◆ getMachNumber()

template<typename T , typename DESCRIPTOR >

constexpr T olb::UnitConverter< T, DESCRIPTOR >::getMachNumber ( ) const

inlineconstexpr

return Mach number

Definition at line 178 of file unitConverter.h.

  {
    return getCharLatticeVelocity() * util::sqrt(descriptors::invCs2<T,DESCRIPTOR>());
  }

References olb::UnitConverter< T, DESCRIPTOR >::getCharLatticeVelocity(), and olb::util::sqrt().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPhysDeltaT()

template<typename T , typename DESCRIPTOR >

constexpr T olb::UnitConverter< T, DESCRIPTOR >::getPhysDeltaT ( ) const

inlineconstexpr

returns time spacing (timestep length) in s

Definition at line 226 of file unitConverter.h.

  {
    return _conversionTime;
  }

References olb::UnitConverter< T, DESCRIPTOR >::_conversionTime.

Here is the caller graph for this function:

◆ getPhysDeltaX()

template<typename T , typename DESCRIPTOR >

constexpr T olb::UnitConverter< T, DESCRIPTOR >::getPhysDeltaX ( ) const

inlineconstexpr

returns grid spacing (voxel length) in m

Definition at line 205 of file unitConverter.h.

  {
    return _conversionLength;
  }

References olb::UnitConverter< T, DESCRIPTOR >::_conversionLength.

Here is the caller graph for this function:

◆ getPhysDensity() [1/2]

template<typename T , typename DESCRIPTOR >

constexpr T olb::UnitConverter< T, DESCRIPTOR >::getPhysDensity ( ) const

inlineconstexpr

return density in physical units

Definition at line 163 of file unitConverter.h.

  {
    return _physDensity;
  }

References olb::UnitConverter< T, DESCRIPTOR >::_physDensity.

Here is the caller graph for this function:

◆ getPhysDensity() [2/2]

template<typename T , typename DESCRIPTOR >

constexpr T olb::UnitConverter< T, DESCRIPTOR >::getPhysDensity ( T latticeDensity ) const

inlineconstexpr

conversion from lattice to physical density

Definition at line 248 of file unitConverter.h.

  {
    return _conversionDensity * latticeDensity;
  }

References olb::UnitConverter< T, DESCRIPTOR >::_conversionDensity.

◆ getPhysForce()

template<typename T , typename DESCRIPTOR >

constexpr T olb::UnitConverter< T, DESCRIPTOR >::getPhysForce ( T latticeForce ) const

inlineconstexpr

conversion from lattice to physical force

Definition at line 300 of file unitConverter.h.

  {
    return _conversionForce * latticeForce;
  }

References olb::UnitConverter< T, DESCRIPTOR >::_conversionForce.

Here is the caller graph for this function:

◆ getPhysLength()

template<typename T , typename DESCRIPTOR >

constexpr T olb::UnitConverter< T, DESCRIPTOR >::getPhysLength ( int latticeLength ) const

inlineconstexpr

conversion from lattice to physical length

Definition at line 190 of file unitConverter.h.

  {
    return _conversionLength * latticeLength;
  }

References olb::UnitConverter< T, DESCRIPTOR >::_conversionLength.

◆ getPhysMass()

template<typename T , typename DESCRIPTOR >

constexpr T olb::UnitConverter< T, DESCRIPTOR >::getPhysMass ( T latticeMass ) const

inlineconstexpr

conversion from lattice to physical mass

Definition at line 268 of file unitConverter.h.

  {
    return _conversionMass * latticeMass;
  }

References olb::UnitConverter< T, DESCRIPTOR >::_conversionMass.

◆ getPhysPressure()

template<typename T , typename DESCRIPTOR >

constexpr T olb::UnitConverter< T, DESCRIPTOR >::getPhysPressure ( T latticePressure ) const

inlineconstexpr

conversion from lattice to physical pressure

Definition at line 332 of file unitConverter.h.

  {
    return _conversionPressure * latticePressure + _charPhysPressure;
  }

References olb::UnitConverter< T, DESCRIPTOR >::_charPhysPressure, and olb::UnitConverter< T, DESCRIPTOR >::_conversionPressure.

◆ getPhysTime()

template<typename T , typename DESCRIPTOR >

constexpr T olb::UnitConverter< T, DESCRIPTOR >::getPhysTime ( size_t latticeTime ) const

inlineconstexpr

conversion from lattice to physical time

Definition at line 211 of file unitConverter.h.

  {
    return _conversionTime * latticeTime;
  }

References olb::UnitConverter< T, DESCRIPTOR >::_conversionTime.

Here is the caller graph for this function:

◆ getPhysTorque()

template<typename T , typename DESCRIPTOR >

constexpr T olb::UnitConverter< T, DESCRIPTOR >::getPhysTorque ( T latticeTorque ) const

inlineconstexpr

conversion from lattice to physical torque

Definition at line 316 of file unitConverter.h.

  {
    return _conversionTorque * latticeTorque;
  }

References olb::UnitConverter< T, DESCRIPTOR >::_conversionTorque.

◆ getPhysVelocity()

template<typename T , typename DESCRIPTOR >

constexpr T olb::UnitConverter< T, DESCRIPTOR >::getPhysVelocity ( T latticeVelocity ) const

inlineconstexpr

conversion from lattice to physical velocity

Definition at line 232 of file unitConverter.h.

  {
    return _conversionVelocity * latticeVelocity;
  }

References olb::UnitConverter< T, DESCRIPTOR >::_conversionVelocity.

◆ getPhysViscosity() [1/2]

template<typename T , typename DESCRIPTOR >

constexpr T olb::UnitConverter< T, DESCRIPTOR >::getPhysViscosity ( ) const

inlineconstexpr

return viscosity in physical units

Definition at line 158 of file unitConverter.h.

  {
    return _physViscosity;
  }

References olb::UnitConverter< T, DESCRIPTOR >::_physViscosity.

Here is the caller graph for this function:

◆ getPhysViscosity() [2/2]

template<typename T , typename DESCRIPTOR >

constexpr T olb::UnitConverter< T, DESCRIPTOR >::getPhysViscosity ( T latticeViscosity ) const

inlineconstexpr

conversion from lattice to physical viscosity

Definition at line 284 of file unitConverter.h.

  {
    return _conversionViscosity * latticeViscosity;
  }

References olb::UnitConverter< T, DESCRIPTOR >::_conversionViscosity.

◆ getResolution()

template<typename T , typename DESCRIPTOR >

constexpr int olb::UnitConverter< T, DESCRIPTOR >::getResolution ( ) const

inlineconstexpr

return resolution

Definition at line 122 of file unitConverter.h.

  {
    return _resolution;
  }

References olb::UnitConverter< T, DESCRIPTOR >::_resolution.

Here is the caller graph for this function:

◆ getReynoldsNumber()

template<typename T , typename DESCRIPTOR >

constexpr T olb::UnitConverter< T, DESCRIPTOR >::getReynoldsNumber ( ) const

inlineconstexpr

return Reynolds number

Definition at line 173 of file unitConverter.h.

  {
    return _charPhysVelocity * _charPhysLength / _physViscosity;
  }

References olb::UnitConverter< T, DESCRIPTOR >::_charPhysLength, olb::UnitConverter< T, DESCRIPTOR >::_charPhysVelocity, and olb::UnitConverter< T, DESCRIPTOR >::_physViscosity.

Here is the caller graph for this function:

◆ print() [1/2]

template<typename T , class DESCRIPTOR >

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

virtual

nice terminal output for conversion factors, characteristical and physical data

Implements olb::UnitConverterBase.

Reimplemented in olb::AdsorptionConverter< T, DESCRIPTOR >, olb::AdsorptionConverter< T, ADEDESCRIPTOR >, olb::AdeUnitConverter< T, DESCRIPTOR >, olb::MultiPhaseUnitConverter< T, DESCRIPTOR >, olb::RadiativeUnitConverter< T, DESCRIPTOR >, olb::ThermalUnitConverter< T, DESCRIPTOR, ThermalLattice >, and olb::ThermalUnitConverter< T, DESCRIPTOR, TDESCRIPTOR >.

Definition at line 72 of file unitConverter.hh.

{
  print(clout);
}

◆ print() [2/2]

template<typename T , typename DESCRIPTOR >

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

virtual

Implements olb::UnitConverterBase.

Definition at line 39 of file unitConverter.hh.

{
  clout << "----------------- UnitConverter information -----------------" << std::endl;
  clout << "-- Parameters:" << std::endl;
  clout << "Resolution:                       N=              " << getResolution() << std::endl;
  clout << "Lattice velocity:                 latticeU=       " << getCharLatticeVelocity() << std::endl;
  clout << "Lattice relaxation frequency:     omega=          " << getLatticeRelaxationFrequency(  ) << std::endl;
  clout << "Lattice relaxation time:          tau=            " << getLatticeRelaxationTime() << std::endl;
  clout << "Characteristical length(m):       charL=          " << getCharPhysLength() << std::endl;
  clout << "Characteristical speed(m/s):      charU=          " << getCharPhysVelocity() << std::endl;
  clout << "Phys. kinematic viscosity(m^2/s): charNu=         " << getPhysViscosity() << std::endl;
  clout << "Phys. density(kg/m^d):            charRho=        " << getPhysDensity() << std::endl;
  clout << "Characteristical pressure(N/m^2): charPressure=   " << getCharPhysPressure() << std::endl;
  clout << "Mach number:                      machNumber=     " << getMachNumber() << std::endl;
  clout << "Reynolds number:                  reynoldsNumber= " << getReynoldsNumber() << std::endl;
  clout << "Knudsen number:                   knudsenNumber=  " << getKnudsenNumber() << std::endl;
 
  clout << std::endl;
  clout << "-- Conversion factors:" << std::endl;
  clout << "Voxel length(m):                  physDeltaX=     " << getConversionFactorLength() << std::endl;
  clout << "Time step(s):                     physDeltaT=     " << getConversionFactorTime() << std::endl;
  clout << "Velocity factor(m/s):             physVelocity=   " << getConversionFactorVelocity() << std::endl;
  clout << "Density factor(kg/m^3):           physDensity=    " << getConversionFactorDensity() <<  std::endl;
  clout << "Mass factor(kg):                  physMass=       " << getConversionFactorMass() << std::endl;
  clout << "Viscosity factor(m^2/s):          physViscosity=  " << getConversionFactorViscosity() << std::endl;
  clout << "Force factor(N):                  physForce=      " << getConversionFactorForce() << std::endl;
  clout << "Pressure factor(N/m^2):           physPressure=   " << getConversionFactorPressure() << std::endl;
 
  clout << "-------------------------------------------------------------" << std::endl;
 
}

◆ write()

template<typename T , typename DESCRIPTOR >

void olb::UnitConverter< T, DESCRIPTOR >::write ( std::string const & fileName = "unitConverter" ) const

virtual

Implements olb::UnitConverterBase.

Definition at line 78 of file unitConverter.hh.

{
  std::string dataFile = singleton::directories().getLogOutDir() + fileName + ".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:

Member Data Documentation

◆ _charLatticeVelocity

template<typename T , typename DESCRIPTOR >

const T olb::UnitConverter< T, DESCRIPTOR >::_charLatticeVelocity

protected

Definition at line 374 of file unitConverter.h.

◆ _charPhysLength

template<typename T , typename DESCRIPTOR >

const T olb::UnitConverter< T, DESCRIPTOR >::_charPhysLength

protected

Definition at line 365 of file unitConverter.h.

◆ _charPhysPressure

template<typename T , typename DESCRIPTOR >

const T olb::UnitConverter< T, DESCRIPTOR >::_charPhysPressure

protected

Definition at line 369 of file unitConverter.h.

◆ _charPhysVelocity

template<typename T , typename DESCRIPTOR >

const T olb::UnitConverter< T, DESCRIPTOR >::_charPhysVelocity

protected

Definition at line 366 of file unitConverter.h.

◆ _conversionDensity

template<typename T , typename DESCRIPTOR >

const T olb::UnitConverter< T, DESCRIPTOR >::_conversionDensity

protected

Definition at line 357 of file unitConverter.h.

◆ _conversionForce

template<typename T , typename DESCRIPTOR >

const T olb::UnitConverter< T, DESCRIPTOR >::_conversionForce

protected

Definition at line 360 of file unitConverter.h.

◆ _conversionLength

template<typename T , typename DESCRIPTOR >

const T olb::UnitConverter< T, DESCRIPTOR >::_conversionLength

protected

Definition at line 354 of file unitConverter.h.

◆ _conversionMass

template<typename T , typename DESCRIPTOR >

const T olb::UnitConverter< T, DESCRIPTOR >::_conversionMass

protected

Definition at line 358 of file unitConverter.h.

◆ _conversionPressure

template<typename T , typename DESCRIPTOR >

const T olb::UnitConverter< T, DESCRIPTOR >::_conversionPressure

protected

Definition at line 362 of file unitConverter.h.

◆ _conversionTime

template<typename T , typename DESCRIPTOR >

const T olb::UnitConverter< T, DESCRIPTOR >::_conversionTime

protected

Definition at line 355 of file unitConverter.h.

◆ _conversionTorque

template<typename T , typename DESCRIPTOR >

const T olb::UnitConverter< T, DESCRIPTOR >::_conversionTorque

protected

Definition at line 361 of file unitConverter.h.

◆ _conversionVelocity

template<typename T , typename DESCRIPTOR >

const T olb::UnitConverter< T, DESCRIPTOR >::_conversionVelocity

protected

Definition at line 356 of file unitConverter.h.

◆ _conversionViscosity

template<typename T , typename DESCRIPTOR >

const T olb::UnitConverter< T, DESCRIPTOR >::_conversionViscosity

protected

Definition at line 359 of file unitConverter.h.

◆ _latticeRelaxationTime

template<typename T , typename DESCRIPTOR >

const T olb::UnitConverter< T, DESCRIPTOR >::_latticeRelaxationTime

protected

Definition at line 373 of file unitConverter.h.

◆ _physDensity

template<typename T , typename DESCRIPTOR >

const T olb::UnitConverter< T, DESCRIPTOR >::_physDensity

protected

Definition at line 368 of file unitConverter.h.

◆ _physViscosity

template<typename T , typename DESCRIPTOR >

const T olb::UnitConverter< T, DESCRIPTOR >::_physViscosity

protected

Definition at line 367 of file unitConverter.h.

◆ _resolution

template<typename T , typename DESCRIPTOR >

const size_t olb::UnitConverter< T, DESCRIPTOR >::_resolution

protected

Definition at line 372 of file unitConverter.h.

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

src/core/unitConverter.h
src/core/unitConverter.hh

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ UnitConverter()

◆ ~UnitConverter()

Member Function Documentation

◆ getCharLatticeVelocity()

◆ getCharPhysLength()

◆ getCharPhysPressure()

◆ getCharPhysVelocity()

◆ getConversionFactorDensity()

◆ getConversionFactorForce()

◆ getConversionFactorLength()

◆ getConversionFactorMass()

◆ getConversionFactorPressure()

◆ getConversionFactorTime()

◆ getConversionFactorTorque()

◆ getConversionFactorVelocity()

◆ getConversionFactorViscosity()

◆ getKnudsenNumber()

◆ getLatticeDensity()

◆ getLatticeDensityFromPhysPressure()

◆ getLatticeForce()

◆ getLatticeLength()

◆ getLatticeMass()

◆ getLatticePressure()

◆ getLatticeRelaxationFrequency()

◆ getLatticeRelaxationFrequencyFromDiffusivity()

◆ getLatticeRelaxationTime()

◆ getLatticeTime()

◆ getLatticeTorque()

◆ getLatticeVelocity()

◆ getLatticeViscosity()

◆ getMachNumber()

◆ getPhysDeltaT()

◆ getPhysDeltaX()

◆ getPhysDensity() [1/2]

◆ getPhysDensity() [2/2]

◆ getPhysForce()

◆ getPhysLength()

◆ getPhysMass()

◆ getPhysPressure()

◆ getPhysTime()

◆ getPhysTorque()

◆ getPhysVelocity()

◆ getPhysViscosity() [1/2]

◆ getPhysViscosity() [2/2]

◆ getResolution()

◆ getReynoldsNumber()

◆ print() [1/2]

◆ print() [2/2]

◆ write()

Member Data Documentation

◆ _charLatticeVelocity

◆ _charPhysLength

◆ _charPhysPressure

◆ _charPhysVelocity

◆ _conversionDensity

◆ _conversionForce

◆ _conversionLength

◆ _conversionMass

◆ _conversionPressure

◆ _conversionTime

◆ _conversionTorque

◆ _conversionVelocity

◆ _conversionViscosity

◆ _latticeRelaxationTime

◆ _physDensity

◆ _physViscosity

◆ _resolution