Factory class for creating new instances of classes derived from Transport. More...

#include <TransportFactory.h>

Inheritance diagram for TransportFactory:

Collaboration diagram for TransportFactory:

Public Member Functions
virtual void	deleteFactory ()
	Deletes the statically allocated factory instance. More...

virtual LTPspecies *	newLTP (const XML_Node &trNode, const std::string &name, TransportPropertyType tp_ind, thermo_t *thermo)
	Make one of several transport models, and return a base class pointer to it. More...

virtual LiquidTranInteraction *	newLTI (const XML_Node &trNode, TransportPropertyType tp_ind, LiquidTransportParams &trParam)
	Factory function for the construction of new LiquidTranInteraction objects, which are transport models. More...

virtual Transport *	newTransport (const std::string &model, thermo_t *thermo, int log_level=0, int ndim=1)
	Build a new transport manager using a transport manager that may not be the same as in the phase description and return a base class pointer to it. More...

virtual Transport *	newTransport (thermo_t *thermo, int log_level=0)
	Build a new transport manager using the default transport manager in the phase description and return a base class pointer to it. More...

virtual void	initTransport (Transport tr, thermo_t thermo, int mode=0, int log_level=0)
	Initialize an existing transport manager. More...

virtual void	initLiquidTransport (Transport tr, thermo_t thermo, int log_level=0)
	Initialize an existing transport manager for liquid phase. More...

Public Member Functions inherited from FactoryBase
virtual	~FactoryBase ()
	destructor More...

Static Public Member Functions
static TransportFactory *	factory ()
	Return a pointer to a TransportFactory instance. More...

static std::string	modelName (int model)
	Get the name of the transport model corresponding to the specified constant. More...

Static Public Member Functions inherited from FactoryBase
static void	deleteFactories ()
	static function that deletes all factories in the internal registry maintained in a static variable More...

Private Member Functions
virtual void	initSolidTransport (Transport tr, thermo_t thermo, int log_level=0)
	Initialize an existing transport manager for solid phase. More...

	TransportFactory ()
	The constructor is private; use static method factory() to get a pointer to a factory instance. More...

void	getTransportData (const std::vector< const XML_Node * > &xspecies, XML_Node &log, const std::vector< std::string > &names, GasTransportParams &tr)
	Read the transport database. More...

void	getLiquidSpeciesTransportData (const std::vector< const XML_Node * > &db, XML_Node &log, const std::vector< std::string > &names, LiquidTransportParams &tr)
	Read transport property data from a file for a list of species that comprise the phase. More...

void	getLiquidInteractionsTransportData (const XML_Node &phaseTran_db, XML_Node &log, const std::vector< std::string > &names, LiquidTransportParams &tr)
	Read transport property data from a file for interactions between species. More...

void	getSolidTransportData (const XML_Node &transportNode, XML_Node &log, const std::string phaseName, SolidTransportData &tr)
	Read transport property data from a file for a solid phase. More...

void	fitProperties (GasTransportParams &tr, MMCollisionInt &integrals, std::ostream &logfile)
	Generate polynomial fits to the viscosity, conductivity, and the binary diffusion coefficients. More...

void	fitCollisionIntegrals (std::ostream &logfile, GasTransportParams &tr, MMCollisionInt &integrals)
	Generate polynomial fits to collision integrals. More...

void	setupMM (std::ostream &flog, const std::vector< const XML_Node * > &transport_database, thermo_t *thermo, int mode, int log_level, GasTransportParams &tr)
	Prepare to build a new kinetic-theory-based transport manager for low-density gases. More...

void	setupLiquidTransport (std::ostream &flog, thermo_t *thermo, int log_level, LiquidTransportParams &trParam)
	Prepare to build a new transport manager for liquids assuming that viscosity transport data is provided in Arrhenius form. More...

void	setupSolidTransport (std::ostream &flog, thermo_t *thermo, int log_level, SolidTransportData &trParam)
	Prepare to build a new transport manager for solids. More...

