soot::sootModel Class Reference

Detailed Description

Abstract base class for soot models. sootModel_MONO, etc. inherit from this.

Definition at line 22 of file sootModel.h.

#include <sootModel.h>

Public Member Functions
virtual void	setSourceTerms (state &state)=0
void	checkSpec ()
virtual double	pahSootCollisionRatePerDimer (const double mDimer) const
virtual double	get_M0_sectional (const state &state)
virtual double	get_M1_sectional (const state &state)
	sootModel (size_t nsoot_, nucleationModel *nucl_, growthModel *grow_, oxidationModel *oxid_, coagulationModel *coag_)
	sootModel (size_t nsoot_, nucleationMech Nmech, growthMech Gmech, oxidationMech Omech, coagulationMech Cmech)
virtual	~sootModel ()

Public Attributes
size_t	nsoot
	# of soot variables: moments or sections More...
nucleationModel *	nucl
	pointer to nucleation mechanism More...
growthModel *	grow
	pointer to growth mechanism More...
oxidationModel *	oxid
	pointer to oxidation mechanism More...
coagulationModel *	coag
	pointer to coagulation mechanism More...
bool	mechsNewedHere
	flag to delete "new" objects More...
psdMech	psdMechType
	one of MONO, LOGN, QMOM, MOMIC, SECT, etc. More...
std::vector< double >	mBins
	mass in sections for the sectional model More...
sourceTerms	sources
	struct containing soot, gas, and pah source terms vectors More...

Constructor & Destructor Documentation

sootModel() [1/2]

sootModel::sootModel	(	size_t	nsoot_,
		nucleationModel *	nucl_,
		growthModel *	grow_,
		oxidationModel *	oxid_,
		coagulationModel *	coag_
	)

Constructor taking pointers to chemistry models as input. User creates these pointers nominally by "new-ing" them.

Parameters

nsoot_	input: number of soot variables (moments or sections)
nucl_	input: pointer to nucleation model.
grow_	input: pointer to growth model.
oxid_	input: pointer to oxidation model.
coag_	input: pointer to coagulation model.

Definition at line 45 of file sootModel.cc.

sootModel() [2/2]

sootModel::sootModel	(	size_t	nsoot_,
		nucleationMech	Nmech,
		growthMech	Gmech,
		oxidationMech	Omech,
		coagulationMech	Cmech
	)

Constructor taking enumerations names as input. Chemistry pointers are created (new-ed) here based on those enumerations.

Parameters

nsoot_	input: number of soot variables (moments or sections)
Nmech	input: one of enum class nucleationMech in sootDefs.h
Gmech	input: one of enum class growthMech in sootDefs.h
Omech	input: one of enum class oxidationMech in sootDefs.h
Cmech	input: one of enum class coagulationMech in sootDefs.h

Definition at line 73 of file sootModel.cc.

~sootModel()

virtual soot::sootModel::~sootModel ( )

inlinevirtual

Definition at line 79 of file sootModel.h.

Member Function Documentation

setSourceTerms()

virtual void soot::sootModel::setSourceTerms ( state &  state )

pure virtual

Implemented in soot::sootModel_LOGN, soot::sootModel_MOMIC, soot::sootModel_MONO, soot::sootModel_QMOM, and soot::sootModel_SECT.

checkSpec()

void sootModel::checkSpec

(

)

Verify the specification, HACA validity.

Definition at line 144 of file sootModel.cc.

pahSootCollisionRatePerDimer()

virtual double soot::sootModel::pahSootCollisionRatePerDimer ( const double  mDimer ) const

inlinevirtual

Definition at line 52 of file sootModel.h.

get_M0_sectional()

virtual double soot::sootModel::get_M0_sectional ( const state &  state )

inlinevirtual

Reimplemented in soot::sootModel_SECT.

Definition at line 56 of file sootModel.h.

get_M1_sectional()

virtual double soot::sootModel::get_M1_sectional ( const state &  state )

inlinevirtual

Reimplemented in soot::sootModel_SECT.

Definition at line 60 of file sootModel.h.

Member Data Documentation

nsoot

size_t soot::sootModel::nsoot

# of soot variables: moments or sections

Definition at line 28 of file sootModel.h.

nucl

nucleationModel* soot::sootModel::nucl

pointer to nucleation mechanism

Definition at line 30 of file sootModel.h.

grow

growthModel* soot::sootModel::grow

pointer to growth mechanism

Definition at line 31 of file sootModel.h.

oxid

oxidationModel* soot::sootModel::oxid

pointer to oxidation mechanism

Definition at line 32 of file sootModel.h.

coag

coagulationModel* soot::sootModel::coag

pointer to coagulation mechanism

Definition at line 33 of file sootModel.h.

mechsNewedHere

bool soot::sootModel::mechsNewedHere

flag to delete "new" objects

Definition at line 35 of file sootModel.h.

psdMechType

psdMech soot::sootModel::psdMechType

one of MONO, LOGN, QMOM, MOMIC, SECT, etc.

Definition at line 37 of file sootModel.h.

mBins

std::vector<double> soot::sootModel::mBins

mass in sections for the sectional model

Definition at line 41 of file sootModel.h.

sources

sourceTerms soot::sootModel::sources

struct containing soot, gas, and pah source terms vectors

Definition at line 42 of file sootModel.h.

---

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

• /Users/dol4/Desktop/sootlib/src/sootModel.h
• /Users/dol4/Desktop/sootlib/src/sootModel.cc