research/cantera
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Doxygen update

Browse source
This commit is contained in:
Harry Moffat 2010-07-08 17:01:55 +00:00
parent ccb4737040
commit 1dd189fefb
2 changed files with 28 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
Cantera/src/transport/TransportFactory.cpp
View file

@ -865,7 +865,7 @@ namespace Cantera {
for (i = 0; i < nsp; i++) {
const XML_Node& sp = *xspecies[i];
name = sp["name"];
// std::cout << "Processing node for " << name << std::endl;
// std::cout << "Processing node for " << name << std::endl;
// put in a try block so that species with no 'transport'
// child are skipped, instead of throwing an exception.
@ -905,8 +905,7 @@ namespace Cantera {
"negative rotation relaxation number");
datatable[name] = data;
}
catch(CanteraError) {
} catch(CanteraError) {
;
}
}

37
Cantera/src/transport/TransportFactory.h
View file

@ -178,10 +178,10 @@ namespace Cantera {
* It calculates the collision integrals and calls the initGas() function to
* populate the species-dependent data structure.
*
* @param tr Pointer to the Transport manager
* @param thermo Pointer to the ThermoPhase object
* @param mode Chemkin compatible mode or not. This alters the specification of the
* collision integrals. defaults to no.
* @param tr Pointer to the Transport manager
* @param thermo Pointer to the ThermoPhase object
* @param mode Chemkin compatible mode or not. This alters the specification of the
* collision integrals. defaults to no.
* @param log_level Defaults to zero, no logging
*
* In DEBUG_MODE, this routine will create the file transport_log.xml
@ -191,12 +191,20 @@ namespace Cantera {
virtual void initTransport(Transport* tr, thermo_t* thermo, int mode=0, int log_level=0);
//! Initialize an existing transport manager for liquid phase
/*! Similar to initTransport except uses LiquidTransportParams
* class and calls setupLiquidTransport().
/*!
* 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().
*
* @param tr Pointer to the Transport manager
* @param thermo Pointer to the ThermoPhase object
* @param 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.
*/
virtual void initLiquidTransport(Transport* tr,
thermo_t* thermo,
int log_level=0);
virtual void initLiquidTransport(Transport* tr, thermo_t* thermo, int log_level=0);
private:
@ -217,15 +225,22 @@ namespace Cantera {
*/
TransportFactory();
//! Read Transport Database
//! 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.
*
* @param xspecies Vector of pointers to species XML_Node databases.
* @param log reference to an XML_Node that will contain the log (unused)
* @param names vector of species names that must be filled in with valid transport parameters
* @param tr Output object containing the transport parameters
* for the species listed in names (in the order of their listing
* in names).
*/
void getTransportData(const std::vector<const XML_Node*> &db,
void getTransportData(const std::vector<const XML_Node*> &xspecies,
XML_Node& log, const std::vector<std::string>& names,
GasTransportParams& tr);