void	getBinDiffCorrection (doublereal t, const GasTransportParams &tr, MMCollisionInt &integrals, size_t k, size_t j, doublereal xk, doublereal xj, doublereal &fkj, doublereal &fjk)
	Second-order correction to the binary diffusion coefficients. More...

void	makePolarCorrections (size_t i, size_t j, const GasTransportParams &tr, doublereal &f_eps, doublereal &f_sigma)
	Corrections for polar-nonpolar binary diffusion coefficients. More...

Private Attributes
bool	m_verbose
	Boolean indicating whether to turn on verbose printing. More...

std::map< std::string, int >	m_models
	Mapping between between the string name for a transport model and the integer name. More...

std::map< int, std::string >	m_modelNames
	Inverse mapping of transport models, from integer constant to string. More...

std::map< std::string, TransportPropertyType >	m_tranPropMap
	Mapping between between the string name for a transport property and the integer name. More...

std::map< std::string, LTPTemperatureDependenceType >	m_LTRmodelMap
	Mapping between between the string name for a species-specific transport property model and the integer name. More...

std::map< std::string, LiquidTranMixingModel >	m_LTImodelMap
	Mapping between between the string name for a liquid mixture transport property model and the integer name. More...

Static Private Attributes
static TransportFactory *	s_factory = 0
	Static instance of the factor -> This is the only instance of this object allowed. More...

static mutex_t	transport_mutex
	Static instance of the mutex used to ensure the proper reading of the transport database. More...

Additional Inherited Members
Protected Member Functions inherited from FactoryBase
	FactoryBase ()
	Constructor. More...

Detailed Description

Factory class for creating new instances of classes derived from Transport.

Creates 'transport managers', which are classes derived from class Transport that provide transport properties. TransportFactory handles all initialization required, including evaluation of collision integrals and generating polynomial fits. Transport managers can also be created in other ways.

Definition at line 38 of file TransportFactory.h.

Constructor & Destructor Documentation

TransportFactory ( )

private

The constructor is private; use static method factory() to get a pointer to a factory instance.

The default constructor for this class sets up m_models[], a mapping between the string name for a transport model and the integer name.

Definition at line 166 of file TransportFactory.cpp.

References TransportFactory::m_LTImodelMap, TransportFactory::m_LTRmodelMap, TransportFactory::m_modelNames, TransportFactory::m_models, and TransportFactory::m_tranPropMap.

Referenced by TransportFactory::factory().

Member Function Documentation

static TransportFactory* factory ( )

inlinestatic

Return a pointer to a TransportFactory instance.

TransportFactory is implemented as a 'singleton', which means that at most one instance may be created. The constructor is private. When a TransportFactory instance is required, call static method factory() to return a pointer to the TransportFactory instance.

TransportFactory* f;

f = TransportFactory::factory();

Definition at line 53 of file TransportFactory.h.

References TransportFactory::s_factory, TransportFactory::transport_mutex, and TransportFactory::TransportFactory().

Referenced by TransportFactory::modelName(), Cantera::newDefaultTransportMgr(), and Cantera::newTransportMgr().

void deleteFactory ( )

virtual

Deletes the statically allocated factory instance.

Implements FactoryBase.

Definition at line 216 of file TransportFactory.cpp.

References TransportFactory::s_factory, and TransportFactory::transport_mutex.

std::string modelName ( int model )

static

Get the name of the transport model corresponding to the specified constant.

Parameters

model Integer representing the model name

Definition at line 225 of file TransportFactory.cpp.

References TransportFactory::factory(), and TransportFactory::m_modelNames.

LTPspecies * newLTP	(	const XML_Node &	trNode,
		const std::string &	name,
		TransportPropertyType	tp_ind,
		thermo_t *	thermo
	)

virtual

Make one of several transport models, and return a base class pointer to it.

This method operates at the level of a single transport property as a function of temperature and possibly composition. It's a factory for LTPspecies classes.

Parameters

trNode	XML node
name	reference to the name
tp_ind	TransportPropertyType class
thermo	Pointer to the ThermoPhase class

