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

Clean up Doxygen docs for TransportParams and descendants

Browse source
This commit is contained in:
Ray Speth 2013-06-03 22:16:46 +00:00
parent a8fea51046
commit 6a1ebcd9d7
6 changed files with 45 additions and 169 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

112
include/cantera/transport/LiquidTransportParams.h
View file

@ -18,64 +18,6 @@
namespace Cantera
{
//! Composition dependence type for liquid mixture transport properties
/*!
* Types of temperature dependencies:
* - 0 - Mixture calculations with this property are not allowed
* - 1 - Use solvent (species 0) properties
* - 2 - Properties weighted linearly by mole fractions
* - 3 - Properties weighted linearly by mass fractions
* - 4 - Properties weighted logarithmically by mole fractions (interaction energy weighting)
* - 5 - Interactions given pairwise between each possible species (i.e. D_ij)
*
* \verbatim
* <transport model="Liquid">
* <viscosity>
* <compositionDependence model="logMoleFractions">
* <interaction>
* <speciesA> LiCl(L) </speciesA>
* <speciesB> KCl(L) </speciesB>
* <Eij units="J/kmol"> -1.0 </Eij>
* <Sij units="J/kmol/K"> 1.0E-1 </Sij>
* -or- <Sij>
* <floatArray units="J/kmol/K"> 1.0E-1, 0.001 0.01 </floatArray>
* </Sij>
* -same form for Hij,Aij,Bij-
* </interaction>
* </compositionDependence>
* </viscosity>
* <speciesDiffusivity>
* <compositionDependence model="pairwiseInteraction">
* <interaction>
* <speciesA> Li+ </speciesA>
* <speciesB> K+ </speciesB>
* <Dij units="m2/s"> 1.5 </Dij>
* </interaction>
* <interaction>
* <speciesA> K+ </speciesA>
* <speciesB> Cl- </speciesB>
* <Dij units="m2/s"> 1.0 </Dij>
* </interaction>
* <interaction>
* <speciesA> Li+ </speciesA>
* <speciesB> Cl- </speciesB>
* <Dij units="m2/s"> 1.2 </Dij>
* </interaction>
* </compositionDependence>
* </speciesDiffusivity>
* <thermalConductivity>
* <compositionDependence model="massFractions"/>
* </thermalConductivity>
* <hydrodynamicRadius>
* <compositionDependence model="none"/>
* </hydrodynamicRadius>
* </transport>
* \endverbatim
*
*/
//! Class LiquidTransportParams holds transport model parameters
//! relevant to transport in mixtures.
@ -84,25 +26,10 @@ namespace Cantera
*/
class LiquidTransportParams : public TransportParams
{
public:
//! Constructor
LiquidTransportParams();
//! Destructor
~LiquidTransportParams();
//! Copy constructor
/*!
* @param right Object to be copied
*/
LiquidTransportParams(const LiquidTransportParams& right);
//! Assignment operator
/*!
* @param right Object to be copied
*/
LiquidTransportParams& operator=(const LiquidTransportParams& right);
//! Species transport parameters
@ -125,27 +52,28 @@ public:
*/
std::vector<LiquidTranInteraction*> mobilityRatio;
//! Vector of pointer to the LiquidTranInteraction object which handles the calculation of
//! each species' self diffusion coefficient for the phase
//! Vector of pointer to the LiquidTranInteraction object which handles
//! the calculation of each species' self diffusion coefficient for the
//! phase
std::vector<LiquidTranInteraction*> selfDiffusion;
//! Pointer to the LiquidTranInteraction object which handles the calculation of the
//! mixture thermal conductivity for the phase
//! Pointer to the LiquidTranInteraction object which handles the
//! calculation of the mixture thermal conductivity for the phase
LiquidTranInteraction* thermalCond;
//! Pointer to the LiquidTranInteraction object which handles the calculation of the
//! species diffusivity for the phase
//! Pointer to the LiquidTranInteraction object which handles the
//! calculation of the species diffusivity for the phase
LiquidTranInteraction* speciesDiffusivity;
//! Pointer to the LiquidTranInteraction object which handles the calculation of the
//! electrical conductivity for the phase
//! Pointer to the LiquidTranInteraction object which handles the
//! calculation of the electrical conductivity for the phase
LiquidTranInteraction* electCond;
//! Pointer to the LiquidTranInteraction object which handles the calculation of the hydrodynamic
//! radius for the phase
//! Pointer to the LiquidTranInteraction object which handles the
//! calculation of the hydrodynamic radius for the phase
/*!
* @note I don't understand at the moment how one can define a hydrodynamic
* radius for the phase
* @note I don't understand at the moment how one can define a
* hydrodynamic radius for the phase
*/
LiquidTranInteraction* hydroRadius;
@ -168,9 +96,8 @@ public:
//! Interaction associated with linear weighting of
//! thermal conductivity.
/**
* This is used for either LTI_MODEL_MASSFRACS
* or LTI_MODEL_MOLEFRACS.
* The overall formula for the mixture viscosity is
* This is used for either LTI_MODEL_MASSFRACS or LTI_MODEL_MOLEFRACS. The
* overall formula for the mixture viscosity is
*
* \f[ \eta_{mix} = \sum_i X_i \eta_i
* + \sum_i \sum_j X_i X_j A_{i,j} \f].
@ -184,9 +111,9 @@ public:
//! Interaction associated with linear weighting of
//! thermal conductivity.
/**
* This is used for either LTI_MODEL_PAIRWISE_INTERACTION or LTI_MODEL_STEFANMAXWELL_PPN.
* These provide species interaction coefficients associated with
* the Stefan-Maxwell formulation.
* This is used for either LTI_MODEL_PAIRWISE_INTERACTION or
* LTI_MODEL_STEFANMAXWELL_PPN. These provide species interaction
* coefficients associated with the Stefan-Maxwell formulation.
*/
DenseMatrix diff_Dij;
@ -201,9 +128,6 @@ public:
DenseMatrix radius_Aij;
};
}
#endif

