#include <adsorptionConverter.h>

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

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

Public Member Functions
	AdsorptionConverter (T physDeltaX, T physDeltaT, T charPhysLength, T charPhysVelocity, T physDiffusivity, T charConcentration, T particleConcentration, T fluidPhysViscosity)
	Converter for adsorption reactions primarily for ADE lattices based on concentration.

constexpr T	getPhysDiffusivity () const

constexpr T	getLatticeDiffusivity () const

constexpr T	getConversionFactorDiffusivity () const

constexpr T	getPhysViscosity () const

constexpr T	getConversionFactorViscosity () const

constexpr T	getConversionFactorParticleDensity () const
	conversion factor to convert particle density from lattice units to kg/m^3

T	getPhysParticleConcentration (T c)

T	getPhysConcentration (T c)

T	getPhysLoading (T Cq)

constexpr T	getReynoldsNumber () const

constexpr T	getSchmidtNumber () const

constexpr T	getFourierNumber () const

void	print (std::ostream &clout) const

void	print () const
	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	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

Protected Attributes
const T	_physViscosity

const T	_conversionViscosity

const T	_particleConcentration

OstreamManager	clout

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::AdsorptionConverter< T, DESCRIPTOR >

Definition at line 17 of file adsorptionConverter.h.

Constructor & Destructor Documentation

◆ AdsorptionConverter()

template<typename T , typename DESCRIPTOR >

olb::AdsorptionConverter< T, DESCRIPTOR >::AdsorptionConverter	(	T	physDeltaX,
		T	physDeltaT,
		T	charPhysLength,
		T	charPhysVelocity,
		T	physDiffusivity,
		T	charConcentration,
		T	particleConcentration,
		T	fluidPhysViscosity )

inline

Converter for adsorption reactions primarily for ADE lattices based on concentration.

Renames viscosity to diffusivity and also takes fluid parameters.

Parameters

physDeltaX
physDeltaT
charPhysLength
charPhysVelocity
physDiffusivity
charConcentration
particleConcentration
fluidPhysViscosity

Definition at line 37 of file adsorptionConverter.h.

                            : UnitConverter<T, DESCRIPTOR>(physDeltaX,
                                                           physDeltaT,
                                                           charPhysLength,
                                                           charPhysVelocity,
                                                           physDiffusivity,
                                                           charConcentration),
                              _physViscosity(fluidPhysViscosity),
                              _conversionViscosity(physDeltaX * physDeltaX / physDeltaT),
                              _particleConcentration(particleConcentration),
                              clout(std::cout, "AdsConverter") {};

Member Function Documentation

◆ getConversionFactorDiffusivity()

template<typename T , typename DESCRIPTOR >

constexpr T olb::AdsorptionConverter< T, DESCRIPTOR >::getConversionFactorDiffusivity ( ) const

inlineconstexpr

Definition at line 66 of file adsorptionConverter.h.

                                         {
    return UnitConverter<T, DESCRIPTOR>::getConversionFactorViscosity();
  }

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getConversionFactorParticleDensity()

template<typename T , typename DESCRIPTOR >

constexpr T olb::AdsorptionConverter< T, DESCRIPTOR >::getConversionFactorParticleDensity ( ) const

inlineconstexpr

conversion factor to convert particle density from lattice units to kg/m^3

Definition at line 80 of file adsorptionConverter.h.

                                             {
    return _particleConcentration;
  }

References olb::AdsorptionConverter< T, DESCRIPTOR >::_particleConcentration.

Here is the caller graph for this function:

◆ getConversionFactorViscosity()

template<typename T , typename DESCRIPTOR >

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

inlineconstexpr

Definition at line 75 of file adsorptionConverter.h.

                                       {
    return _conversionViscosity;
  }

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

Here is the caller graph for this function:

◆ getFourierNumber()

template<typename T , typename DESCRIPTOR >

constexpr T olb::AdsorptionConverter< T, DESCRIPTOR >::getFourierNumber ( ) const

inlineconstexpr

Definition at line 104 of file adsorptionConverter.h.

                           {
    return this->getPhysDiffusivity()*this->getPhysDeltaT() / this->getPhysDeltaX()/ this->getPhysDeltaX();
  }

References olb::UnitConverter< T, DESCRIPTOR >::getPhysDeltaT(), olb::UnitConverter< T, DESCRIPTOR >::getPhysDeltaX(), and olb::AdsorptionConverter< T, DESCRIPTOR >::getPhysDiffusivity().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLatticeDiffusivity()

template<typename T , typename DESCRIPTOR >

constexpr T olb::AdsorptionConverter< T, DESCRIPTOR >::getLatticeDiffusivity ( ) const

inlineconstexpr

Definition at line 62 of file adsorptionConverter.h.

                                {
    return UnitConverter<T, DESCRIPTOR>::getLatticeViscosity();
  }

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

Here is the call graph for this function:

◆ getPhysConcentration()

template<typename T , typename DESCRIPTOR >

T olb::AdsorptionConverter< T, DESCRIPTOR >::getPhysConcentration ( T c )

inline

Definition at line 87 of file adsorptionConverter.h.

                              {
    return c * this->getConversionFactorDensity();
  }

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

Here is the call graph for this function:

◆ getPhysDiffusivity()

template<typename T , typename DESCRIPTOR >

constexpr T olb::AdsorptionConverter< T, DESCRIPTOR >::getPhysDiffusivity ( ) const

inlineconstexpr

Definition at line 58 of file adsorptionConverter.h.

                             {
    return UnitConverter<T, DESCRIPTOR>::getPhysViscosity();
  }

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPhysLoading()