Definition at line 236 of file TransportFactory.cpp.

References Cantera::lowercase(), and TransportFactory::m_LTRmodelMap.

Referenced by TransportFactory::getLiquidSpeciesTransportData(), and TransportFactory::getSolidTransportData().

LiquidTranInteraction * newLTI	(	const XML_Node &	trNode,
		TransportPropertyType	tp_ind,
		LiquidTransportParams &	trParam
	)

virtual

Factory function for the construction of new LiquidTranInteraction objects, which are transport models.

This method operates at the level of a single mixture transport property. Individual species transport properties are addressed by the LTPspecies returned by newLTP.

Parameters

trNode	XML_Node containing the information for the interaction
tp_ind	TransportPropertyType object
trParam	reference to the LiquidTransportParams object

Definition at line 261 of file TransportFactory.cpp.

References LiquidTranInteraction::init(), TransportFactory::m_LTImodelMap, and TransportParams::thermo.

Referenced by TransportFactory::getLiquidInteractionsTransportData().

Transport * newTransport	(	const std::string &	model,
		thermo_t *	thermo,
		int	log_level = `0`,
		int	ndim = `1`
	)

virtual

Build a new transport manager using a transport manager that may not be the same as in the phase description and return a base class pointer to it.

Parameters

model	String name for the transport manager
thermo	ThermoPhase object
log_level	log level
ndim	Number of dimensions for fluxes

Definition at line 314 of file TransportFactory.cpp.

References DustyGasTransport::initialize(), TransportFactory::initLiquidTransport(), TransportFactory::initSolidTransport(), TransportFactory::initTransport(), TransportFactory::m_models, Phase::restoreState(), Phase::saveState(), and Transport::setThermo().

Referenced by Cantera::newDefaultTransportMgr(), TransportFactory::newTransport(), and Cantera::newTransportMgr().

Transport * newTransport	(	thermo_t *	thermo,
		int	log_level = `0`
	)

virtual

Build a new transport manager using the default transport manager in the phase description and return a base class pointer to it.

Parameters

thermo	ThermoPhase object
log_level	log level

Definition at line 388 of file TransportFactory.cpp.

References XML_Node::attrib(), XML_Node::child(), XML_Node::hasChild(), TransportFactory::newTransport(), and Phase::xml().

void initTransport	(	Transport *	tr,
		thermo_t *	thermo,
		int	mode = `0`,
		int	log_level = `0`
	)

virtual

Initialize an existing transport manager.

This routine sets up an existing gas-phase transport manager. It calculates the collision integrals and calls the initGas() function to populate the species-dependent data structure.

Parameters

tr	Pointer to the Transport manager
thermo	Pointer to the ThermoPhase object
mode	Chemkin compatible mode or not. This alters the specification of the collision integrals. defaults to no.
log_level	Defaults to zero, no logging

In DEBUG_MODE, this routine will create the file transport_log.xml and write informative information to it.

Definition at line 614 of file TransportFactory.cpp.

References Transport::initGas(), TransportFactory::m_verbose, TransportFactory::setupMM(), ThermoPhase::speciesData(), TransportFactory::transport_mutex, and TransportParams::xml.

Referenced by TransportFactory::newTransport().

void initLiquidTransport	(	Transport *	tr,
		thermo_t *	thermo,
		int	log_level = `0`
	)

virtual

Initialize an existing transport manager for liquid phase.

This routine sets up an existing liquid-phase transport manager. It is similar to initTransport except that it uses the LiquidTransportParams class and calls setupLiquidTransport().

Parameters

tr	Pointer to the Transport manager
thermo	Pointer to the ThermoPhase object
log_level	Defaults to zero, no logging

In DEBUG_MODE, this routine will create the file transport_log.xml and write informative information to it.

Definition at line 649 of file TransportFactory.cpp.

References Transport::initLiquid(), TransportFactory::m_verbose, TransportFactory::setupLiquidTransport(), and TransportParams::xml.