41
include/cantera/transport/SolidTransportData.h
View file

@ -2,16 +2,10 @@
* @file SolidTransportData.h
* Header file defining class SolidTransportData
*/
/*
* $Author: hkmoffa $
* $Date: 2010-07-13 13:22:30 -0600 (Tue, 13 Jul 2010) $
* $Revision: 507 $
*/
#ifndef CT_SOLIDTRANSPORTDATA_H
#define CT_SOLIDTRANSPORTDATA_H
// STL includes
#include <vector>
#include <string>
@ -32,36 +26,26 @@ namespace Cantera
* A SolidTransportData object is created for a solid phase
* (not for each species as happens for the analogous LiquidTransportData).
*
* This class is mainly used to collect transport properties
* from the parse phase in the TranportFactory and transfer
* them to the Transport class. Transport properties are
* expressed by subclasses of LTPspecies.
* Note that we use the liquid phase species model for the solid phases.
* That is, for the time being at least, we ignore mixing models for
* solid phases and just specify a transport property at the level
* that we specify the transport property for a species in the liquid phase.
* One may need to be careful about deleting pointers to LTPspecies
* objects created in the TransportFactory.
* This class is mainly used to collect transport properties from the parse
* phase in the TranportFactory and transfer them to the Transport class.
* Transport properties are expressed by subclasses of LTPspecies. Note that
* we use the liquid phase species model for the solid phases. That is, for
* the time being at least, we ignore mixing models for solid phases and just
* specify a transport property at the level that we specify the transport
* property for a species in the liquid phase. One may need to be careful
* about deleting pointers to LTPspecies objects created in the
* TransportFactory.
*
* All of the pointers in this class are shallow pointers. Therefore, this
* is a passthrough class, which keeps track of pointer ownership by zeroing
* pointers as we go. Yes, Yes, yes, this is not good.
* All of the pointers in this class are shallow pointers. Therefore, this is
* a passthrough class, which keeps track of pointer ownership by zeroing
* pointers as we go. Yes, Yes, yes, this is not good.
*/
class SolidTransportData : public TransportParams
{
public:
//! Default constructor
SolidTransportData();
//! Copy constructor
SolidTransportData(const SolidTransportData& right);
//! Assignment operator
SolidTransportData& operator=(const SolidTransportData& right);
//! Destructor
~SolidTransportData();
//! A SolidTransportData object is instantiated for each species.
@ -129,4 +113,3 @@ protected:
}
#endif

18
include/cantera/transport/TransportParams.h
View file

@ -18,8 +18,6 @@ namespace Cantera
class XML_Writer;
//====================================================================================================================
//! Error class to indicate an unimplemented method
/*!
* This class is used by transport objects
@ -27,27 +25,21 @@ class XML_Writer;
class NotImplemented : public CanteraError
{
public:
//! Constructor for error class
/*!
* @param method Single string indicating a method that is not implemented
*/
NotImplemented(const std::string& method);
};
//====================================================================================================================
//! Base structure to hold transport model parameters.
/*!
* This structure is used by TransportFactory.
*/
class TransportParams
{
public:
//! Default Constructor
TransportParams();
//! Destructor
virtual ~TransportParams();
//! Local storage of the number of species
@ -84,7 +76,6 @@ public:
int log_level;
};
//====================================================================================================================
//! This structure holds transport model parameters relevant to transport in ideal
//! gases with a kinetic theory of gases derived transport model.
/*!
@ -92,10 +83,7 @@ public:
*/
class GasTransportParams : public TransportParams
{
public:
//! Constructor
GasTransportParams();
// polynomial fits
@ -205,7 +193,6 @@ public:
* The outer loop is over a flat (i,j) index that is parameterized on the tr.delta(i,j) value.
* Unique values of delta get their own spot in the array. The values of delta are stored in
* the fitlist vector.
*
*/
vector_fp fitlist;
@ -272,8 +259,7 @@ public:
*/
DenseMatrix delta;
};
//====================================================================================================================
} // End of namespace Cantera
//======================================================================================================================
#endif //CT_TRANSPORTPARAMS_H

