olb::ReactingSpecies3D< T, DESCRIPTOR, SOURCE, IMPL > Class Template Reference

#include <reactingSpecies3D.h>

Inheritance diagram for olb::ReactingSpecies3D< T, DESCRIPTOR, SOURCE, IMPL >:

Collaboration diagram for olb::ReactingSpecies3D< T, DESCRIPTOR, SOURCE, IMPL >:

Public Member Functions
	ReactingSpecies3D (T stoichioCoeff)
T	getStoichioCoeff ()
T	getField (BlockStructureD< 3 > *blockStructure, int iX, int iY, int iZ)
T	getSource (BlockStructureD< 3 > *blockStructure, int iX, int iY, int iZ)
void	incrementSource (BlockStructureD< 3 > *blockStructure, T val, int iX, int iY, int iZ)
void	resetSource (BlockStructureD< 3 > *blockStructure, int iX, int iY, int iZ)

Protected Attributes
T	_stoichioCoeff

Detailed Description

template<typename T, typename DESCRIPTOR, typename SOURCE, typename IMPL>
class olb::ReactingSpecies3D< T, DESCRIPTOR, SOURCE, IMPL >

Definition at line 42 of file reactingSpecies3D.h.

Constructor & Destructor Documentation

ReactingSpecies3D()

template<typename T , typename DESCRIPTOR , typename SOURCE , typename IMPL >

olb::ReactingSpecies3D< T, DESCRIPTOR, SOURCE, IMPL >::ReactingSpecies3D

(

T

stoichioCoeff

)

Definition at line 37 of file reactingSpecies3D.hh.

  : _stoichioCoeff(stoichioCoeff)
{}

Member Function Documentation

getField()

template<typename T , typename DESCRIPTOR , typename SOURCE , typename IMPL >

T olb::ReactingSpecies3D< T, DESCRIPTOR, SOURCE, IMPL >::getField	(	BlockStructureD< 3 > *	blockStructure,
		int	iX,
		int	iY,
		int	iZ )

Definition at line 48 of file reactingSpecies3D.hh.

{
  return (static_cast<IMPL*>(this))->getField(blockStructure, iX, iY, iZ);
}

getSource()

template<typename T , typename DESCRIPTOR , typename SOURCE , typename IMPL >

T olb::ReactingSpecies3D< T, DESCRIPTOR, SOURCE, IMPL >::getSource	(	BlockStructureD< 3 > *	blockStructure,
		int	iX,
		int	iY,
		int	iZ )

Definition at line 54 of file reactingSpecies3D.hh.

{
  return static_cast<BlockLattice<T,DESCRIPTOR>*>(blockStructure)->get(iX, iY, iZ).template getFieldPointer<SOURCE>()[0];
}

getStoichioCoeff()

template<typename T , typename DESCRIPTOR , typename SOURCE , typename IMPL >

T olb::ReactingSpecies3D< T, DESCRIPTOR, SOURCE, IMPL >::getStoichioCoeff

(

)

Definition at line 42 of file reactingSpecies3D.hh.

{
  return _stoichioCoeff;
}

incrementSource()

template<typename T , typename DESCRIPTOR , typename SOURCE , typename IMPL >

void olb::ReactingSpecies3D< T, DESCRIPTOR, SOURCE, IMPL >::incrementSource	(	BlockStructureD< 3 > *	blockStructure,
		T	val,
		int	iX,
		int	iY,
		int	iZ )

Definition at line 60 of file reactingSpecies3D.hh.

{
  static_cast<BlockLattice<T,DESCRIPTOR>*>(blockStructure)->get(iX, iY, iZ).template setField<SOURCE>(val + getSource(blockStructure, iX, iY, iZ));
}

resetSource()

template<typename T , typename DESCRIPTOR , typename SOURCE , typename IMPL >

void olb::ReactingSpecies3D< T, DESCRIPTOR, SOURCE, IMPL >::resetSource	(	BlockStructureD< 3 > *	blockStructure,
		int	iX,
		int	iY,
		int	iZ )

Definition at line 66 of file reactingSpecies3D.hh.

{
  static_cast<BlockLattice<T,DESCRIPTOR>*>(blockStructure)->get(iX, iY, iZ).template setField<SOURCE>(T());
}

Member Data Documentation

_stoichioCoeff

template<typename T , typename DESCRIPTOR , typename SOURCE , typename IMPL >

T olb::ReactingSpecies3D< T, DESCRIPTOR, SOURCE, IMPL >::_stoichioCoeff

protected

Definition at line 57 of file reactingSpecies3D.h.

---

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

• src/reaction/reactingSpecies3D.h
• src/reaction/reactingSpecies3D.hh