Referenced by TransportFactory::newTransport().

void initSolidTransport	(	Transport *	tr,
		thermo_t *	thermo,
		int	log_level = `0`
	)

privatevirtual

Initialize an existing transport manager for solid phase.

This routine sets up an existing solid-phase transport manager. It is similar to initTransport except that it uses the SolidTransportData class and calls setupSolidTransport().

Parameters

tr	Pointer to the Transport manager
thermo	Pointer to the ThermoPhase object
log_level	Defaults to zero, no logging

In DEBUG_MODE, this routine will create the file transport_log.xml and write informative information to it.

Definition at line 677 of file TransportFactory.cpp.

References Transport::initSolid(), TransportFactory::m_verbose, TransportFactory::setupSolidTransport(), and TransportParams::xml.

Referenced by TransportFactory::newTransport().

void getTransportData	(	const std::vector< const XML_Node * > &	xspecies,
		XML_Node &	log,
		const std::vector< std::string > &	names,
		GasTransportParams &	tr
	)

private

Read the transport database.

Read transport property data from a file for a list of species. Given the name of a file containing transport property parameters and a list of species names, this method returns an instance of TransportParams containing the transport data for these species read from the file.

Parameters

xspecies	Vector of pointers to species XML_Node databases.
log	reference to an XML_Node that will contain the log (unused)
names	vector of species names that must be filled in with valid transport parameters
tr	Output object containing the transport parameters for the species listed in names (in the order of their listing in names).

Definition at line 779 of file TransportFactory.cpp.

References GasTransportParams::alpha, Cantera::Boltzmann, XML_Node::child(), GasTransportParams::crot, GasTransportParams::dipole, GasTransportParams::eps, ctml::getByTitle(), ctml::getFloat(), GasTransportParams::polar, GasTransportParams::sigma, Cantera::SqrtTen, XML_Node::value(), and GasTransportParams::zrot.

Referenced by TransportFactory::setupMM().

void getLiquidSpeciesTransportData	(	const std::vector< const XML_Node * > &	db,
		XML_Node &	log,
		const std::vector< std::string > &	names,
		LiquidTransportParams &	tr
	)

private

Read transport property data from a file for a list of species that comprise the phase.

Given a vector of pointers to species XML data bases and a list of species names, this method constructs the LiquidTransport Params object containing the transport data for these species.

It is an error to not find a "transport" XML element within each of the species XML elements listed in the names vector.

Parameters

db	Reference to a vector of XML_Node pointers containing the species XML nodes.
log	Reference to an XML log file. (currently unused)
names	Vector of names of species. On output, tr will contain transport data for each of of these names in the order determined by this vector.
tr	Reference to the LiquidTransportParams object that will contain the results.

Definition at line 863 of file TransportFactory.cpp.

Referenced by TransportFactory::setupLiquidTransport().

void getLiquidInteractionsTransportData	(	const XML_Node &	phaseTran_db,
		XML_Node &	log,
		const std::vector< std::string > &	names,
		LiquidTransportParams &	tr
	)

private

Read transport property data from a file for interactions between species.

Given the XML_Node database for transport interactions defined within the current phase and a list of species names within the phase, this method returns an instance of TransportParams containing the transport data for these species read from the file.

This routine reads interaction parameters between species within the phase.

Parameters

phaseTran_db	Reference to the transport XML field for the phase
log	Reference to an XML log file. (currently unused)
names	Vector of names of species. On output, tr will contain transport data for each of of these names in the order determined by this vector.
tr	Reference to the LiquidTransportParams object that will contain the results.

Definition at line 1003 of file TransportFactory.cpp.

Referenced by TransportFactory::setupLiquidTransport().

void getSolidTransportData	(	const XML_Node &	transportNode,
		XML_Node &	log,
		const std::string	phaseName,
		SolidTransportData &	tr
	)

private

Read transport property data from a file for a solid phase.

Given a phase XML data base, this method constructs the SolidTransportData object containing the transport data for the phase.

Parameters