template<typename T , typename DESCRIPTOR >

T olb::AdsorptionConverter< T, DESCRIPTOR >::getPhysLoading ( T Cq )

inline

Definition at line 90 of file adsorptionConverter.h.

                         {
    return Cq * _particleConcentration;
  }

References olb::AdsorptionConverter< T, DESCRIPTOR >::_particleConcentration.

◆ getPhysParticleConcentration()

template<typename T , typename DESCRIPTOR >

T olb::AdsorptionConverter< T, DESCRIPTOR >::getPhysParticleConcentration ( T c )

inline

Definition at line 83 of file adsorptionConverter.h.

                                      {
    return c * _particleConcentration;
  }

References olb::AdsorptionConverter< T, DESCRIPTOR >::_particleConcentration.

◆ getPhysViscosity()

template<typename T , typename DESCRIPTOR >

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

inlineconstexpr

Definition at line 71 of file adsorptionConverter.h.

                           {
    return _physViscosity;
  }

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

Here is the caller graph for this function:

◆ getReynoldsNumber()

template<typename T , typename DESCRIPTOR >

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

inlineconstexpr

Definition at line 96 of file adsorptionConverter.h.

                            {
    return this->_charPhysVelocity * this->_charPhysLength / this->_physViscosity;
  }

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

Here is the caller graph for this function:

◆ getSchmidtNumber()

template<typename T , typename DESCRIPTOR >

constexpr T olb::AdsorptionConverter< T, DESCRIPTOR >::getSchmidtNumber ( ) const

inlineconstexpr

Definition at line 100 of file adsorptionConverter.h.

                           {
    return  this->getPhysViscosity() / this->getPhysDiffusivity();
  }

References olb::AdsorptionConverter< T, DESCRIPTOR >::getPhysDiffusivity(), and olb::AdsorptionConverter< T, DESCRIPTOR >::getPhysViscosity().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ print() [1/2]

template<typename T , typename DESCRIPTOR >

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

inlinevirtual

nice terminal output for conversion factors, characteristical and physical data

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

Definition at line 144 of file adsorptionConverter.h.

                     {
    {
      this->print(clout);
    }
  }

References olb::AdsorptionConverter< T, DESCRIPTOR >::print().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ print() [2/2]

template<typename T , typename DESCRIPTOR >

void olb::AdsorptionConverter< T, DESCRIPTOR >::print ( std::ostream & clout ) const

inlinevirtual

Implements olb::UnitConverterBase.

Definition at line 109 of file adsorptionConverter.h.

                                      {
    {
      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 << "Characteristic length(m):         charL=          " << this->getCharPhysLength() << std::endl;
      clout << "Characteristic speed(m/s):        charU=          " << this->getCharPhysVelocity() << std::endl;
      clout << "Phys. concentration(kg/m^d):      charC=          " << this->getPhysDensity() << std::endl;
      clout << "Phys. diffusivity (m^2/s):        Diffusivity=    " << this->getPhysDiffusivity() << std::endl;
      clout << "Phys. viscosity (m^2/s):          Viscosity=      " << this->getPhysViscosity() << std::endl;
      clout << "Schmidt Number:                   Sc=             " << this->getSchmidtNumber() << std::endl;
      clout << "Reynolds number:                  reynoldsNumber= " << this->getReynoldsNumber() << std::endl;
      clout << "Mach number:                      machNumber=     " << this->getMachNumber() << std::endl;
      clout << "Fourier number:                   fourierNumber=  " << this->getFourierNumber() << 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 << "Diffusivity factor(m^2/s):        physDiffusivity=" << this->getConversionFactorDiffusivity() << std::endl;
      clout << "Force factor(N):                  physForce=      " << this->getConversionFactorForce() << std::endl;
      clout << "Pressure factor(N/m^2):           physPressure=   " << this->getConversionFactorPressure() << std::endl;
      clout << "Particle density factor:                          " << this->getConversionFactorParticleDensity() << std::endl;
      clout << "-------------------------------------------------------------" << std::endl;
 
    }
  }

Here is the call graph for this function:

Member Data Documentation

◆ _conversionViscosity

template<typename T , typename DESCRIPTOR >

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

protected

Definition at line 20 of file adsorptionConverter.h.

◆ _particleConcentration

template<typename T , typename DESCRIPTOR >

const T olb::AdsorptionConverter< T, DESCRIPTOR >::_particleConcentration

protected

Definition at line 21 of file adsorptionConverter.h.

◆ _physViscosity

template<typename T , typename DESCRIPTOR >

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

protected

Definition at line 19 of file adsorptionConverter.h.

◆ clout

template<typename T , typename DESCRIPTOR >

OstreamManager olb::AdsorptionConverter< T, DESCRIPTOR >::clout

mutableprotected

Definition at line 22 of file adsorptionConverter.h.

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

src/core/adsorptionConverter.h

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ AdsorptionConverter()

Member Function Documentation

◆ getConversionFactorDiffusivity()

◆ getConversionFactorParticleDensity()

◆ getConversionFactorViscosity()

◆ getFourierNumber()

◆ getLatticeDiffusivity()

◆ getPhysConcentration()

◆ getPhysDiffusivity()

◆ getPhysLoading()

◆ getPhysParticleConcentration()

◆ getPhysViscosity()

◆ getReynoldsNumber()

◆ getSchmidtNumber()

◆ print() [1/2]

◆ print() [2/2]

Member Data Documentation

◆ _conversionViscosity

◆ _particleConcentration

◆ _physViscosity

◆ clout