11
src/transport/LiquidTransportParams.cpp
View file

@ -12,8 +12,6 @@ using namespace std;
namespace Cantera
{
//====================================================================================================================
//! Exception thrown if an error is encountered while reading the transport database.
class LTPmodelError : public CanteraError
{
@ -22,7 +20,7 @@ public:
CanteraError("LTPspecies", "error parsing transport data: " + msg + "\n") {
}
};
//====================================================================================================================
LiquidTransportParams::LiquidTransportParams() :
TransportParams(),
LTData(0),
@ -38,9 +36,8 @@ LiquidTransportParams::LiquidTransportParams() :
model_speciesDiffusivity(LTI_MODEL_NOTSET),
model_hydroradius(LTI_MODEL_NOTSET)
{
}
//====================================================================================================================
LiquidTransportParams::~LiquidTransportParams()
{
delete viscosity;
@ -50,7 +47,7 @@ LiquidTransportParams::~LiquidTransportParams()
delete electCond;
delete hydroRadius;
}
//====================================================================================================================
LiquidTransportParams::LiquidTransportParams(const LiquidTransportParams& right) :
TransportParams(),
LTData(0),
@ -65,7 +62,6 @@ LiquidTransportParams::LiquidTransportParams(const LiquidTransportParams& right)
{
operator=(right);
}
//====================================================================================================================
LiquidTransportParams& LiquidTransportParams::operator=(const LiquidTransportParams& right)
{
@ -117,6 +113,5 @@ LiquidTransportParams& LiquidTransportParams::operator=(const LiquidTransportPa
return *this;
}
//====================================================================================================================
} //namespace Cantera

17
src/transport/SolidTransportData.cpp
View file

@ -2,11 +2,6 @@
* @file SolidTransportData.cpp
* Source code for solid transport property evaluations.
*/
/*
* $Author: hkmoffa $
* $Date: 2010-07-13 13:22:30 -0600 (Tue, 13 Jul 2010) $
* $Revision: 507 $
*/
#include "cantera/transport/SolidTransportData.h"
@ -14,8 +9,6 @@ using namespace std;
namespace Cantera
{
//====================================================================================================================
SolidTransportData::SolidTransportData() :
speciesName("-"),
ionConductivity(0),
@ -26,8 +19,7 @@ SolidTransportData::SolidTransportData() :
{
}
//====================================================================================================================
// Copy constructor
SolidTransportData::SolidTransportData(const SolidTransportData& right) :
speciesName("-"),
ionConductivity(0),
@ -38,8 +30,7 @@ SolidTransportData::SolidTransportData(const SolidTransportData& right) :
{
*this = right; //use assignment operator to do other work
}
//====================================================================================================================
// Assignment operator
SolidTransportData& SolidTransportData::operator=(const SolidTransportData& right)
{
if (&right != this) {
@ -64,7 +55,7 @@ SolidTransportData& SolidTransportData::operator=(const SolidTransportData& righ
}
return *this;
}
//====================================================================================================================
SolidTransportData::~SolidTransportData()
{
delete ionConductivity;
@ -73,5 +64,5 @@ SolidTransportData::~SolidTransportData()
delete defectDiffusivity;
delete defectActivity;
}
//====================================================================================================================
}

15
src/transport/TransportParams.cpp
View file

@ -1,5 +1,5 @@
/**
* @file TransportParams.h
* @file TransportParams.cpp
* Class that holds the data that is read in from the xml file, and which is used for
* processing of the transport object
* (see \ref tranprops and \link Cantera::TransportParams TransportParams \endlink).
@ -14,14 +14,14 @@ using namespace std;
namespace Cantera
{
//====================================================================================================================
NotImplemented::NotImplemented(const std::string& method) :
CanteraError("Transport",
"\n\n**** Method " + method + " not implemented. ****\n"
"(Did you forget to specify a transport model?)\n\n")
{
}
//====================================================================================================================
TransportParams::TransportParams() :
nsp_(0),
thermo(0),
@ -34,16 +34,14 @@ TransportParams::TransportParams() :
log_level(-1)
{
}
//====================================================================================================================
// Destructor
TransportParams::~TransportParams()
{
#ifdef DEBUG_MODE
delete xml;
#endif
}
//====================================================================================================================
// Constructor
GasTransportParams::GasTransportParams() :
TransportParams(),
visccoeffs(0),
@ -68,6 +66,5 @@ GasTransportParams::GasTransportParams() :
delta(0, 0)
{
}
//====================================================================================================================
} // End of namespace Cantera
//======================================================================================================================