transportNode	Reference to XML_Node containing the phase.
log	Reference to an XML log file. (currently unused)
phaseName	name of the corresponding phase
tr	Reference to the SolidTransportData object that will contain the results.

Definition at line 1116 of file TransportFactory.cpp.

References XML_Node::child(), SolidTransportData::defectActivity, SolidTransportData::defectDiffusivity, SolidTransportData::electConductivity, SolidTransportData::ionConductivity, TransportFactory::m_tranPropMap, XML_Node::name(), XML_Node::nChildren(), TransportFactory::newLTP(), Cantera::showErrors(), SolidTransportData::thermalConductivity, and TransportParams::thermo.

Referenced by TransportFactory::setupSolidTransport().

void fitProperties	(	GasTransportParams &	tr,
		MMCollisionInt &	integrals,
		std::ostream &	logfile
	)

private

Generate polynomial fits to the viscosity, conductivity, and the binary diffusion coefficients.

If CK_mode, then the fits are of the form

\[ \log(\eta(i)) = \sum_{n = 0}^3 a_n(i) (\log T)^n \]

and

\[ \log(D(i,j)) = \sum_{n = 0}^3 a_n(i,j) (\log T)^n \]

Otherwise the fits are of the form

\[ \eta(i)/sqrt(k_BT) = \sum_{n = 0}^4 a_n(i) (\log T)^n \]

and

\[ D(i,j)/sqrt(k_BT)) = \sum_{n = 0}^4 a_n(i,j) (\log T)^n \]

Parameters

tr	Reference to the GasTransportParams object that will contain the results.
logfile	Reference to an ostream that will contain log information when in DEBUG_MODE
integrals	interpolator for the collision integrals

Definition at line 1173 of file TransportFactory.cpp.

Referenced by TransportFactory::setupMM().

void fitCollisionIntegrals	(	std::ostream &	logfile,
		GasTransportParams &	tr,
		MMCollisionInt &	integrals
	)

private

Generate polynomial fits to collision integrals.

Parameters

logfile	Reference to an ostream that will contain log information when in DEBUG_MODE
tr	Reference to the GasTransportParams object that will contain the results.
integrals	interpolator for the collision integrals

Definition at line 711 of file TransportFactory.cpp.

References GasTransportParams::astar_poly, GasTransportParams::bstar_poly, COLL_INT_POLY_DEGREE, GasTransportParams::cstar_poly, DATA_PTR, GasTransportParams::delta, GasTransportParams::fitlist, TransportParams::log_level, TransportFactory::m_verbose, TransportParams::mode_, TransportParams::nsp_, GasTransportParams::omega22_poly, GasTransportParams::poly, and TransportParams::xml.

Referenced by TransportFactory::setupMM().

void setupMM	(	std::ostream &	flog,
		const std::vector< const XML_Node * > &	transport_database,
		thermo_t *	thermo,
		int	mode,
		int	log_level,
		GasTransportParams &	tr
	)

private

Prepare to build a new kinetic-theory-based transport manager for low-density gases.

This class fills up the GastransportParams structure for the current phase

Uses polynomial fits to Monchick & Mason collision integrals. store then in tr

Parameters

flog	Reference to the ostream for writing log info
transport_database	Reference to a vector of pointers containing the transport database for each species
thermo	Pointer to the ThermoPhase object
mode	Mode -> Either it's CK_Mode, chemkin compatibility mode, or it is not We usually run with chemkin compatibility mode turned off.
log_level	log level
tr	GasTransportParams structure to be filled up with information

Definition at line 407 of file TransportFactory.cpp.

Referenced by TransportFactory::initTransport().

void setupLiquidTransport	(	std::ostream &	flog,
		thermo_t *	thermo,
		int	log_level,
		LiquidTransportParams &	trParam
	)

private

Prepare to build a new transport manager for liquids assuming that viscosity transport data is provided in Arrhenius form.

Parameters

flog	Reference to the ostream for writing log info
thermo	Pointer to the ThermoPhase object
log_level	log level
trParam	LiquidTransportParams structure to be filled up with information

