soot::coagulationModel Class Reference

Detailed Description

Abstract base class to calculate coagulation rate given a state and two masses.

Definition at line 15 of file coagulationModel.h.

#include <coagulationModel.h>

Public Member Functions
virtual double	getCoagulationSootRate (const state &state, double m1, double m2) const =0
virtual double	getKfm (const state &state) const
virtual double	getKc (const state &state) const
virtual double	getKcp (const state &state) const
void	set_FM_multiplier (double FM_multiplier_)
	coagulationModel ()=default
virtual	~coagulationModel ()=default

Public Attributes
sootModel *	SM
	back pointer to soot model More...
coagulationMech	mechType
	identity of the type of coagulation (child) More...

Protected Attributes
double	FM_multiplier
	multiply the FM rate by this (1.0 default, user set); make =9/2/eps_c for LL More...

Constructor & Destructor Documentation

coagulationModel()

soot::coagulationModel::coagulationModel ( )

default

~coagulationModel()

virtual soot::coagulationModel::~coagulationModel ( )

virtualdefault

Member Function Documentation

getCoagulationSootRate()

virtual double soot::coagulationModel::getCoagulationSootRate ( const state &  state, double  m1, double  m2  ) const

pure virtual

Implemented in soot::coagulationModel_CONTINUUM, soot::coagulationModel_FM, soot::coagulationModel_FUCHS, soot::coagulationModel_HM, and soot::coagulationModel_NONE.

getKfm()

virtual double soot::coagulationModel::getKfm ( const state &  state ) const

inlinevirtual

Reimplemented in soot::coagulationModel_FM.

Definition at line 34 of file coagulationModel.h.

getKc()

virtual double soot::coagulationModel::getKc ( const state &  state ) const

inlinevirtual

Reimplemented in soot::coagulationModel_CONTINUUM.

Definition at line 38 of file coagulationModel.h.

getKcp()

virtual double soot::coagulationModel::getKcp ( const state &  state ) const

inlinevirtual

Reimplemented in soot::coagulationModel_CONTINUUM.

Definition at line 42 of file coagulationModel.h.

set_FM_multiplier()

void soot::coagulationModel::set_FM_multiplier ( double  FM_multiplier_ )

inline

Definition at line 46 of file coagulationModel.h.

Member Data Documentation

SM

sootModel* soot::coagulationModel::SM

back pointer to soot model

Definition at line 21 of file coagulationModel.h.

mechType

coagulationMech soot::coagulationModel::mechType

identity of the type of coagulation (child)

Definition at line 22 of file coagulationModel.h.

FM_multiplier

double soot::coagulationModel::FM_multiplier

protected

multiply the FM rate by this (1.0 default, user set); make =9/2/eps_c for LL

Definition at line 26 of file coagulationModel.h.

---

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

• /Users/dol4/Desktop/sootlib/src/coagulationModels/coagulationModel.h