GrimesOxygen::BodyOxygen< cell_t, plugin_t > Class Template Reference

Class for managing spherical oxygen diffusion in a cell body. More...

#include <BodyOxygen.hpp>

Inheritance diagram for GrimesOxygen::BodyOxygen< cell_t, plugin_t >:

Public Member Functions
	BodyOxygen ()=default
	Default constructor. More...
	BodyOxygen (double o2)
	Constructor with initial oxygen quantity. More...
double	getOxygen () const
	Gets the oxygen quantity. More...
void	setOxygen (const double value)
	Sets the oxygen quantity. More...
void	setCellPlugin (plugin_t *_cellPlugin)
void	onCellPluginLinking ()

Protected Attributes
plugin_t *	cellPlugin

Private Attributes
double	oxygen

Detailed Description

template<typename cell_t, class plugin_t>
class GrimesOxygen::BodyOxygen< cell_t, plugin_t >

Class for managing spherical oxygen diffusion in a cell body.

Template Parameters

cell_t	Type of the cell.
plugin_t	Type of the plugin.

Definition at line 27 of file BodyOxygen.hpp.

Constructor & Destructor Documentation

BodyOxygen() [1/2]

template<typename cell_t , class plugin_t >

GrimesOxygen::BodyOxygen< cell_t, plugin_t >::BodyOxygen ( )

inlinedefault

Default constructor.

BodyOxygen() [2/2]

template<typename cell_t , class plugin_t >

GrimesOxygen::BodyOxygen< cell_t, plugin_t >::BodyOxygen ( double  o2 )

inline

Constructor with initial oxygen quantity.

Parameters

o2	Initial oxygen quantity.

Definition at line 44 of file BodyOxygen.hpp.

Member Function Documentation

getOxygen()

template<typename cell_t , class plugin_t >

double GrimesOxygen::BodyOxygen< cell_t, plugin_t >::getOxygen ( ) const

inline

Gets the oxygen quantity.

Returns

Oxygen quantity.

Definition at line 51 of file BodyOxygen.hpp.

onCellPluginLinking()

void BaseBody< plugin_t >::onCellPluginLinking ( )

inlineinherited

Definition at line 15 of file BaseBody.hpp.

setCellPlugin()

void BaseBody< plugin_t >::setCellPlugin ( plugin_t *  _cellPlugin )

inlineinherited

Definition at line 14 of file BaseBody.hpp.

setOxygen()

template<typename cell_t , class plugin_t >

void GrimesOxygen::BodyOxygen< cell_t, plugin_t >::setOxygen ( const double  value )

inline

Sets the oxygen quantity.

Parameters

value

Oxygen quantity.

Definition at line 58 of file BodyOxygen.hpp.

Member Data Documentation

cellPlugin

plugin_t * BaseBody< plugin_t >::cellPlugin

protectedinherited

Definition at line 9 of file BaseBody.hpp.

oxygen

template<typename cell_t , class plugin_t >

double GrimesOxygen::BodyOxygen< cell_t, plugin_t >::oxygen

private

Oxygen quantity in mmHg

Definition at line 30 of file BodyOxygen.hpp.

---

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

• modules/cellModules/GrimesOxygen/BodyOxygen.hpp