Definition at line 531 of file TransportFactory.cpp.

References XML_Node::child(), LiquidTransportParams::diff_Dij, TransportFactory::getLiquidInteractionsTransportData(), TransportFactory::getLiquidSpeciesTransportData(), XML_Node::hasChild(), TransportParams::log_level, LiquidTransportParams::LTData, ThermoPhase::maxTemp(), ThermoPhase::minTemp(), Phase::molecularWeights(), TransportParams::mw, TransportParams::nsp_, Phase::nSpecies(), LiquidTransportParams::radius_Aij, DenseMatrix::resize(), ThermoPhase::speciesData(), Phase::speciesNames(), LiquidTransportParams::thermalCond_Aij, TransportParams::thermo, TransportParams::tmax, TransportParams::tmin, and Phase::xml().

Referenced by TransportFactory::initLiquidTransport().

void setupSolidTransport	(	std::ostream &	flog,
		thermo_t *	thermo,
		int	log_level,
		SolidTransportData &	trParam
	)

private

Prepare to build a new transport manager for solids.

Parameters

flog	Reference to the ostream for writing log info
thermo	Pointer to the ThermoPhase object
log_level	log level
trParam	SolidTransportData structure to be filled up with information

Definition at line 577 of file TransportFactory.cpp.

References XML_Node::child(), TransportFactory::getSolidTransportData(), XML_Node::hasChild(), TransportParams::log_level, ThermoPhase::maxTemp(), ThermoPhase::minTemp(), Phase::molecularWeights(), TransportParams::mw, Phase::name(), TransportParams::nsp_, Phase::nSpecies(), TransportParams::thermo, TransportParams::tmax, TransportParams::tmin, and Phase::xml().

Referenced by TransportFactory::initSolidTransport().

void getBinDiffCorrection	(	doublereal	t,
		const GasTransportParams &	tr,
		MMCollisionInt &	integrals,
		size_t	k,
		size_t	j,
		doublereal	xk,
		doublereal	xj,
		doublereal &	fkj,
		doublereal &	fjk
	)

private

Second-order correction to the binary diffusion coefficients.

Calculate second-order corrections to binary diffusion coefficient pair (dkj, djk). At first order, the binary diffusion coefficients are independent of composition, and d(k,j) = d(j,k). But at second order, there is a weak dependence on composition, with the result that d(k,j) != d(j,k). This method computes the multiplier by which the first-order binary diffusion coefficient should be multiplied to produce the value correct to second order. The expressions here are taken from Marerro and Mason, J. Phys. Chem. Ref. Data, vol. 1, p. 3 (1972).

Parameters

t	Temperature (K)
tr	Transport parameters
integrals	interpolator for the collision integrals
k	index of first species
j	index of second species
xk	Mole fraction of species k
xj	Mole fraction of species j
fkj	multiplier for d(k,j)
fjk	multiplier for d(j,k)

Note: This method is not used currently.

Definition at line 74 of file TransportFactory.cpp.

References Cantera::Boltzmann, GasTransportParams::delta, GasTransportParams::eps, TransportParams::mw, and GasTransportParams::sigma.

Referenced by TransportFactory::fitProperties().

void makePolarCorrections	(	size_t	i,
		size_t	j,
		const GasTransportParams &	tr,
		doublereal &	f_eps,
		doublereal &	f_sigma
	)

private

Corrections for polar-nonpolar binary diffusion coefficients.

Calculate corrections to the well depth parameter and the diameter for use in computing the binary diffusion coefficient of polar-nonpolar pairs. For more information about this correction, see Dixon-Lewis, Proc. Royal Society (1968).

Parameters

i	Species one - this is a bimolecular correction routine
j	species two - this is a bimolecular correction routine
tr	Database of species properties read in from the input xml file.
f_eps	Multiplicative correction factor to be applied to epsilon(i,j)
f_sigma	Multiplicative correction factor to be applied to diam(i,j)